Retrieve Folder Content
get
/rest/api/v1.3/folders/{folderName}/content
Retrieves the content in a specified folder.
Request
Path Parameters
-
folderName: string
Folder Name
Query Parameters
-
limit: integer
Number of objects to return in the response (defaults to 200 and cannot exceed 200)
-
offset: integer
Starts at 0 and indicates the record number for the response result set
Response
Supported Media Types
- application/json
Default Response
Root Schema : Retrieve Folder Content
Type:
object
Title:
Show Source
Retrieve Folder Content
-
riObjects(optional):
array riObjects
Array of Objects in the given folder
Nested Schema : items
Type:
Show Source
object
-
folderId(optional):
string
Id of the Folder containing the object.
-
id(optional):
string
ID of the Object.
-
name(optional):
string
Name of the Object.
-
subType(optional):
string
SubType of the Object.
-
type(optional):
string
Type of the Object.
Examples
Retrieve objects in a folder
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Sample Request URL:
/rest/api/v1.3/folders/folder_name/content
Sample Response: Success
{ "riObjects": [ { "id": 15630627, "name": "Filter_test_prg", "objectType": "PROGRAM", "subType": "GENERIC", "folderId": 15429179 }, { "id": 15429180, "name": "Not working Copy of AUT_KM_SMS_2AE", "objectType": "DISPATCHABLE", "subType": "SmsCampaign", "folderId": 15429179 }, { "id": 15630580, "name": "Test_Click", "objectType": "USER_FILTER", "subType": "GENERIC", "folderId": 15429179 }, { "id": 15630626, "name": "Test_Filter_type", "objectType": "USER_FILTER", "subType": "GENERIC", "folderId": 15429179 }, { "id": 15429181, "name": "Working Copy of AUT_KM_SMS_2AE", "objectType": "DISPATCHABLE", "subType": "SmsCampaign", "folderId": 15429179 } ], "links": [ { "rel": "self", "href": "/rest/api/v1.3/folders/folder_name/content", "method": "GET" } ] }
Example Response:Failure
{ "type": "", "title": "Folder not found", "errorCode": "FOLDER_NOT_FOUND", "detail": "Folder [ folder_name ] not found.", "errorDetails": [] }