API Guide

Examples

The following table provides usage examples for the HTTP supported methods such as GET, POST, PATCH, and DELETE:

GET

Table 13. GET Usage Examples

URL

/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces

Output

{

"@odata.context": "/redfish/v1/$metadata#Managers/Members/iDRAC.Embedded.1/

SerialInterfaces/$entity",

"@odata.count": 1,

"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces",

"@odata.type": "#SerialInterface.1.0.0.SerialInterfaceCollection",

"Description": "Collection of Serial Interfaces for this System",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces/

iDRAC.Embedded.1#Serial.1"

}

"Name": "Serial Interface Collection"

}

DELETE

Table 14. DELETE Usage Examples

URL

/redfish/v1/EventService/Subscriptions/<SubscriptionId>

Output

200 Ok

{

"INFO": "<SubscriptionId> subscription deleted successfully"

}

PATCH

Table 15. PATCH Usage Examples

URL

/redfish/v1/Managers/iDRAC.Embedded.1/Accounts/<Account-id>

Input

{"Password": "123","UserName": "reader"}

Output

{

"Success": {

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "Ok"

}