Get Component Type Element Authoring Form Metadata
Get the metadata of one or more elements within the authoring form of a specified component type.
Request
URI
POST
https://{api_host}/composition-service/api/componenttypes/{id}/forms/author/update
COPY
Path Parameters
string
id
Required
The objectId of the component type.
Request Body
Information required to complete the request.
batchElementUpdateRequest
of type(s)
application/json
Required
{
"formValues": {
"entries": [
{
"key": "string"
}
]
},
"trigger": "string",
"triggeredDetailsLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": 0
}
]
}
]
}
]
}
]
},
"affectedElements": [
"string"
]
}
string
trigger
Optional
trigger
array of
string
affectedElements
Optional
affectedElements
Responses
200
Success - return the component type.
Returns
formUpdateResponse
of type(s)
*/*
{
"elementUpdates": [
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": 0
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
]
}
403
Forbidden.
Operation doesn't return any data structure
404
Component type or not found or has no authoring form.
Operation doesn't return any data structure