# Delete Bulk API Request

Delete Bulk API Request

Endpoint: DELETE /rest/2.0/delete/BULK_API_REQUEST
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Id` (string, required)

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.RequestName` (string)
    Name: Human-friendly name

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.RequestBody` (string)
    Request Body: The original request payload sent to API

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CSVDelimiter` (string)
    CSV Delimiter: The character used as the column-delimiter in a CSV file. Applicable only if CSV is specified in the ResponseFormat field.

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.CSVQualifier` (string)
    CSV Qualifier: The characters placed around each field to signify that it is the same field. Most commonly those are double quotes ('). Applicable only if CSV is specified in the ResponseFormat field.

  - `retrieveResponse.Id` (string)
    Id: Record Id

  - `retrieveResponse.DataSourceId` (integer)
    Data Source

  - `retrieveResponse.Ended` (string)
    End Date/Time: Date and time when the request processing ended. There are two possible outcomes of processing a request: completion or cancellation.

  - `retrieveResponse.RecordsPerBatch` (string)
    Records per batch: Number of returned records in one batch, as defined by the user. For example, prior to running a request that is bound to return about a million records, consider splitting this amount into smaller batches of 50 thousand records each for easier processing.

  - `retrieveResponse.RecordsProcessed` (string)
    Records Processed: Total number of records processed in a job.

  - `retrieveResponse.Started` (string)
    Start Date/Time: Date and time when the request processing started. Since only one request can be processed at a time, processing may not start immediately after creation.

  - `retrieveResponse.ProcessLog` (string)
    Process Log: Request processing log. This is a lengthy text that contains details about how the request was parsed, when its processing started, whether batch execution was successful, etc.

  - `retrieveResponse.CSVEndLineFormat` (string)
    CSV End Line Format: The character used to signify the end of line in a CSV file: CR, LF or CRLF Applicable only if CSV is specified in the ResponseFormat field.

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.RetrieveEntityName` (string)
    Retrieve Entity Name: Entity Name for RETRIEVE Metod

  - `retrieveResponse.ResponseFormat` (string)
    Response Format: Response data format, CSV or JSON.

  - `retrieveResponse.RecordsReturned` (string)
    Records Returned: Total number of records in the request at the time of the start of processing (Started). This is calculated to assess the number of returned records.

  - `retrieveResponse.RequestMethod` (string)
    Request Method: Request method (QUERY|RETRIEVE|MDL EXTRACT)

  - `retrieveResponse.RequestStatus` (string)
    Status

  - `retrieveResponse.RequestBodyEncrypted` (string)
    Request Body(Encrypted): The encrypted request payload sent to API

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error