Maintenance

Gets the current in-memory state of all maintenance tasks.

get/api/v{version}/maintenance/status

Request

  • The document declares no server URL.
  • Auth
    OpenIdConnect (defined in the document in a form this page cannot read)

Path parameters

versionstring required

Response

Returns the current state of all maintenance tasks.

type'LocationMigration' | 'CoordinateMigration' | 'UserMerge'

Represents the type of a maintenance task.

status'Idle' | 'Running' | 'Completed' | 'Failed'

Represents the status of a maintenance task.

affectedCountinteger nullable

Gets or sets the number of records affected by the task.

messagestring nullable

Gets or sets the error message if the task failed.

startedAtstring date-time nullable

Gets or sets when the task started.

completedAtstring date-time nullable

Gets or sets when the task completed.

Changes

No recorded changes to this operation across all 37 revisions of this API.