Get the Possible Values for A Form Field Of A Component In A Blueprint

Get the Possible Values for A Form Field Of A Component In A Blueprint

Get the possible values for a specific field in the request form of a component in a blueprint.

Request
URI
POST
https://{api_host}/composition-service/api/requests/hierarchy/{blueprintId}/{fieldPath}/form/{formType}/{formElementId}/values
COPY
Path Parameters
string
blueprintId
Required

The objectId of the blueprint.

string
fieldPath
Required

The path of the component whose form the field belongs to.

string
formType
Required

The type of the request form.

Possible values are : composition.request.submission, composition.request.details,
string
formElementId
Required

The ID of the form field whose values are requested.

Query Parameters
string
subtenantId
Optional

The id of the business group in which the request will be made.

Request Body
elementValuesRequest of type(s) application/json
Optional 
{
    "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 an ElementValuesResponse containing a list of possible values.

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

values


On This Page
Internal Api Operations
POST
Get the Possible Values for A Form Field Of A Component In A Blueprint
POST
Get the Possible Values for A Form Field Of A Component In A Requested Blueprint
POST
Get Updates To the Request Form Of A Blueprint Component
POST
Get Updates To the Request Form Of A Component In A Requested Blueprint