Retrieve the component details

Request

Retrieves the details of a specific component, including its ID, name, and datasource options.

Security

HTTPBearer

Path

componentIdstring, (uuid)(Componentid)required

The unique identifier of the component. To get this ID, use List components of a page.

Example:86a03271-dff4-470a-92bd-b68c67de2e25

x-sc-job-idany(X-Sc-Job-Id)

A unique identifier for the job, used to trace, audit, and revert actions performed by an AI agent through the Agent API.

Example:job-1234

curl -i -X GET \
  https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/components/86a03271-dff4-470a-92bd-b68c67de2e25 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-job-id: job-1234'

Responses

Successful response

Bodyapplication/json

idstring, (uuid)(Id)

The unique identifier of the component.

Example:"86a03271-dff4-470a-92bd-b68c67de2e25"

namestring(Name)

The name of the component.

Example:"Promo"

datasourceTemplateIdstring or null(Datasourcetemplateid)

Example:"9f8c7e6d-5b4a-4c3d-8e7f-1a2b3c4d5e6f"

Any of:

The template ID for the component's datasource. May be None if the component has no datasource template.

string (uuid)

datasourceLocationsArray of strings(Datasourcelocations)

A list of locations for the component's datasource.

Example:

[
  "query:$site/*[@@name='Data']/*[@@templatename='Promo Folder']"
]

datasourceTemplatePathstring(Datasourcetemplatepath)

The path to the datasource template.

Default:""

Example:"Feature/JSS Experience Accelerator/Page Content/Promo"

datasourceFieldsArray of objects(Datasourcefields)

A list of fields for the datasource.

datasourceAutoGeneratedboolean(Datasourceautogenerated)

Whether the datasource is auto-generated.

Example:false

datasourceRequiredboolean(Datasourcerequired)

Whether the datasource is required.

Example:true

hasDynamicPlaceholderboolean or null(Hasdynamicplaceholder)

Example:true

Any of:

Whether the component has a dynamic placeholder.

boolean

Response

{
  "id": "86a03271-dff4-470a-92bd-b68c67de2e25",
  "name": "Promo",
  "datasourceTemplateId": "9f8c7e6d-5b4a-4c3d-8e7f-1a2b3c4d5e6f",
  "datasourceLocations": [
    "query:$site/*[@@name='Data']/*[@@templatename='Promo Folder']"
  ],
  "datasourceTemplatePath": "Feature/JSS Experience Accelerator/Page Content/Promo",
  "datasourceFields": [
    { … }
  ],
  "datasourceAutoGenerated": false,
  "datasourceRequired": true,
  "hasDynamicPlaceholder": true
}