Skip to main content

OData Support

OData Properties are used to provide information about resources, such as ID, type, context, etc.accessed by a URI. The following are the properties used in Redfish.

Table 1. OData Attributes

Name

Type

Read Only

Description

@odata.context

String

True

The value of this property shall be the context URL that describes the resource according to OData-Protocol and shall be of the form defined in the Redfish specification.

@odata.id

String

True

The value of this property shall be the unique identifier for the resource, and it shall be of the form defined in the Redfish specification.

@odata.type

String

True

The value of this property shall be an absolute URL that specifies the type of the resource and it shall be of the form defined in the Redfish specification. The type values for each Redfish Entity give the schema it follows and is mentioned in Redfish API List under the Schema column.

@odata.etag

ETags provide the ability to conditionally retrieve or update a resource. This value gives the timestamp at which the resource properties have been initialized or modified.

@odata.nextLink

String

True

Format: uri-reference

The URI to the resource containing the next set of partial members.

Normal Rule

It is applicable only for collections and can display only 50 entries at a time. If the entries are less than 50, then Members@odata.nextLink property will not be displayed. For example, if only 30 logs, Members@odata.nextLink will not be shown. If it has 63 logs, then Members@odata.nextLink will show.

Note
These ODATA properties should be present in each JSON response for all Redfish URI's mentioned in the document.

  1. From RTP1.7 onwards, AMI's redfish implementation supports strong ETag support.

  2. If a client calls PUT or PATCH to update a resource, it should include an ETag from a previous GET in the HTTP If-Match or If-None-Match header.

  3. If a service supports the return of the ETag header on a resource, the service may respond with HTTP 428 status code if the If-Match or If-None-Match header is missing from the PUT or PATCH request for the same resource, as specified in RFC6585.

  4. The format of the ETag header is: ETag: "<string>"

  5. In addition to the return of the ETag property on each resource, a Redfish Service should return the ETag header on:

    • A client PUT, POST, or PATCH operation

    • A GET operation for an individual resource