Shares APIs
Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.
The CJA Shares APIs allow you to retrieve, update, or create shares and their association with components programmatically through Adobe Developer. The APIs use the same data and methods that are used when working with shares in the UI.
/componentmetadata/shares endpoint description
The /componentmetadata/shares endpoint description is shown in our Swagger UI. Use the Swagger UI to see endpoint summaries, available methods, parameters, example values, models, and status codes, and to try out the API.
Example creating shares
The following request example includes both a JSON message request body and a curl request to share a component with a group.
JSON Request Message
Copied to your clipboard{"componentId": "{COMPONENTID}","componentType": "{COMPONENTTYPE}","shareToId": "{groupId}","shareToType": "group"}
curl Request
Copied to your clipboardcurl -X POST \https://cja.adobe.io/componentmetadata/shares \-H 'Accept: application/json' \-H 'Authorization: Bearer {ACCESSTOKEN}' \-H 'Content-Type: application/json' \-H 'x-api-key: {API_KEY}' \-H 'x-gw-ims-org-id: {IMS_ORG_ID}' \-d '{REQUESTJSON}'
Example Response
Copied to your clipboard{"shareId": 12345,"componentId": "{COMPONENTID}","componentType": "{COMPONENTTYPE}","shareToImsId": "{groupId}","shareToType": "group"}
Example deleting a share
The following request example includes a curl request to delete a share.
curl Request
Copied to your clipboardcurl -X DELETE \https://cja.adobe.io/componentmetadata/shares/{SHARE_ID} \-H 'Accept: application/json' \-H 'Authorization: Bearer {ACCESSTOKEN}' \-H 'Content-Type: application/json' \-H 'x-api-key: {API_KEY}' \-H 'x-gw-ims-org-id: {IMS_ORG_ID}' \
The above curl command requests the following:
- Delete share with id
SHARE_IDand its association with other users/groups
Example Response
Copied to your clipboard{"shareId": {SHARE_ID},"status": {"success": true}}
Example retrieving list of shares for a company
The following request example includes a curl request to retrieve shares for current company.
curl Request
Copied to your clipboardcurl -X GET \https://cja.adobe.io/componentmetadata/shares?page=0&limit=3 \-H 'Accept: application/json' \-H 'Authorization: Bearer {ACCESSTOKEN}' \-H 'Content-Type: application/json' \-H 'x-api-key: {API_KEY}' \-H 'x-gw-ims-org-id: {IMS_ORG_ID}' \
The above curl command requests the following:
- Retrieve specific page with query param
page - Retrieve specific number of shares in a page with query param
limit
Example Response
Copied to your clipboard{"content": [{"shareId": 2085535,"shareToImsId": "{ims_user_id}","shareToType": "user","componentType": "segment","componentId": "s300006186_590cb8b9e4b0ca84fe8152b9","shareToDisplayName": null},{"shareId": 11684455,"shareToImsId": "{ims_group_id}","shareToType": "group","componentType": "segment","componentId": "s300006186_5f4eb5bc3f56a12f743e1405","shareToDisplayName": null},{"shareId": 11684456,"shareToType": "all","componentType": "segment","componentId": "s300006186_5f4eb5bb8aca3c5a990878e8","shareToDisplayName": null}],"totalPages": 38,"totalElements": 113,"number": 0,"numberOfElements": 3,"firstPage": true,"lastPage": false,"sort": null,"size": 3}
Example retrieve shares for multiple components
The following request example includes both a JSON message request body and a curl request to retrieve shares for multiple components of the same type.
JSON Request Message
Copied to your clipboard{"componentType": "segment","componentIds": ["s300006186_5f4eb5bb8aca3c5a990878e8"]}
curl Request
Copied to your clipboardcurl -X POST \https://cja.adobe.io/componentmetadata/shares/component/search?page=0&limit=3 \-H 'Accept: application/json' \-H 'Authorization: Bearer {ACCESSTOKEN}' \-H 'Content-Type: application/json' \-H 'x-api-key: {API_KEY}' \-H 'x-gw-ims-org-id: {IMS_ORG_ID}' \-d '{REQUESTJSON}'
The JSON message requests the following:
- Retrieves all shares for component id
s300006186_5f4eb5bb8aca3c5a990878e8of typesegment - Retrieve specific page with query param
page - Retrieve specific number of shares in a page with query param
limit
Example Response
Copied to your clipboard{"content": [{"componentType": "segment","componentId": "s300006186_5f4eb5bb8aca3c5a990878e8","shares": [{"shareId": 11684456,"shareToImsId": "{ims_user_id}","shareToType": "user","componentType": "segment","componentId": "s300006186_5f4eb5bb8aca3c5a990878e8","shareToDisplayName": null}]}],"totalPages": 1,"totalElements": 1,"number": 0,"numberOfElements": 1,"firstPage": true,"lastPage": true,"sort": null,"size": 10}
Example retrieving components using shared to the user
The following request example includes a curl request to retrieve a components of specific type associated with the user.
curl Request
Copied to your clipboardcurl -X GET \https://cja.adobe.io/componentmetadata/shares/sharedto/me \-H 'Accept: application/json' \-H 'Authorization: Bearer {ACCESSTOKEN}' \-H 'Content-Type: application/json' \-H 'x-api-key: {API_KEY}' \-H 'x-gw-ims-org-id: {IMS_ORG_ID}' \
Example Response
Copied to your clipboard["s300006186_5f4eb5bb8aca3c5a990878e8"]
Example retrieving shares using id
The following request example includes a curl request to retrieve a share with id.
curl Request
Copied to your clipboardcurl -X GET \https://cja.adobe.io/componentmetadata/shares/{SHARE_ID} \-H 'Accept: application/json' \-H 'Authorization: Bearer {ACCESSTOKEN}' \-H 'Content-Type: application/json' \-H 'x-api-key: {API_KEY}' \-H 'x-gw-ims-org-id: {IMS_ORG_ID}' \
Example Response
Copied to your clipboard{"shareId": 11684455,"shareToImsId": "{ims_group_id}","shareToType": "group","componentType": "segment","componentId": "s300006186_5f4eb5bc3f56a12f743e1405","shareToDisplayName": null}
Update shares for components
The following request example includes both a JSON message request body and a curl request to create and delete multiple shares associated with components.
Warning, this call is authoritative! Any shares not included in the request body will be deleted permanently!
JSON Request Message
Copied to your clipboard[{"componentType": "segment","componentId": "s300006186_5f4eb5bb8aca3c5a990878e8","shares": [{"shareId": 11684456,"shareToId": 622291,"shareToType": "user","componentType": "segment","componentId": "s300006186_5f4eb5bb8aca3c5a990878e8","shareToDisplayName": null}]}]
The JSON message requests the following:
- create a share to segment
s300006186_5f4eb5bb8aca3c5a990878e8for user622291 - if there are any preexisting shares associated with
s300006186_5f4eb5bb8aca3c5a990878e8then remove these associations.
curl Request
Copied to your clipboardcurl -X PUT \https://cja.adobe.io/componentmetadata/shares \-H 'Accept: application/json' \-H 'Authorization: Bearer {ACCESSTOKEN}' \-H 'Content-Type: application/json' \-H 'x-api-key: {API_KEY}' \-H 'x-gw-ims-org-id: {IMS_ORG_ID}' \-d '{REQUESTJSON}'
Example Response
Copied to your clipboard[{"componentType": "segment","componentId": "s300006186_5f4eb5bb8aca3c5a990878e8","shares": [{"shareToId": 622291,"shareToType": "user","accessLevel": null}],"status": {"success": true}}]
API status codes
For a description of API status codes and tips for troubleshooting, see the Platform FAQ and troubleshooting guide.
