Canvas Data 2 API Usage Workflow

This workflow displays the Canvas Data 2 API usage.

To view and zoom in on the flowchart, click the attached PDF link.

Flowchart titled "Canvas Data 2 API Usage Workflow." Starts with "Authenticate with access token (JWT) from API Gateway." If credentials are invalid, process ends with "Error Message." If valid, user can start either an incremental query or a snapshot query. Both can result in "Request Failed" with an error message, or proceed to "Query Job Status." Status options: running (no resource returned), failed (no resource returned), or complete (resource ID and schema version returned). If complete, compare schema versions. If different, request table schema and download table as JSON. If same, request resource URL. URL may expire (error) or point to result file, leading to "Complete." Error points are marked with "X" for failed steps.Flowchart titled "Canvas Data 2 API Usage Workflow." Starts with "Authenticate with access token (JWT) from API Gateway." If credentials are invalid, process ends with "Error Message." If valid, user can start either an incremental query or a snapshot query. Both can result in "Request Failed" with an error message, or proceed to "Query Job Status." Status options: running (no resource returned), failed (no resource returned), or complete (resource ID and schema version returned). If complete, compare schema versions. If different, request table schema and download table as JSON. If same, request resource URL. URL may expire (error) or point to result file, leading to "Complete." Error points are marked with "X" for failed steps.

Last update: 2025-08-15

This resource can also be accessed from the How do I set up Canvas Data 2 with an API client (Postman)? guide.

Labels (1)
Labels:
Attachments