Retrieve component metadata

Request

Fetches the metadata of a component.

Security

Bearer

Path

componentIdstringrequired

The component identifier.

Example:2492bac4-da07-4c86-87f0-9873d40e2276

Query

siteIdstringrequired

The site identifier.

Example:siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08

contextItemIdstringrequired

The context item identifier.

Example:contextItemId=2f34355e-c52d-450e-b1b9-d4e9cbe64af2

componentNamestring

The component name.

Example:componentName=Promo

renderingHostNamestringrequired

The rendering host name.

Example:renderingHostName=nextjs-production

environmentIdstring

The environment identifier.

Example:environmentId=main

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/authoring/api/v1/components/2492bac4-da07-4c86-87f0-9873d40e2276/metadata?siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&contextItemId=2f34355e-c52d-450e-b1b9-d4e9cbe64af2&componentName=Promo&renderingHostName=nextjs-production&environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json

idstring or null

The component identifier.

Example:"2492bac4-da07-4c86-87f0-9873d40e2276"

namestring or null

The component name.

Example:"Promo"

displayNamestring or null

The component display name.

Example:"Promo"

codestring or null

The component code.

Example:"const Greeting = () => <h1>Hello!</h1>;"

renderingParametersArray of objects or null(RenderingParameter)

Rendering parameters

settingsobject or null

Component settings.

availabilityobject(ComponentAvailability)

The component availability model

Response

{
  "id": "2492bac4-da07-4c86-87f0-9873d40e2276",
  "name": "Promo",
  "displayName": "Promo",
  "code": "const Greeting = () => <h1>Hello!</h1>;",
  "renderingParameters": [
    { … }
  ],
  "settings": {
    "property1": null,
    "property2": null
  },
  "availability": {
    "sites": [ … ],
    "pageModels": [ … ]
  }
}