solarOS Organization API

ssolarOS API
Go to app
Organization API

List External Record Links on a Case

Returns navigable context links from a Case to related records in external systems. External Record Links are not identity-bearing External References.

/api/v1/cases/{id}/external-record-links

Returns navigable context links from a Case to related records in external systems. External Record Links are not identity-bearing External References.

List External Record Links on a Case. Use an organization API key with cases:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

cases:read

Parameters

NameInTypeDescription
idrequiredpathstringCase identifier returned by the Organization API.

Request body

This endpoint does not accept a JSON request body.

Responses

200

External Record Link list envelope

#/components/schemas/OrgApiListEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing required scope: cases:read

#/components/schemas/OrgApiError

404

Case not found

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: cases:read404 Case not found429 Rate limit exceeded

Static examples

curl -X GET "$SOLAROS_BASE_URL/api/v1/cases/$SOLAROS_CASE/external-record-links" \
  -H "Authorization: Bearer $SOLAROS_API_KEY"