Get Component Type Element Authoring Form Values

Get Component Type Element Authoring Form Values

Get the permissible values for an element within the authoring form of a specified component type.

Request
URI
POST
https://{api_host}/composition-service/api/componenttypes/{id}/forms/author/{elementId}/values
COPY
Path Parameters
string
id
Required

The objectId of the component type.

string
elementId
Required

The id of an element within the component type.

Request Body

Information required to complete the request.

elementValuesRequest of type(s) application/json
Required 
{
    "pagingInfo": {
        "offset": 0,
        "count": 0
    },
    "headers": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "tenantId": "string",
    "text": "string",
    "userId": "string",
    "dependencyValues": {
        "entries": [
            {
                "key": "string"
            }
        ]
    }
}
ElementValuesPagingInfo
pagingInfo
Optional

pagingInfo

literalMap
headers
Optional

headers

string
tenantId
Optional

tenantId

string
text
Optional

text

string
userId
Optional

userId

literalMap
dependencyValues
Optional

dependencyValues

literal
associateValue
Optional

associateValue

Responses
200

Success - return the component type.

Returns elementValues of type(s) */* 
{
    "values": [
        {
            "label": "string"
        }
    ]
}
array of value
values
Optional

values


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

On This Page
Component Types Operations
GET
Get Component Type Authoring Form
POST
Get Component Type Element Authoring Form Metadata
POST
Get Component Type Element Authoring Form Values