Framework

Get Framework Data

Changed on
get/v2/framework/{framework_id}/data

Request

  • Base URL: https://api.carbonarc.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.carbonarc.co/v2/framework/{framework_id}/data
  • Auth: none declared

Path parameters

framework_idstring uuid required

Query parameters

data_typestring

Data type

pageinteger nullable
sizeinteger nullable
fetch_allboolean

Fetch all data

pollboolean

Opt into the job-polling contract (PRO-3420): if the query hasn't finished within its short submission wait, respond with a QueryJobResponse envelope instead of blocking until it's done. Callers that don't pass this keep the original always-blocking behavior unchanged.

job_idstring nullable

Finalize a job an earlier poll=true call already submitted, once GET /v2/query-jobs/{job_id} reports it terminal, instead of submitting a new one. The normal response shaping/pagination still runs on the result.

Request body

object nullable required

Response

Successful Response

OR
OR

Changes

  • 81f915d799eeRevision changes
    • info

      added the optional property / to the response with the status

  • 766fe5f73174Revision changes
    • warning

      added the new cancelled enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status