Jump to

• Request
• Response
• Examples

Get a Client Application

get

/documents/api/1.2/config/clientApplications/{id}

Get metadata for a specific custom actions client application.

You must be an administrator, to perform this operation.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string

  Globally unique identifier (GUID) of the client application.

Query Parameters

• links(optional): string

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

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

Example Response (application/json)

{
    "createdTime":"2023-05-03T11:26:27Z",
    "errorCode":"0",
    "id":"7579B0A49C7A34960929793458C1B355",
    "isEnabled":"true",
    "modifiedTime":"2023-05-03T15:22:14Z",
    "name":"testapp01"
}

404 Response

Application ID is not found

Back to Top

Examples

The following example retrieves the metadata of the specified client application along with the links.

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

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "createdTime": "2023-05-08T12:37:28Z",
  "errorCode": "0",
  "id": "427090D588695B4B4C59D868E83E27B9",
  "isEnabled": "false",
  "links": [
    {
      "rel": "self",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9?links=true"
    },
    {
      "rel": "canonical",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9?links=true"
    }
  ],
  "modifiedTime": "2023-05-11T07:51:57Z",
  "name": "testapp22"
}

Example 2

The following example returns an error because the given client application ID does not exist.

GET .../config/clientApplications/123456D588695A1A1C59D868E83E27B9

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 404

JSON Response

{
  "errorCode": "-16",
  "errorKey": "!csAFAppDoesNotExist,123456D588695A1A1C59D868E83E27B9",
  "errorMessage": "Application '123456D588695A1A1C59D868E83E27B9' does not exist.",
  "title": "Application '123456D588695A1A1C59D868E83E27B9' does not exist.",
  "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Back to Top