Import remote offices from a CSV file

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

Imports multiple remote offices from a CSV file upload.

Request URL

https://{server-hostname}:8383/dcapi/som/remote-offices/import

Scope

SOM.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
multipart/form-datamultipart/form-dataCopied!
AcceptstringMandatory
application/importRemoteOffices.v1+jsonapplication/importRemoteOffices.v1+jsonCopied!

- Request Body

multipart/form-data
JSON Object
Hide Sub-Attributes
remoteOfficeCSVFilestringMandatory

A CSV file containing the remote office details required for bulk import. Refer to the sample CSV file for the supported format and field values.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/dcapi/som/remote-offices/import \
  --header 'Accept: application/importRemoteOffices.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: multipart/form-data' \
  -F 'remoteOfficeCSVFile=CSV File'

Sample Request Body

Import bulk remote offices using a CSV file upload

Copied!
remoteOfficeCSVFile = CSV File
Show full

Response Parameters

- HTTP code 202

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

Indicates whether the CSV import process has been accepted and is currently running

- HTTP code 400

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

HTTP status code (400)

errorCodestring

API-specific error code identifying the validation failure

messagestring

Error message describing the validation failure

- HTTP code 412

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

HTTP status code (412)

errorCodestring

Precondition failed error code identifying the business logic violation

messagestring

Error message describing the precondition failed while processing request

Possible Response Codes

202HTTP code
400HTTP code
412HTTP code

Sample Response: HTTP 202

Remote office CSV import initiated

Copied!
  {
    "csvImportInProgress": true
  }
                
Show full

Sample Response: HTTP 400

Empty or invalid CSV file

Copied!
  {
    "errorCode": "30047",
    "message": "No data to import",
    "statusCode": 400
  }
                
Show full

Sample Response: HTTP 412

Another import is already running

Copied!
  {
    "errorCode": "30013",
    "message": "An import operation is already in progress",
    "statusCode": 412
  }
                
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.