POST
/
components

Authorizations

Authorization
string
headerrequired

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Body

application/json
activity_completed_at
string
required

The date at which the physical activity related to this component started

activity_started_at
string
required

The date by which the physical activity related to this component finished

component_blueprint_key
string
required

The key of the blueprint which we are deriving this component from.

display_name
string
required
Required string length: 1 - 100
inputs
object[]
required

A list of component inputs. This must match the list of inputs on the component blueprint. See the component-blueprints endpoint.

project_id
string
required

The project in which to create the component

Required string length: 20 - 36
supplier_reference_id
string
required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

Required string length: 1 - 100
description
string | null

An optional description that can be used to add more context to the component

Response

200 - application/json
activity_completed_at
string | null
required
activity_started_at
string | null
required
blueprint_key
string | null
required
description
string
required
display_name
string
required
id
string
required
Required string length: 20 - 36
supplier_reference_id
string | null
required
type
enum<string>
required
Available options:
ACTIVITY,
COUNTERFACTUAL,
SEQUESTRATION,
LOSS