Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.

Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.

Retrieves the updated state of one or more layout elements in response to change in one or more layout fields' values.

Request
URI
POST
https://{api_host}/approval-service/api/info/approvalrequests/{requestId}/form/source/update
COPY
Path Parameters
string
approvalId
Required

The approval id

Request Body
batchElementUpdateRequest of type(s) application/json
Optional 
{
    "formValues": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "headers": {
        "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"
    ]
}
literalMap
formValues
Required

formValues

literalMap
headers
Optional

headers

string
trigger
Optional

trigger

layout
triggeredDetailsLayout
Optional

triggeredDetailsLayout

array of string
affectedElements
Optional

affectedElements

Responses
200

successful operation

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"
            ]
        }
    ]
}
array of updateElementEntry
elementUpdates
Optional

elementUpdates


On This Page
Approval Info Operations
GET
Retrieve A read-only form providing detailed information about the source Of A specific approval.
GET
Retrieve A read-only form providing detailed information about the source Of An approval associated with A specific approval request.
GET
Retrieve information about A specific approval By its unique identifier.
GET
Retrieve information about A specific approval request By its unique identifier.
POST
Retrieves A paged list Of permissible values for A specific field On the approval source details form, accessed via An approval request.
POST
Retrieves A paged list Of permissible values for A specific field On the approval source details form.
POST
Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.
POST
Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.