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 (AssetOrLaunchPath) non-empty

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

Responses

200

OK

400

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

406

Not Acceptable. 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

Content Too Large. Indicates that the server is refusing to process a request because the request content is larger than the server is willing or able to process.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

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

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/fragments/{fragmentId}/references

Request samples

curl
Java
Node.js
JavaScript

Response samples

200
400
404
406
500

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

OK

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/fragments/{fragmentId}/referencesTree

Request samples

curl
Java
Node.js
JavaScript

Response samples

200
400
404
406
500

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",
"pointerReferences": [{"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",
"fullName": "Author Name"
},
"modified": {"at": "2024-08-22T11:56:40.276+03:00",
"by": "author",
"fullName": "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",
"fullName": "Author Name"
},
"modified": {"at": "2024-08-22T11:56:40.276+03:00",
"by": "author",
"fullName": "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",
"fullName": "Author Name"
},
"modified": {"at": "2024-08-22T11:56:40.276+03:00",
"by": "author",
"fullName": "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 When the number of results for a request exceeds the allowed limit, the response will include a `cursor`. That value can then be sent via this parameter on a subsequent request 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

Ok

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. 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.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/fragments/{fragmentId}/referencedBy

Request samples

curl
Java
Node.js
JavaScript

Response samples

200
400
404
406
500

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"
}