Documentation

Querying the Archive Address of a Schema File

Function

This interface is used to query the archive address of a schema file on the server.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/JSONSchemas/<member_id>

Request header:

X-Auth-Token: auth_value

Request message body: None

URL Parameters

Table 1 URL parameters

Parameter

Mandatory/Optional

Parameter Description

Value

<member_id>

Mandatory

Schema file name.

Name of the schema file to be queried. The value range is included in the API output in Querying Schema Files of All Resources.

Usage Guidelines

None

Example

Request:

GET https://10.10.10.10/redfish/v1/JSONSchemas/Session.v1_4_0

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#JsonSchemasFile/Members/$entity",
    "@odata.id": "/redfish/v1/JSONSchemas/Session.v1_4_0",
    "@odata.type": "#JsonSchemaFile.v1_1_4.JsonSchemaFile",
    "Id": "Session.v1_4_0",
    "Description": "Session Schema File Location",
    "Name": "Session Schema File",
    "Languages": [
        "en"
    ],
    "Schema": "#Session.v1_4_0.Session",
    "Location": [
        {
            "Language": "en",
            "PublicationUri": "http://redfish.dmtf.org/schemas/v1/Session.v1_4_0.json"
        }
    ]
}

Response code: 200

Output Description

Table 2 Operation output description

Field

Type

Description

@odata.context

Character string

OData description of the message archiving resource model.

@odata.id

Character string

Path to access the message archiving resource node.

@odata.type

Character string

Message archiving resource type.

Id

Character string

Message archiving resource ID.

Name

Character string

Name of an archived resource.

Description

Character string

Description of an archived resource.

Languages

Array

Language code of the schemas available.

Schema

Character string

Name of an archived file.

Location

List

Path of an archived file.

Language

Character string

Programming language of a schema file.

(Optional) Uri

Character string

Schema file URI that can be accessed locally.

(Optional) PublicationUri

Character string

Schema file URI that can be publicly accessed on the Redfish official website.