Skip to main content

Upsert framework answers

POST 
/api/v2/bulk/framework-answers/upsert
Asynchronous

This request is queued, not processed while you wait. The response carries a correlation id — poll the bulk task until it reports a terminal state. See How asynchronous processing works.

Queued, not immediate. The response carries a correlation id; poll GET /api/v2/bulk/tasks/{correlationId} until the request reports a terminal state; the task carries the status and, on failure, every failed row with its reason. The row-level record of the import, successful rows included, is available in the BeCause app on the API usage tab under Company manager → Import & export → API. Each entry names one company — by its BeCause company id, or by the stored value of one of your own String-type custom properties — and groups its answers into reporting periods. A Yearly period covers twelve months from its start month (omitted month means January); a Monthly period is one month. Values are typed: list answers carry option ids and units carry unit ids, both discoverable from GET /api/v1/frameworks/{frameworkId} and GET /api/v1/unit-types. A period may carry answers, omissions, or both: an omission records that the company deliberately declines to answer a question, and is keyed by question id rather than by data point id. When frameworkId is present the framework is assigned to each company for the reported periods; omissions carry no framework of their own and are recorded either way. At most 50,000 answers and omissions combined per request.

Request​

Responses​