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}/software-service/api/data-service/schema/{classId}/instances/{id}

COPY

Path Parameters

string

classId

Required

The class of object to retrieve the schema for.

string

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

Description

Request

Path Parameters

Response

200 Response Body

Api Operations

POST