Jump to

• Request
• Response

deleteComponentInstance

delete

/ccadmin/v1/componentInstances/{id}

Remove Component Instance by ID.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID for Component Instance.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The Component Instance is successfully deleted by ID.

404 Response

The error response returned when ID value is not recognised.

Body ()

Root Schema : deleteComponentInstance_doesNotExistResponse

Type: object

Show Source

• errorCode(optional): string
  Default Value: 33001

  The internal error code
• message(optional): string
  Default Value: Specified widget 'exampleId' does not exist.

  The HTTP error message
• status(optional): string
  Default Value: 404

  The HTTP status code

{
    "properties":{
        "errorCode":{
            "default":"33001",
            "description":"The internal error code",
            "type":"string"
        },
        "message":{
            "default":"Specified widget 'exampleId' does not exist.",
            "description":"The HTTP error message",
            "type":"string"
        },
        "status":{
            "default":"404",
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top