REST API for Documents

Get All Client Applications

get

/documents/api/1.2/config/clientApplications

Get metadata of all the available custom actions client applications.

You must be an administrator to perform this operation.

Request

Supported Media Types

application/json
application/xml

Query Parameters

links(optional): string

Indicate if links for the client applications should be returned in the response. The value links=true will return all available links for each client application. Any other value or not sending links will not return links.

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Root Schema : GetClientApplicationsResponse

Type: object

Metadata of the existing client applications

Show Source

count(optional): string

The number of client applications returned.
errorCode(optional): string

An error code of zero (0) indicates no errors.
hasMore(optional): string

Indicates if all the client applications were returned. This is zero (0), if all the client applications were returned. Otherwise, it will be one (1), indicating that there are more records available.
items(optional): array items

List of client applications.
limit(optional): string

Maximum number of client applications which could be returned.
links(optional): array links

Links for the client applications.
offset(optional): string

The point at which to begin the list of items or page of results from the complete set.
totalResults(optional): string

Total number of aggregated client applications returned.

{
    "description":"Metadata of the existing client applications",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of client applications returned."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "hasMore":{
            "type":"string",
            "description":"Indicates if all the client applications were returned. This is zero (0), if all the client applications were returned. Otherwise, it will be one (1), indicating that there are more records available."
        },
        "items":{
            "type":"array",
            "description":"List of client applications.",
            "items":{
                "$ref":"#/definitions/ClientApplicationResponse"
            }
        },
        "limit":{
            "type":"string",
            "description":"Maximum number of client applications which could be returned."
        },
        "links":{
            "type":"array",
            "description":"Links for the client applications.",
            "items":{
                "$ref":"#/definitions/ClientApplicationsLinkDetails"
            }
        },
        "offset":{
            "type":"string",
            "description":"The point at which to begin the list of items or page of results from the complete set."
        },
        "totalResults":{
            "type":"string",
            "description":"Total number of aggregated client applications returned."
        }
    }
}

Nested Schema : items

Type: array

List of client applications.

Show Source

Array of: object ClientApplicationResponse

Metadata about a specific client application

{
    "type":"array",
    "description":"List of client applications.",
    "items":{
        "$ref":"#/definitions/ClientApplicationResponse"
    }
}

Nested Schema : links

Type: array

Links for the client applications.

Show Source

Array of: object ClientApplicationsLinkDetails

Links for the client applications.

{
    "type":"array",
    "description":"Links for the client applications.",
    "items":{
        "$ref":"#/definitions/ClientApplicationsLinkDetails"
    }
}

Nested Schema : ClientApplicationResponse

Type: object

Metadata about a specific client application

Show Source

createdTime(optional): string

Date the client application was created.
errorCode(optional): string

An error code of zero (0) indicates no errors.
id(optional): string

Globally unique identifier (GUID) of the client application.
isEnabled(optional): string

Flag to indicate if the client application is enabled/disabled.
links(optional): array links

Links for the client application.
modifiedTime(optional): string

Date the client application was last modified.
name(optional): string

Client application name.

{
    "description":"Metadata about a specific client application",
    "properties":{
        "createdTime":{
            "type":"string",
            "description":"Date the client application was created."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the client application."
        },
        "isEnabled":{
            "type":"string",
            "description":"Flag to indicate if the client application is enabled/disabled."
        },
        "name":{
            "type":"string",
            "description":"Client application name."
        },
        "modifiedTime":{
            "type":"string",
            "description":"Date the client application was last modified."
        },
        "links":{
            "type":"array",
            "description":"Links for the client application.",
            "items":{
                "$ref":"#/definitions/ClientApplicationLinkDetails"
            }
        }
    }
}

Nested Schema : links

Type: array

Links for the client application.

Show Source

Array of: object ClientApplicationLinkDetails

Links for the client application.

{
    "type":"array",
    "description":"Links for the client application.",
    "items":{
        "$ref":"#/definitions/ClientApplicationLinkDetails"
    }
}

Nested Schema : ClientApplicationLinkDetails

Type: object

Links for the client application.

Show Source

href(optional): string

The URL corresponding to the link type.
rel(optional): string

The type of link, this will be self and canonical

{
    "description":"Links for the client application.",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The type of link, this will be <code>self</code> and <code>canonical</code>"
        },
        "href":{
            "type":"string",
            "description":"The URL corresponding to the link type."
        }
    }
}

Nested Schema : ClientApplicationsLinkDetails

Type: object

Links for the client applications.

Show Source

href(optional): string

The URL corresponding to the link type.
rel(optional): string

The type of link, this will be self and canonical

{
    "description":"Links for the client applications.",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The type of link, this will be <code>self</code> and <code>canonical</code>"
        },
        "href":{
            "type":"string",
            "description":"The URL corresponding to the link type."
        }
    }
}

Example Response (application/json)

{
    "count":"3",
    "errorCode":"0",
    "hasMore":"0",
    "items":[
        {
            "id":"FB07627B44FA7618F0B7260B09C370AD",
            "name":"testapp1",
            "isEnabled":"true",
            "createdTime":"2023-05-04T09:39:18Z",
            "modifiedTime":"2023-05-04T09:39:18Z"
        },
        {
            "id":"066EEB53393BAA5560ED3F0C99CF4A15",
            "name":"testapp2",
            "isEnabled":"false",
            "createdTime":"2023-05-04T09:39:31Z",
            "modifiedTime":"2023-05-04T09:39:31Z"
        },
        {
            "id":"28DEF2D4E07C5D45268EFD3A4175A36C",
            "name":"testapp3",
            "isEnabled":"true",
            "createdTime":"2023-05-04T09:39:45Z",
            "modifiedTime":"2023-05-04T09:39:45Z"
        }
    ],
    "limit":"100",
    "offset":"0",
    "totalResults":"3"
}

Examples

The following example retrieves the metadata of all the existing client applications along with the links.

GET .../config/clientApplications?links=true

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "count": "8",
  "errorCode": "0",
  "hasMore": "0",
  "items": [
    {
      "id": "AB3BCBA038DDE4940F0F33F9AE5FE4F0",
      "name": "testapp",
      "isEnabled": "false",
      "createdTime": "2023-05-09T09:32:19Z",
      "modifiedTime": "2023-05-11T07:37:21Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/AB3BCBA038DDE4940F0F33F9AE5FE4F0"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/AB3BCBA038DDE4940F0F33F9AE5FE4F0"
        }
      ]
    },
    {
      "id": "066EEB53393BAA5560ED3F0C99CF4A15",
      "name": "testapp2",
      "isEnabled": "true",
      "createdTime": "2023-05-04T09:39:31Z",
      "modifiedTime": "2023-05-08T09:26:58Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/066EEB53393BAA5560ED3F0C99CF4A15"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/066EEB53393BAA5560ED3F0C99CF4A15"
        }
      ]
    },
    {
      "id": "A9761E8C04F56AE1476602B90A47763E",
      "name": "testapp20",
      "isEnabled": "false",
      "createdTime": "2023-05-05T13:47:28Z",
      "modifiedTime": "2023-05-05T13:47:28Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/A9761E8C04F56AE1476602B90A47763E"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/A9761E8C04F56AE1476602B90A47763E"
        }
      ]
    },
    {
      "id": "427090D588695B4B4C59D868E83E27B9",
      "name": "testapp22",
      "isEnabled": "false",
      "createdTime": "2023-05-08T12:37:28Z",
      "modifiedTime": "2023-05-11T07:51:57Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9"
        }
      ]
    },
    {
      "id": "BD6BF959C9D1701E96BA2A4F9B7A31CA",
      "name": "testapp23",
      "isEnabled": "true",
      "createdTime": "2023-05-09T08:22:11Z",
      "modifiedTime": "2023-05-09T08:22:37Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/BD6BF959C9D1701E96BA2A4F9B7A31CA"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/BD6BF959C9D1701E96BA2A4F9B7A31CA"
        }
      ]
    },
    {
      "id": "28DEF2D4E07C5D45268EFD3A4175A36C",
      "name": "testapp3",
      "isEnabled": "true",
      "createdTime": "2023-05-04T09:39:45Z",
      "modifiedTime": "2023-05-04T09:39:45Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/28DEF2D4E07C5D45268EFD3A4175A36C"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/28DEF2D4E07C5D45268EFD3A4175A36C"
        }
      ]
    },
    {
      "id": "869AD367D6DE688234DB09985DEDC7BC",
      "name": "testapp33",
      "isEnabled": "true",
      "createdTime": "2023-05-09T12:18:11Z",
      "modifiedTime": "2023-05-09T12:18:54Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/869AD367D6DE688234DB09985DEDC7BC"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/869AD367D6DE688234DB09985DEDC7BC"
        }
      ]
    },
    {
      "id": "563AEEE7A14D14A12717D4B009B1C98C",
      "name": "testapp34",
      "isEnabled": "false",
      "createdTime": "2023-05-09T12:25:27Z",
      "modifiedTime": "2023-05-09T12:25:27Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/563AEEE7A14D14A12717D4B009B1C98C"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/563AEEE7A14D14A12717D4B009B1C98C"
        }
      ]
    }
  ],
  "limit": "100",
  "links": [
    {
      "rel": "self",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications?links=true"
    },
    {
      "rel": "canonical",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications?links=true"
    }
  ],
  "offset": "0",
  "totalResults": "8"
}