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}/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
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": [
                    {
                        "value": {}
                    }
                ]
            }
        }
    ]
}
array of object
fields
Optional

fields


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/software-service/api/data-service/schema/{classId}/instances/{id}
On This Page
Api Operations
GET
Get SoftwareRequestState
POST
Get A set Of data for the specified object
GET
Get the schema for the specified object
GET
Get ScriptTypes
POST
Get the state Of A field In the specified schema
POST
Get the permissible values Of A field In the specified schema
PUT
Update SoftwareComponentType PublishStatus
GET
Get ScriptType for file extension
POST
Retrieves the list Of possible values for A given type Of object
GET
Get SoftwareResourceRequest
GET
Get ScriptType
POST
Get the state Of A field In the specified schema
GET
Get the schema for the specified object type
POST
Get the permissible values Of A field In the specified schema
POST
Get the state 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 class
POST
Create SoftwareComponentType
GET
Get SoftwareComponentTypeInfos
POST
Retrieves the list Of possible values for A given type Of object
GET
Get SoftwareComponentType
DELETE
Delete SoftwareComponentType
PUT
Update SoftwareComponentType