Retrieves the metadata Of multiple dynamic elements In single call. It combines the retrieval Of element's ElementState and the list Of permissible values for each element.

Retrieves the metadata Of multiple dynamic elements In single call. It combines the retrieval Of element's ElementState and the list Of permissible values for each element.

Retrieves the metadata of multiple dynamic elements in single call. It combines the retrieval of element's ElementState and the list of permissible values for each element.

Request
URI
POST
https://{api_host}/work-item-service/api/workitems/{id}/form/update
COPY
Path Parameters
string
Required
Request Body
batchElementUpdateRequest of type(s) application/json
Required 
{
    "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
Work Item Operations
POST
Cancel the specified WorkItem.
POST
Complete A WorkItem.
POST
Completes the WorkItem If It Is still active.
POST
Create A new WorkItem for the given service.
PUT
Create A set Of WorkItems
DELETE
Delete the WorkItem corresponding To the given id.
GET
Retrieve A list Of WorkItem.
GET
Retrieve A list Of WorkItem.
POST
Retrieve A set Of form data for the specified workItem and formElement.
GET
Retrieve the details Of the given WorkItem.
GET
Retrieve the WorkItem Form from for the selected WorkItem from the corresponding Service Provider.
POST
Retrieves the metadata Of multiple dynamic elements In single call. It combines the retrieval Of element's ElementState and the list Of permissible values for each element.
PUT
Update the WorkItem which corresponds To the given Id.