Retrieve remote office move 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

Retrieves the current status of a remote office move operation including success count, failure count, and in-progress flags.

Request URL

https://{serverurl}/dcapi/som/computers/moveStatus

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

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

Response Parameters

- HTTP code 200

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

Indicates whether the remote office move workflow is currently being processed

installInProgressboolean

Indicates whether agent reinstallation is pending as part of the move operation (required when moving to a new Distribution Server)

agentMoveSummaryJSON Object

Summary of the completed move operation including success and failure counts. Present only after the move finishes

Show Sub-Attributes
moveSuccessCountstring

Number of computers that were successfully moved to the target remote office

moveFailedCountstring

Number of computers where the move to the target remote office failed

isAgentMoveSuccessboolean

Indicates whether all computers in the batch were moved successfully. Returns false if any computer failed

messagestring

Summary description of the move operation outcome (e.g., '3 out of 4 computers moved successfully')

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Move in progress

Copied!
  {
    "isAgentMoveInProgress": true,
    "installInProgress": false
  }
                
Show full

Move completed

Copied!
  {
    "isAgentMoveInProgress": false,
    "installInProgress": false,
    "agentMoveSummary": {
      "moveSuccessCount": 3,
      "isAgentMoveSuccess": false,
      "moveFailedCount": 1,
      "message": "3 out of 4 computers moved successfully"
    }
  }
                
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.