References

Get the parent references of a given list of resources

This operation returns the parent references of type Page, Experience Fragment and Content Fragments which are referencing the resources specified in the payload.

SecuritybearerAuth

Request

Request Body schema: application/json

paths

required

Array of strings (ContentFragmentPath) non-empty

The list of Content Fragment paths for which to retrieve the back references.

Responses

200

400

Bad Request. The Problem Details object will provide more information about the exact cause.

406

Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

413

"The HTTP 413 Content Too Large response status code indicates that the request entity is larger than limits defined by server; the server might close the connection or return a Retry-After header field. Prior to RFC 9110 the response phrase for the status was Payload Too Large. That name is still widely used."

415

Unsupported Media Type. When provided as a response to a PATCH request, the response will provide an Accept-Patch response header to notify the client what patch document media types are supported.

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

post/cf/fragments/referencedBy

Request samples

Payload
curl
Java
Node.js
JavaScript

application/json

{"paths": ["/content/dam/wknd-shared/en/contributors/ian-provo",
"/content/dam/wknd-shared/en/contributors/jacob-wester"
]
}

Response samples

application/json

{"items": [{"path": "/content/dam/wknd-shared/en/contributors/ian-provo",
"parentReferences": [{"type": "experience-fragment",
"title": "byline",
"path": "/content/experience-fragments/wknd/language-masters/en/contributors/stacey-roswells/byline",
"status": "DRAFT"
},
{"type": "experience-fragment",
"title": "master",
"path": "/content/experience-fragments/wknd/language-masters/en/contributors/stacey-roswells/master",
"status": "DRAFT"
},
{"type": "content-fragment",
"title": "ultimate-guide-to-la-skateparks",
"path": "/content/dam/wknd-shared/en/magazine/la-skateparks/ultimate-guide-to-la-skateparks",
"status": "DRAFT"
}
]
}
]
}

Get the references of a Content Fragment

SecuritybearerAuth

Request

path Parameters

fragmentId

required

string <uuid> (UUID)

Resource unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373

Responses

200

400

Bad Request. The Problem Details object will provide more information about the exact cause.

404

Not Found

406

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

get/cf/fragments/{fragmentId}/references

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"items": [{"name": "ian_provo.jpg",
"fieldName": "profilePicture",
"type": "asset",
"path": "/content/dam/wknd-shared/en/contributors/ian_provo.jpg",
"created": {"at": "2023-08-02T16:01:47.765+03:00",
"by": "admin"
},
"status": "DRAFT",
"assetId": "urn:aaid:aem:1fb05fe4-c12b-4f85-b1ca-aa92cdbd6a62",
"repo:size": 251434,
"dc:format": "image/jpeg",
"tiff:ImageWidth": 1152,
"tiff:ImageHeight": 1152
}
]
}

Get the references of a Content Fragment as a list

SecuritybearerAuth

Request

path Parameters

fragmentId

required

string <uuid> (UUID)

Resource unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373

Responses

200

404

Not Found

406

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

get/cf/fragments/{fragmentId}/referencesTree

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"items": [{"fieldName": "fieldName",
"identifier": "5dc7a777-d75e-4428-841a-81382fba71b2"
},
{"fieldName": "fieldName2",
"identifier": "5dc7a777-d75e-4428-841a-81382fba71b2"
},
{"fieldName": "fieldName3",
"identifier": "051f3e21-dcc9-4970-9410-2eda2f1a1611",
"pointerReferences": [{"fieldName": "references",
"identifier": "ee038ec6-8f43-4543-9f95-b193258d6bed",
"pinterReferences": [{"fieldName": "references",
"identifier": "051f3e21-dcc9-4970-9410-2eda2f1a1611"
}
]
}
]
}
],
"references": {"5dc7a777-d75e-4428-841a-81382fba71b2": {"name": "a",
"type": "content-fragment",
"title": "A",
"path": "path/to/a",
"created": {"at": "2024-08-22T11:54:40.276+03:00",
"by": "author",
"fullNames": "Author Name"
},
"modified": {"at": "2024-08-22T11:56:40.276+03:00",
"by": "author",
"fullNames": "Author Name"
},
"status": "DRAFT",
"id": "5dc7a777-d75e-4428-841a-81382fba71b2",
"model": {"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvY3ljbGU",
"path": "/path/to/model",
"name": "name",
"title": "title"
},
"description": "",
"fields": [{"name": "fieldLabel",
"type": "text",
"multiple": false,
"locked": false,
"values": ["A"
]
},
{"name": "references",
"type": "content-fragment",
"multiple": true,
"locked": false,
"values": [ ]
}
],
"variations": [ ],
"tags": [ ]
},
"051f3e21-dcc9-4970-9410-2eda2f1a1611": {"name": "c1",
"type": "content-fragment",
"title": "C1",
"path": "path/to/c1",
"created": {"at": "2024-08-22T11:54:40.276+03:00",
"by": "author",
"fullNames": "Author Name"
},
"modified": {"at": "2024-08-22T11:56:40.276+03:00",
"by": "author",
"fullNames": "Author Name"
},
"status": "DRAFT",
"id": "051f3e21-dcc9-4970-9410-2eda2f1a1611",
"model": {"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvY3ljbGU",
"path": "/path/to/model",
"name": "name",
"title": "title"
},
"description": "",
"fields": [{"name": "fieldLabel",
"type": "text",
"multiple": false,
"locked": false,
"values": ["C1"
]
},
{"name": "references",
"type": "content-fragment",
"multiple": true,
"locked": false,
"values": ["/path/to/c2"
]
}
],
"variations": [ ],
"tags": [ ]
},
"ee038ec6-8f43-4543-9f95-b193258d6bed": {"name": "c2",
"type": "content-fragment",
"title": "C2",
"path": "path/to/c2",
"created": {"at": "2024-08-22T11:54:40.276+03:00",
"by": "author",
"fullNames": "Author Name"
},
"modified": {"at": "2024-08-22T11:56:40.276+03:00",
"by": "author",
"fullNames": "Author Name"
},
"status": "DRAFT",
"id": "ee038ec6-8f43-4543-9f95-b193258d6bed",
"model": {"id": "L2NvbmYvd2tuZC1zaGFyZWQvc2V0dGluZ3MvZGFtL2NmbS9tb2RlbHMvY3ljbGU",
"path": "/path/to/model",
"name": "name",
"title": "title"
},
"description": "",
"fields": [{"name": "fieldLabel",
"type": "text",
"multiple": false,
"locked": false,
"values": ["C2"
]
},
{"name": "references",
"type": "content-fragment",
"multiple": true,
"locked": false,
"values": ["/path/to/c1"
]
}
],
"variations": [ ],
"tags": [ ]
}
}
}

Get the parent references of a Content Fragment

This operation returns the parent references of type Page, Experience Fragment and Content Fragments which are referencing the given Content Fragment.

SecuritybearerAuth

Request

path Parameters

fragmentId

required

string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373

query Parameters

cursor	string (Cursor) non-empty For a paginated request, this parameter defines the cursor from which to retrieve the next set of items.
limit	integer <int32> (Limit) [ 1 .. 50 ] For a paginated request, this parameter defines the maximum number of items to retrieve.

Responses

200

400

Bad Request. The Problem Details object will provide more information about the exact cause.

404

Not Found

406

500

The server encountered an unexpected error. Retrying the request after a certain time could help.

get/cf/fragments/{fragmentId}/referencedBy

Request samples

curl
Java
Node.js
JavaScript

Response samples

application/json

{"items": [{"path": "/path/to/parent/experience-fragment/reference",
"title": "Title",
"status": "DRAFT",
"type": "experience-fragment"
},
{"path": "/path/to/parent/page/reference",
"title": "Title",
"status": "NEW",
"type": "page"
},
{"path": "/path/to/parent/content-fragment/reference",
"title": "Title",
"status": "NEW",
"type": "content-fragment",
"model": {"id": "L2NvbmYvZ2xvYmFsL3NldHRpbmdzL2RhbS9jZm0vbW9kZWxzL2Etc2ltcGxlLWNmbQ",
"path": "/conf/global/settings/dam/cfm/models/a-simple-cfm",
"name": "A_simple_CFM",
"title": "A simple CFM"
},
"id": "uuid-of-content-fragment"
}
],
"cursor": "wqeaszrdxtgfcyguiohfgytdrsewq"
}

➔ Next to Translations