Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GetVisibleSearchFields GetLabels is used for fetching information about the filters labels and translations that can be used for different searches. This is a search on the Digizuite product.

URL : /SearchServiceGetLabels.js

Method : POST

Auth required : Yes

...

NameExampleDescription
methodGetVisibleSearchFieldsGetLabelsFixed parameter that identifies the endpoint method.
SearchNameDigiZuite_System_Framework_SearchThe search name for which filters should be returnedlanguageId3The ID of the language to which to retrieve the labels.
versionId!/5/Product configuration version.
accessKey2d8319f4-7a57-4ca0-a027-c44c2f259aacAccessKey for API

...

Info
iconfalse

--data "method=GetVisibleSearchFields&searchName=DigiZuite_System_Framework_SearchGetLabels&languageId=3&versionId=!/5/&accessKey=d8eb5e9a9c5e477c-cf83bded-4cf04c74-a1f98d56-16d7a8e51cfb3725114669d5"

Success Response

Code : 200 OK

Content example

Code Block
languagejs
{
	"searchFields":[
		{
			"itemId":0,
			"metafieldItemId":0,
			"dataTypeId":0,
			"parameterName":"sAssetType",
			"renderType":"assettype",
			"valueHandler":"InList",
			"hardcodedValues":[]
		},
		{
			"itemId":12996,
			"metafieldItemId":12994,
			"dataTypeId":61,
			"parameterName":"sBitInput",
			"renderType":"bool",
			"valueHandler":"Equals",
			"hardcodedValues":[]
		},
		{
			"itemId":13000,
			"metafieldItemId":12998,
			"dataTypeId":68,
			"parameterName":"sComboValueInput",
			"renderType":"combo",
			"valueHandler":"Equals",
			"hardcodedValues":[]
		},
		{
			"itemId":0,
			"metafieldItemId":0,
			"dataTypeId":0,
			"parameterName":"sDateBetween",
			"renderType":"datebetween",
			"valueHandler":"Between",
			"hardcodedValues":[]
		},
		{
			"itemId":9310,
			"metafieldItemId":9309,
			"dataTypeId":61,
			"parameterName":"sIsPublic",
			"renderType":"bool",
			"valueHandler":"Equals",
			"hardcodedValues":[]
		},
		{
			"itemId":2481,
			"metafieldItemId":2380,
			"dataTypeId":169,
			"parameterName":"sKeywords",
			"renderType":"multicombo",
			"valueHandler":"AllInList",
			"hardcodedValues":[]
		},
		{
			"itemId":5722,
			"metafieldItemId":5719,
			"dataTypeId":300,
			"parameterName":"sMenu",
			"renderType":"tree",
			"valueHandler":"InList",
			"hardcodedValues":[]
		},
		{
			"itemId":13040,
			"metafieldItemId":13038,
			"dataTypeId":60,
			"parameterName":"sStringInput",
			"renderType":"string",
			"valueHandler":"Equals",
			"hardcodedValues":[]
		},
		{
			"itemId":22406,
			"metafieldItemId":22402,
			"dataTypeId":68,
			"parameterName":"sWorkflowStatus",
			"renderType":"multicombo",
			"valueHandler":"InList",
			"hardcodedValues":[]
		}
	],
	"success":true,
	"errors":[
    "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

...