Get the status of batch request.

1min

GET
https://{tenantSubdomain}.io/core/api/v2/entity/apps/{appId}/{entityTypePluralName}/batch/status
API to get the status of batch request of entity type specified by EntityTypePluralName.
Header/Path/Query ParameterDescriptionTypeRequired
X-COREOS-REQUEST-ID(header)Unique request IDstringRequired
X-COREOS-TID(header)Tenant IDstringRequired
X-COREOS-AUTH(header)Core-os authentication tokenstringOptional
X-COREOS-ACCESS(header)Core-os access tokenstringOptional
EntityTypePluralName
(path)Plural name of the entity type. Example: vehicle.stringRequired
batchId
(query)Unique id of batch requeststringRequired
Path Parameters
entityTypePluralName
EntityTypePluralName
*
appId
string
*
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
Entity Change Log
EntityBatchResponse
data
EntityBatchResponseData
*
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}.io/core/api/v2/entity/apps/{appId}/{entityTypePluralName}/batch/status?batchId=object' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/entity/apps/{appId}/{entityTypePluralName}/batch/status?batchId=object' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// Entity Change Log 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Entity Change Log 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

Header/Path/Query Parameter	Description	Type	Required
`X-COREOS-REQUEST-ID`(header)	Unique request ID	string	Required
`X-COREOS-TID`(header)	Tenant ID	string	Required
`X-COREOS-AUTH`(header)	Core-os authentication token	string	Optional
`X-COREOS-ACCESS`(header)	Core-os access token	string	Optional
`EntityTypePluralName` (path)	Plural name of the entity type. Example: vehicle.	string	Required
`batchId` (query)	Unique id of batch request	string	Required

Updated 25 Jun 2024

Did this page help you?

Perform update operation on Entities in batch.

Get the status of batch request.