Get asset references

GET

/api/references/{configId}/{assetId}

curl --request GET \
  --url https://example.com/api/references/example/example \
  --header 'Authorization: Bearer <token>'

• CM Box Server

Retrieves the references (items this asset references and items that reference this asset) for a content item

Authorizations

• bearerAuth

Parameters

Path Parameters

configId

required

Repository configuration ID

string

assetId

required

Asset ID

string

Responses

200

References retrieved successfully

Media typeapplication/json

object

references

Items referenced by this asset

Array<object>

object

id

required

Referenced item ID

string

name

Referenced item name

string

type

Referenced item type

string

status

Referenced item status

string

fieldName

Field containing this reference

string

referencedBy

Items that reference this asset

Array<object>

object

id

required

Referenced item ID

string

name

Referenced item name

string

type

Referenced item type

string

status

Referenced item status

string

fieldName

Field containing this reference

string

Example^generated

{
  "references": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "status": "example",
      "fieldName": "example"
    }
  ],
  "referencedBy": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "status": "example",
      "fieldName": "example"
    }
  ]
}

404

Item not found

Media typeapplication/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}