List References

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 references by some combination of properties.

As an example we will look for all references that have a target component in the workspace with Ardoq OID 91ab09087115f76e365134c5 and 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 "targetWorkspace=91ab09087115f76e365134c5" \
  --data-urlencode "customFields.a=hello" \
  --data-urlencode "customFields.b=42" \      
  --fail-with-body \
  "${ARDOQ_API_HOST-"https://app.ardoq.com"}/api/v2/references"

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

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