Perform update operation on Entities in batch.

1min
PUT
https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/batch
API to update Entities core attributes in batch via JSON payload for a entity type specified by EntityTypePluralName.
Path Parameters
entityTypePluralName
EntityTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-APPID
string
*
X-COREOS-ORIGIN-TOKEN
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
EntityBatchUpdateRequest
*
Description
update batch request for entity type.
All Of
EntityBatchUpdate  +
payload
EntityBatchUpdateData[]
*
callback
CallbackForInstance
Responses
202
OK
BatchSuccessResponse
data
object
*
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 --request PUT 'https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": [
    {
      "entityInstanceId": "",
      "properties": {}
    }
  ]
}'
curl --location --globoff --request PUT 'https://{tenantSubdomain}.io/core/api/v2/entity/{entityTypePluralName}/batch' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "payload": [
    {
      "entityInstanceId": "",
      "properties": {}
    }
  ]
}'
Responses
202
400
401
404
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 16 Oct 2024
Did this page help you?
Perform create operation on Entities in batch.
Get the status of batch request.