Create a Component

View the full schema here.

In order to create a component you are required to provide (a minimum of) three pieces of information:

1. The Ardoq OID of the workspace (rootWorkspace) that the component should belong to.
2. The type identifier typeId that the component should have. Once you know the workspace OID you can get the context for the workspace. The response contains information about the available types of component available.
3. The name you want the component to have. For example "My Component".

Note

Whenever working with components, remember that each component belongs to exactly one workspace. Workspaces are collections of components.

For simplicity we will assume that you know the Ardoq OID of the workspace that you want to create a component in and the type identifier.

Curl

curl \
  --request POST \
  --header "Authorization: Bearer ${ARDOQ_API_TOKEN}" \
  --header "X-org: ${ARDOQ_ORG_LABEL}" \
  --header "Content-Type: application/json" \
  --data '{"rootWorkspace":"91ab09087115f76e365134c5","typeId":"p262458007767137","name":"My Component"}' \
  --fail-with-body \
  "${ARDOQ_API_HOST-"https://app.ardoq.com"}/api/v2/components"