Sign in
Database tables

Start a job to sync the data sync table with the provided data_sync_id parameter if the authorized user has access to the database's workspace.

post/api/database/data-sync/{data_sync_id}/sync/async/

Path parameters

data_sync_idinteger required

Starts a job to sync the data sync table related to the provided value.

Response

idinteger required
typestring required

The type of the job.

progress_percentageinteger required

A percentage indicating how far along the job is. 100 means that it's finished.

statestring required

Indicates the state of the import job.

human_readable_errorstring

A human readable error message indicating what went wrong.

error_codestring

A machine readable error code indicating why the job failed.

created_onstring date-time required
updated_onstring date-time required
triggered_bystring required

Whether this sync run was started manually or periodically.

user_namestring required

The name of the user that started this sync run.

Changes

Changed in 2 of the 6 revisions of this API.3

  • ea4a3480f8d31See the full diff
    • ○

      added the optional property error_code to the response with the 202 status

      response-optional-property-added

  • 0c490e5b0c7f2See the full diff
    • ○

      added the required property triggered_by to the response with the 202 status

      response-required-property-added

    • ○

      added the required property user_name to the response with the 202 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog