JTjtl-software
worker

Get Worker Status

Returns the Status of the Worker

get/v2/workers/status

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopessystem.worker.read
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopessystem.worker.read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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

Changes

No recorded changes to this operation across all 1 revision of this API.