Delete a Record

The various details of how to delete a record is explained in this section.

HTTP Method

Note: You cannot delete a record with EffectiveDate attribute and when the record state is Unconfirmed.

DELETE

Endpoint URL

See Endpoint.

Resource

/records/{repositoryName}/{id}

Request Parameters

Specify the following parameters:

Name Description Type Data Type
repositoryName Specify the repository name.

This field is Mandatory.

path string
id Specify the record ID.

This field is Mandatory.

path string
idExt Specify the record ID extension. query string
deleteRelRecords Specify whether you want to delete all related records. query boolean
workItemId Specify the work item ID. query string

Request Model

Media Type: application/json.

Response Model

The server sends response 200 OK with HTTP status code for each successfully completed request. The success response format is as follows: 

{
  "responseMessages": [
    {
      "code": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "success": true
}

If response is unsuccessful, either of the following error code is displayed:

  • 400 Bad Request
  • 404 Not Found
  • 500 Internal Server Error

For error code response, see Error Handling .