Jump to

• Request
• Response
• Examples

Delete a Client Application

delete

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

Delete the specified 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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : DeleteClientApplicationResponse

Type: object

Delete a client application

Show Source

• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• id(optional): string
  Globally unique identifier (GUID) of the client application.
• type(optional): string
  Item type clientApplication.

{
    "description":"Delete a client application",
    "properties":{
        "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."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>clientApplication</code>."
        }
    }
}

Example Response (application/json)

{
    "errorCode":"0",
    "id":"FB07627B44FA7618F0B7260B09C370AD",
    "type":"clientApplication"
}

404 Response

Application ID is not found

Back to Top

Examples

The following example deletes the specified client application.

DELETE .../config/clientApplications/FB07627B44FA7618F0B7260B09C370AD

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "id": "FB07627B44FA7618F0B7260B09C370AD",
  "type": "clientApplication"
}

Example 2

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

DELETE .../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.",
  "errorType": "clientApplication",
  "id": "123456D588695A1A1C59D868E83E27B9",
  "title": "Application '123456D588695A1A1C59D868E83E27B9' does not exist.",
  "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Back to Top