Dell Unity™ Family Unisphere® Management REST API Programmer's Guide

Performing an instance-level resource-specific action

Some resource types have operations that let you perform resource-specific actions on resource instances beyond the standard delete and modify actions. For example, you can use the ldapServer resource type's Verify operation to verify connectivity between the system and a specified LDAP server.

To perform a resource-specific action on a resource instance, use the following request components:

Headers

For operations without request arguments:

Accept: application/json 
X-EMC-REST-CLIENT: true 
EMC-CSRF-TOKEN: <token>

For operations with request arguments:

Accept: application/json
Content-Type: application/json
X-EMC-REST-CLIENT: true
EMC-CSRF-TOKEN: <token>

Operation

POST

URI pattern

For all resource types that support instance-level resource-specific actions:

/api/instances/<resourceType>/<id>/action/<actionName>

For applicable resource types that support instance-level resource-specific actions:

 /api/instances/<resourceType>/name:<assignedName>/action/<actionName> 
		  

where:

• <resourceType> is the resource type of the instance for which you want to perform an action.
• <id> is the unique identifier of the instance for which you want to perform an action.
• <actionName> is the action you want to perform.
• <assignedName> is the user-assigned name of the instance for which you want to perform an action.

For additional functionality, such as making the request an asynchronous request and localizing response messages, you can append one or more request parameters to the URI. To see if a resource type can be identified by the user-assigned name, see the individual resource type topics in the Unisphere Management API Reference Guide.

Body

For operations without request arguments:

Empty.

For operations with input data:

{
   "argument1":<value>,
   "argument2":<value>,
   .
   .
   .
}

where the comma-separated list contains all required arguments and any optional arguments. Use double quotes around a string, dateTime, or IPAddress value.

The success response for a class-level resource-specific action differs depending on whether the action performed has output data:

• For actions that do not have output data, a successful request returns a 204 No Content HTTP status code and an empty response body.
• For actions that have output data, a successful request returns a 200 OK HTTP status code, and the body will have the specified out attributes in an instance resource response body.

If the request does not succeed, the server returns a 4nn or 5nn HTTP status code in the response header and a message entity in the response body.