JsonSchemaFile

Schema Definition

This is the schema definition for the Schema File locator resource.

Properties

PropertyTypeNullableRequiredPermissionDescription
@odata.contextStringread-onlyThe OData description of a payload.
Format: uri
@odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
@odata.typeStringread-onlyThe type of a resource.
Actions {Objectread-writeThe available actions for this resource.
    Oem { }Objectread-writeThe available OEM specific actions for this resource.
}
DescriptionStringYesread-onlyProvides a description of this resource and is used for commonality in the schema definitions.
IdStringGETread-onlyUniquely identifies the resource within the collection of like resources.
Languages [ ]Array[String]GETread-onlyLanguage codes for the schemas available.
Languages@odata.countInt32read-onlyThe number of items in a collection.
Location [ {Array[Object]GETread-writeLocation information for this schema file.
    LanguageStringread-onlyThe language code for the file the schema is in.
    UriStringread-onlyLink to locally available URI for schema.
Format: uri
} ]
Location@odata.countInt32read-onlyThe number of items in a collection.
NameStringGETread-onlyThe name of the resource or array element.
Oem { }Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
SchemaStringGETread-onlyThe @odata.type name this schema describes.

Operations

GET

Request

GET /redfish/v1/JsonSchemas/JsonSchemaFile1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/JsonSchemas/JsonSchemaFile1",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "Description": "String",
    "Id": "String",
    "Languages": [ "String" ],
    "Languages@odata.count": 1,
    "Location": [{
        "Language": "String",
        "Uri": "uri"
    }]
    "Location@odata.count": 1,
    "Name": "String",
    "Oem": { },
    "Schema": "String"
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

DELETE

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed