JTjtl-software
worker

Sync Control

Control the Sync Processes

put/v2/workers/{syncId}

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.write
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopessystem.worker.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

syncIdstring uuid required

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

The id of the job to Restart

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.

Request body

action0 | 1 | 2

0 = Start, 1 = Stop, 2 = Restart

Response

The Action is Invoked

Changes

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