Deactivate Aggregate Instance

DELETE 
/aggregates/orgId/:orgId/definitionId/:defId/instanceId/:instId

Deactivate the specified aggregate instances.

Request

Path Parameters

orgId stringrequired

ID of the organization in which you want to deactivate an instance.

defId stringrequired

ID of the definition for which you want to deactivate an instance.

instId stringrequired

ID of the instance you want to deactivate.

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "status": {
    "code": 0,
    "message": "200 OK"
  },
  "responseCreated": "2023-07-03T13:36:58.078573Z",
  "response": {
    "deleted": true
  }
}

Example

{
  "status": {
    "code": 0,
    "message": "200 OK"
  },
  "responseCreated": "2023-07-03T13:36:58.078573Z",
  "response": {
    "deleted": true
  }
}

400

Invalid request for example: Invalid parameters, missing parameters.

401

Unauthorized. This error will occur if calling user does not have access right for the API.

404

Unauthorized. This error will occur if calling user does not have access right for the API.

500

A server error occurred. Check the logs for more details.

Loading...