DC 5.3.0 6.6.1 - GetLabels

GetLabels is used for fetching the labels and translations that can be used.

URL : /GetLabels.js

Method : POST

Auth required : Yes

Required parameters

Name	Example	Description
method	GetLabels	Fixed parameter that identifies the endpoint method.
languageId	3	The ID of the language to which to retrieve the labels.
versionId	!/5/	Product configuration version.
accessKey	2d8319f4-7a57-4ca0-a027-c44c2f259aac	AccessKey for API

Optional parameters

N/A

cUrl data example

--data "method=GetLabels&languageId=3&versionId=!/5/&accessKey=9c5e477c-bded-4c74-8d56-3725114669d5"

Success Response

Code : 200 OK

Content example

{
    "success": true,
    "total": 1855,
    "error": "",
    "items": [
        {
            "languageLabelId": 0,
            "languageId": 3,
            "labelConstant": "ACCESS_KEY_EXPIRED_ERROR_BODY",
            "label": "Your session has expired. Please either sign in again or refresh the page.",
            "folderId": 50028,
            "versionId": "/5/",
            "changesetId": 440,
            "deleted": false,
            "languageLabelVersionId": 894
		},
        {
            "languageLabelId": 0,
            "languageId": 3,
            "labelConstant": "ACCESS_KEY_EXPIRED_ERROR_RELOAD",
            "label": "Refresh the page",
            "folderId": 50028,
            "versionId": "/5/",
            "changesetId": 440,
            "deleted": false,
            "languageLabelVersionId": 89451
        },
		/* ... remaining labels ... */
	]
}

Error Response

Code : 200 OK

Content example

{
	"success": false,
	"total": 0,
	"error": "A critical exception occurred while we executed the search.\r\n",
	"items": null,
	"warnings": [{
		"Severity": 150,
		"Code": 420,
		"Description": "A critical exception occurred while we executed the search."
	}]
}