RWrws
Standard

Descriptor

Changed on

This endpoint provides the descriptor for the app.

get/descriptor

Request

  • Base URL
    https://example.com
  • URL
    https://example.com/descriptor
  • Auth
    none declared

Headers

TR_IDstring

A trace id, to help track problems. If it's not received, an auto-generated value will be used for logging. A TR_ID header should also be set on the response.

Response

namestring required

A user friendly name, that will be used in the RWS AppStore. It must be unique - registration will fail if there is another app with the same name.

descriptionstring required

The description of the app that will be presented in the AppStore.

versionstring required

3 numbers separated by a dot, representing the semantic version.

scopesstring[]

The list of required scopes. It can be any of the following:

  • TENANT - Read/write/delete all tenant data (resources).
  • TENANT_READ - Read-only access to all tenant data (resources).
  • ACCESS_SECURE_PROJECT_CONTENT - Access to secure project content.
entitlementsstring[]

The list of required entitlements. If the account doesn't have the entitlements, the app installation won't be allowed. This is reserved for RWS apps.

baseUrlstring

The prefix for all calls to the app service.

releaseNotesstring required

Describes the changes in the new version. Might be used by an administrator to help decide on possible actions.

minimumVersionstring

Minimum version of the app that is supported. Older versions might be forcibly disabled if not upgraded.

descriptorVersion'1.4' required

The version of the descriptor. The expected capabilities are based on that version. Use only the value provided in the validation. Do not update the descriptorVersion if not all new features from the current app descriptor are implemented. With the introduction of Apps, descriptorVersion should be 1.4.

Example response

{
  "version": "2.1.4",
  "extensions": [
    {
      "extensionPointId": "lc.verificationprovider",
      "id": "string",
      "name": "string",
      "description": "string",
      "extensionPointVersion": "1.0",
      "configuration": {
        "endpoints": {
          "lc.verification.startverification": "string",
          "lc.verification.verifysegment": "string",
          "lc.verification.getmessagesbyculture": "string",
          "lc.verification.getsettingsschema": "string"
        },
        "validationInputType": "string"
      }
    }
  ],
  "webhooks": [
    {
      "url": "/webhook-receiving-endpoint"
    }
  ],
  "baseUrl": "https://somehostname.net/service/v1"
}

Changes

  • v13c62013a4c7cRevision changes
    • info

      the response property became required for the status

  • v1ce288dbb23beRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      removed from the / response property oneOf list for the response status