Get the status of batch file request

1min

GET
API to get the status of batch file request.
HEADER/PATH/QUERYDESCRIPTIONTYPE
X-COREOS-REQUEST-ID*(header)Unique Request ID.string
X-COREOS-TID*(header)Tenant ID.string
X-COREOS-ACCESS*(header)core-os access token.string
containerType*(path)Type of container.string
batchId*(query)Unique ID of batch request.string
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
503 - Server ErrorsSomething went wrong on our end. (These are rare.)
Path Parameters
containerType
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Query Parameters
batchId
BatchId
*
Responses
200
OK
ContainerBatchResponse
data
ContainerBatchResponseData
request
Request
400
Bad Request
ErrorResponse
error
Error
request
Request
401
Unauthorized
ErrorResponse
error
Error
request
Request
503
Server Error
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerType}/batch/upload/status?batchId=object' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.io/core/api/v2/containers/{containerType}/batch/upload/status?batchId=object' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
503
// OK 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

HEADER/PATH/QUERY	DESCRIPTION	TYPE
`X-COREOS-REQUEST-ID`*(header)	Unique Request ID.	string
`X-COREOS-TID`*(header)	Tenant ID.	string
`X-COREOS-ACCESS`*(header)	core-os access token.	string
`containerType`*(path)	Type of container.	string
`batchId`*(query)	Unique ID of batch request.	string

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
503 - Server Errors	Something went wrong on our end. (These are rare.)

Updated 24 Aug 2023

Did this page help you?

Perform update operation on container via file upload