DC 5.6 GetLayoutFolders

DC 5.6 GetLayoutFolders

This search is used for getting the layout folders (channels).

URL : /SearchService.js

Method : POST

Auth required : Yes

Required parameters

Name

Example

Description

SearchName

DigiZuite_System_Framework_LayoutFolders

Fixed parameter that identifies the endpoint method.

accessKey

2d8319f4-7a57-4ca0-a027-c44c2f259aac

accessKey for api

Optional parameters

Name

Example

Description

Name

Example

Description

folderId

133

id of the layout folder

cUrl data example

--data "SearchName=DigiZuite_System_Framework_LayoutFolders&accesskey=eb774621-1c2f-467b-b006-a8efa67094a7&folderId=133"

Success Response

Code : 200 OK

Content example

{ "success": true, "error": "", "total": "3", "items": [{ "itemId": "9194", "totalCases": "3", "layoutFolderId": "134", "name": "Content", "Children": "1", "prevRef": "133" }, { "itemId": "9193", "totalCases": "3", "layoutFolderId": "133", "name": "DAM for Sitecore", "Children": "1", "prevRef": "0" }, { "itemId": "10270", "totalCases": "3", "layoutFolderId": "135", "name": "Special transcode", "Children": "0", "prevRef": "134" }] }

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." }] }