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/cafe-forms/forms/{formId}/{instanceId}/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 Policy Operations
POST
Creates A new approval policy.
DELETE
Deletes An approval policy.
GET
Lists the approval policies.
GET
Retrieve A form.
POST
Retrieves A paged list Of permissible values that can Be assigned To A specific field.
GET
Retrieves An approval policy.
POST
Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.
PUT
Updates An Approval Policy while ignoring few Of the validations. This Is An internal API which Is used for upgrade.
PUT
Updates An approval policy.