Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Resolutions

Get List of Resolutions

Use this API to retrieve a list of all request resolutions. The response will include details for each resolution along with the corresponding ID, type, and translations.

get/api/datasubject/v2/resolutions

Query parameters

languagestring

The language code for which to retrieve resolution code translations. For example, 'en-us' for English, 'fr' for French, 'de' for German, etc.

includeSubTaskResolutionsboolean

Set to true to include resolution codes that are applicable to subtasks. If false or omitted, only request-level resolution codes will be returned.

pageinteger

Results page you want to retrieve. Page number starts with 0 (0..N)

sizeinteger

Number of records per page. Maximum page size allowed is 500

sort'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc'

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.

Response

OK

idstring uuid

The unique identifier for the resolution code. This is automatically generated when a new resolution code is created, not required in resolution creation payload.

closeboolean required

Indicates whether this resolution code should be available as an option when closing a request. Set to true to make it available for closing requests.

rejectboolean required

Indicates whether this resolution code should be available as an option when rejecting a request. Set to true to make it available for rejecting requests.

completeboolean required

Indicates whether this resolution code should be available as an option when completing a request. Set to true to make it available for completing requests.

typeinteger

Specifies the type of resolution code, which determines where it appears in the UI. By default, this is set to 10 for request-level resolutions. Use 20 for subtask resolutions.

titleTranslationsobject

A map of language codes to translated titles for this resolution code. English (en-us) translation is required. Each translation must be unique per language and type across all resolution codes.

descriptionTranslationsobject

A map of language codes to translated descriptions for this resolution code. The default English (en-us) translation must be present.

Example response

[
  {
    "id": "682488af-c26f-463e-9941-2f1582c6d4da",
    "close": true,
    "reject": true,
    "titleTranslations": {
      "en-us": "Opt Out",
      "fr": "Se désinscrire",
      "de": "Abmelden"
    },
    "descriptionTranslations": {
      "en-us": "Opt Out the Request",
      "fr": "Se désinscrire de la demande",
      "de": "Anfrage abmelden"
    }
  }
]