Retrieve the current processing status of one or more previously uploaded files

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the availability status and remarks for one or more files identified by their file IDs. Use this to verify whether a file upload has completed before referencing it in other API calls.

Endpoints

Request URL

https://{server-hostname}:8383/emsapi/fileupload/status

Scope

Common.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
fileIDsarrayMandatory

Array of file_id values (as strings) to check status for. Each file_id must have been obtained from a prior file upload response, e.g. Upload a File Using Module Configuration

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/emsapi/fileupload/status \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"fileIDs":["9507000000018007"]}'

Sample Request Body

Check the upload status of a single file

Copied!
  {
    "fileIDs": [
      "9507000000018007"
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
responseJSON Array

Array of file status objects, one per requested file_id

Show Sub-Attributes
JSON Object
Show Sub-Attributes
file_idstring

Unique identifier of the uploaded file

file_availability_statusinteger

Numeric status code of the file. For example, 2 indicates the file has been uploaded and is ready for use

remarksstring

Additional human-readable remarks about the file status. May be empty

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

File has been uploaded and is ready for use

Copied!
  {
    "response": [
      {
        "file_id": "9507000000018007",
        "file_availability_status": 2,
        "remarks": ""
      }
    ]
  }
                
Show full

Duration: 1 minute | Threshold: 500 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.