Get the status of batch request.

1min

GET
https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/batch/status
API to get the status of batch request of participant type specified by participantTypePluralName.
Path Parameters
participantTypePluralName
ParticipantTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Query Parameters
batchId
UniqueId
*
Responses
200
OK - The request Succeded.
ParticipantBatchResponse
data
ParticipantBatchResponseData
All Of
BatchResponse  +
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/batch/status?batchId=object' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}/batch/status?batchId=object' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// OK - The request Succeded. 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request Succeded. 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

Updated 31 May 2024

Did this page help you?

Perform update operation on participants in batch.

Perform create operation on participants via file upload.