Get the state Of A field In the specified schema

Get the state of a field in the specified schema.

Request

URI

POST

https://{api_host}/composition-service/api/data-service/schema/{classId}/instances/{id}/update

COPY

Path Parameters

string

classId

Required

The class of object.

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

'Success' with the data

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

Description

Request

Path Parameters

Request Body

Response

200 Response Body

Api Operations