Get the schema for the specified object

Get the schema for the specified object

This returns the schema of a particular type adjusted to the state of a specific instance..

Request
URI
GET
https://{api_host}/composition-service/api/data-service/schema/{classId}/instances/{id}
COPY
Path Parameters
string
classId
Required

The class of object to retrieve the schema for.

string
id
Required

The unique identifier of an instance of the object.

Responses
200

'Success' with the data

Returns Schema of type(s) */* 
{
    "fields": [
        {
            "permissibleValues": {
                "customAllowed": false
            },
            "displayAdvice": "string",
            "columns": [
                "Field Object"
            ],
            "dataType": {
                "typeId": "string"
            },
            "isMultiValued": false,
            "description": "string",
            "orderIndex": 0,
            "id": "string",
            "label": "string",
            "state": {
                "dependencies": [
                    "string"
                ],
                "facets": [
                    {}
                ]
            }
        }
    ]
}
array of Field
fields
Optional

fields


On This Page
Api Operations
POST
Get A set Of data for the specified object
POST
Get the permissible values Of A field In the specified schema
POST
Get the permissible values Of A field In the specified schema
POST
Get the permissible values Of A field In the specified schema
GET
Get the schema for the specified object
GET
Get the schema for the specified object class
GET
Get the schema for the specified object type
POST
Get the state Of A field In the specified schema
POST
Get the state Of A field In the specified schema
POST
Get the state Of A field In the specified schema
POST
Retrieves the list Of possible values for A given type Of object
POST
Retrieves the list Of possible values for A given type Of object