Get the schema for the specified object type

Get the schema for the specified object type

This returns the schema of a particular type within a class of object.

Request
URI
GET
https://{api_host}/endpoint-configuration-service/api/data-service/schema/{classId}/types/{typeFilter}
COPY
Path Parameters
string
classId
Required

The class of object to retrieve the schema for.

string
typeFilter
Required

A type filter defining the specific subtype that owns the field.


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