Appearance

Create Sync Job Run State ​

Create a new sync job run state entry in the specified namespace.

Endpoint ​

http
POST /sync-job-run-state

Query parameters ​

Refer Specifying query parameters in Truto APIs

state_key
string
REQUIRED · 

The state_key attribute found in a sync job run and defined in the sync job. Used as a namespace for the states.

Example: sync_job_123

Request Body ​

key
string
REQUIRED · 

The key identifier for this state.

Example: last_processed_id
value
string
REQUIRED · 

The state value to store.

Example: eyJpZCI6IjEyMzQ1IiwidGltZXN0YW1wIjoiMjAyMy0wMS0wMVQwMDowMDowMFoifQ==

Response Body ​

key
string

The key identifier for this state.

Example: last_processed_id
value
string

The state value stored.

Example: eyJpZCI6IjEyMzQ1IiwidGltZXN0YW1wIjoiMjAyMy0wMS0wMVQwMDowMDowMFoifQ==
created_at
string · date-time

Timestamp when the state was created.

Example: 2023-01-01T10:00:00.000Z
updated_at
string · date-time

Timestamp when the state was last updated.

Example: 2023-01-01T10:00:00.000Z
sync_job_run_id
string · uuid

The ID of the sync job run this state is associated with (optional).

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7