v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
worker

Get Worker Status

Returns the Status of the Worker

get/v2/workers/status

Query parameters

syncIdstring uuid

Represents a configuration key that serves as a unique identifier for configuration entities.

Gets the unique identifier for the configuration key.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

The Status Elements of the Worker

identifierstring uuid

Represents a configuration key that serves as a unique identifier for configuration entities.

state0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

0 = Suspended, 1 = Starting, 2 = Running, 3 = SuccessfullFinished, 4 = SleepingError, 5 = Stopping, 6 = SleepingErrorGesperrt, 7 = Deactivated

progressTextstring

The text of Progress

progressnumber double

The Percent of Progress

lastSyncstring date-time

The Time of Last Sync

nextSyncstring date-time

The Time of Next Sync