List Components

View the full schema here.

Note

We strongly recommend that you include query parameters when using this resource. To search for a custom field <field> that matches <value>, you must use the prefix customFields. giving you customFields.<field>=<value>.

Sometimes you need to aggregate components by some combination of properties.

As an example we will assume that there is workspace with an Ardoq OID of 91ab09087115f76e365134c5 and that we are looking for all components within that workspace that have a custom field a with the value "hello" and a second custom field b with the value 42.

CurlPythonNode

curl \
  --get \
  --header "Authorization: Bearer ${ARDOQ_API_TOKEN}" \
  --header "X-org: ${ARDOQ_ORG_LABEL}" \
  --data-urlencode "rootWorkspace=91ab09087115f76e365134c5" \
  --data-urlencode "customFields.a=hello" \
  --data-urlencode "customFields.b=42" \
  --fail-with-body \
  "${ARDOQ_API_HOST-"https://app.ardoq.com"}/api/v2/components"

query={"rootWorkspace":"91ab09087115f76e365134c5","customFields.a":"hello","customFields.b":42}
resp = ardoq_request("/api/v2/components",query=query)
print(resp)

(async () => {
    query=`rootWorkspace=91ab09087115f76e365134c5&customFields.a=hello&customFields.b=42`
    const resp = await ardoq_request(`/api/v2/components?${query}`)
    console.log(resp)
})()