Jump to

• Request
• Response

Gets the status of a bulk processing request

post

/config/sim/v1/bulkStatusRequest

Get the status for the bulk processing request ID provided

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

Root Schema : schema

Type: object

Show Source

• requestId(required): integer
  Bulk processing request ID

  Example: 1012

{
    "type":"object",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"integer",
            "description":"Bulk processing request ID",
            "example":1012
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response body containing the status of the bulk request

Body ()

Root Schema : BulkProcessingStatusResponse

Type: object

A response body containing the status of the bulk request

Show Source

• comments: string
  The comments provided by the user while placing the bulk insert request.

  Example: Bulk Insert
• failedRecordCount: integer
  The count of failed records.

  Example: 5000
• message: string
  A message giving details about the bulk request.

  Example: Time taken to process the bulk request : 1012 is 2 seconds
• requestId: integer
  The bulk processing request ID

  Example: 1012
• response: array response
  The result for each object submitted in the bulk request
• status: string
  Bulk processing request ID status. Status can be one of the following :- Queued - To be processed, InProgress - Being processed, Completed - Processed successfully, CompletedWithErrors - Processing completed with some errors

  Example: Completed
• successRecordCount: integer
  The count of successful records.

  Example: 5000

{
    "type":"object",
    "description":"A response body containing the status of the bulk request",
    "properties":{
        "requestId":{
            "type":"integer",
            "example":1012,
            "description":"The bulk processing request ID"
        },
        "successRecordCount":{
            "type":"integer",
            "example":5000,
            "description":"The count of successful records."
        },
        "failedRecordCount":{
            "type":"integer",
            "example":5000,
            "description":"The count of failed records."
        },
        "message":{
            "type":"string",
            "example":"Time taken to process the bulk request : 1012 is 2 seconds",
            "description":"A message giving details about the bulk request."
        },
        "status":{
            "type":"string",
            "example":"Completed",
            "description":"Bulk processing request ID status. Status can be one of the following :- Queued - To be processed, InProgress - Being processed, Completed - Processed successfully, CompletedWithErrors - Processing completed with some errors"
        },
        "comments":{
            "type":"string",
            "example":"Bulk Insert",
            "description":"The comments provided by the user while placing the bulk insert request."
        },
        "response":{
            "type":"array",
            "description":"The result for each object submitted in the bulk request",
            "items":{
                "$ref":"#/definitions/BulkRecordsResponse"
            }
        }
    }
}

Nested Schema : response

Type: array

The result for each object submitted in the bulk request

Show Source

• Array of: object BulkRecordsResponse
  A response body containing details for an object submitted in the bulk request.

{
    "type":"array",
    "description":"The result for each object submitted in the bulk request",
    "items":{
        "$ref":"#/definitions/BulkRecordsResponse"
    }
}

Nested Schema : BulkRecordsResponse

Type: object

A response body containing details for an object submitted in the bulk request.

Show Source

• hierUnitId: integer
  Hierarchy reference where the object has been added.

  Example: 88
• objectNum: integer
  The object number

  Example: 100
• recordStatus: string
  Status of the object submitted in the bulk request

  Example: Success

{
    "type":"object",
    "description":"A response body containing details for an object submitted in the bulk request.",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":88,
            "description":"Hierarchy reference where the object has been added."
        },
        "objectNum":{
            "type":"integer",
            "example":100,
            "description":"The object number"
        },
        "recordStatus":{
            "type":"string",
            "example":"Success",
            "description":"Status of the object submitted in the bulk request"
        }
    }
}

Back to Top