processExtension

post

/ccadmin/v1/extensions/{id}

Process Extension. Activate/deactivate a previously uploaded Extension.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

id

Type: string

Required: true

The id of the Extension to process.

Body Parameter

Root Schema : processExtension_request

Example

POST /ccadmin/v1/extensions/021be6f7-9b84-43ed-9d16-59358443d29f

Properties

op

Type: string

Required: true

The operation to perform, can be one of activate or deactivate.

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : processExtension_response

Properties

success

Type: boolean

true if the Extension was successfully processed.

Example application/json

{
    "success":true
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage

Type: string

An optional non-localized message containing technical information for developers

errorCode

Type: string

The numerical code identifying the error

errors

Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered

message

Type: string

The localized message describing the error

moreInfo

Type: string

An optional non-localized message with more information

o:errorPath

Type: string

An optional machine readable description of where the error occurred

status

Type: string

The HTTP status code

type

Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

• Type: object items
  Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage

Type: string

An optional non-localized message containing technical information for developers

errorCode

Type: string

The numerical code identifying the error

message

Type: string

The localized message describing the error

moreInfo

Type: string

An optional non-localized message with more information

o:errorPath

Type: string

An optional machine readable description of where the error occurred

status

Type: string

The HTTP status code

Examples

Sample Request:

POST /ccadmin/v1/extensions/021be6f7-9b84-43ed-9d16-59358443d29f

Sample Response Payload returned by endpoint:

{"success": true}