Sync and Parse Status

Detailed integration status and progress info for running jobs.

Method	Operation	Syntax
GET	List Parse Job Status	api/v1/providers/datasources/{id}/parse_status
GET	List Sync Job Status	api/v1/providers/datasources/{id}/sync_status

Returns the most recent job type, state, status, and progress for a Veza datasource.

• sync jobs are connections to the integration to extract identity and authorization metadata

• parse jobs compile the extracted metadata into graph entities and relationships

Use GET api/v1/providers/datasources to get overall integration state and a summary of last sync and parse time.

States can be:

• PENDING

• IN_PROGRESS

• COMPLETED

Status can be:

• OK

• CANCELED

• DEADLINE_EXCEEDED

• NOT_FOUND

• PERMISSION_DENIED

• UNAUTHENTICATED

• UNAVAILABLE

• INTERNAL

• FAILED_PRECONDITION

Data sources time out after a heartbeat hasn’t been received or changed in a period of time (typically 24 hours).

List Parse Job Status response

Parse jobs have the PARSE type.

{
  "job_status": {
    "job_id": "59428cf3-a3ed-4989-8b9e-a96e4af1e45b",
    "job_type": "PARSE",
    "state": "COMPLETED",
    "status": "OK",
    "started_at": "2023-02-01T04:37:00.007678769Z",
    "duration": "0.683888613s",
    "stats": { "started_at": null, "finished_at": null, "steps": [] }
  }
}

List Sync Job Status response

Sync jobs types can be:

• DISCOVERY

• EXTRACTION

The job_status response will contain stats with detailed timestamps and progress on the active step, including the current_count of discovered or parsed objects. A total_count is shown for completed steps.

{
  "job_status": {
    "job_id": "f3cb7fb0-82c3-4ab6-9fdf-b88d93478ebb",
    "job_type": "EXTRACTION",
    "state": "COMPLETED",
    "status": "OK",
    "started_at": "2023-02-22T06:27:25.480075100Z",
    "duration": "0.569382661s",
    "stats": {
      "started_at": "2023-02-22T06:27:25.530741076Z",
      "finished_at": "2023-02-22T06:27:26.100138149Z",
      "steps": [
        {
          "name": "Regions",
          "state": "COMPLETED",
          "started_at": "2023-02-22T06:27:25.530844874Z",
          "finished_at": "2023-02-22T06:27:26.099752432Z",
          "current_count": 4,
          "total_count": 4
        }
      ]
    }
  }
}