Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Retrieve Folder Content

Type: object

Title: Retrieve Folder Content

Show Source

• riObjects(optional): array riObjects
  Array of Objects in the given folder

{
    "title":"Retrieve Folder Content",
    "type":"object",
    "properties":{
        "riObjects":{
            "description":"Array of Objects in the given folder",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"ID of the Object."
                    },
                    "name":{
                        "type":"string",
                        "description":"Name of the Object."
                    },
                    "type":{
                        "type":"string",
                        "description":"Type of the Object."
                    },
                    "subType":{
                        "type":"string",
                        "description":"SubType of the Object."
                    },
                    "folderId":{
                        "type":"string",
                        "description":"Id of the Folder containing the object."
                    }
                }
            }
        }
    }
}

Nested Schema : riObjects

Type: array

Array of Objects in the given folder

Show Source

• Array of: object items

{
    "description":"Array of Objects in the given folder",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"ID of the Object."
            },
            "name":{
                "type":"string",
                "description":"Name of the Object."
            },
            "type":{
                "type":"string",
                "description":"Type of the Object."
            },
            "subType":{
                "type":"string",
                "description":"SubType of the Object."
            },
            "folderId":{
                "type":"string",
                "description":"Id of the Folder containing the object."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the Object."
        },
        "name":{
            "type":"string",
            "description":"Name of the Object."
        },
        "type":{
            "type":"string",
            "description":"Type of the Object."
        },
        "subType":{
            "type":"string",
            "description":"SubType of the Object."
        },
        "folderId":{
            "type":"string",
            "description":"Id of the Folder containing the object."
        }
    }
}

Back to Top

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": []
}
	

Back to Top