Retrieve remote office CSV import progress

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 current status of a remote office CSV import operation. While the import is running, csvImportInProgress is true. Once complete, a summary with success and failure counts is included.

Request URL

https://{serverurl}/dcapi/som/remote-offices/importStatus

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/importRemoteOfficeStatus.v1+jsonapplication/importRemoteOfficeStatus.v1+jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/som/remote-offices/importStatus \
  --header 'Accept: application/importRemoteOfficeStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
csvImportInProgressboolean

true if the remote office CSV import process is currently running, false if completed or not started

csvImportSummaryJSON Object

Summary of the completed import including success and failure counts. Present only when the import has finished

Show Sub-Attributes
csvImportSuccessCountstring

Number of records from the CSV file that were successfully imported

csvImportFailureCountstring

Number of records from the CSV file that failed validation or could not be imported

isEmptyCSVFileboolean

Indicates whether the uploaded CSV file contained no valid data rows to process

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Import is currently running

Copied!
  {
    "csvImportInProgress": true
  }
                
Show full

Import completed with success and failure counts

Copied!
  {
    "csvImportSummary": {
      "csvImportFailureCount": 1,
      "csvImportSuccessCount": 5
    },
    "csvImportInProgress": false
  }
                
Show full

Import completed but CSV file had no valid data

Copied!
  {
    "csvImportSummary": {
      "isEmptyCSVFile": true
    },
    "csvImportInProgress": false
  }
                
Show full

No import has been initiated

Copied!
  {
    "csvImportInProgress": false
  }
                
Show full

Duration: 1 minute | Threshold: 30 | 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.