Request Method Types
The following table describes REST mapping of method types to operations:
Method Type |
Operations |
GET |
Get all resources (Search), Get a resource by its ID, Get a resource version information |
POST |
Create a new resource |
PUT |
Update a resource, Other non CRUD operations |
DELETE |
Delete a resource |
|
PATCH |
Update any attribute subset. Only the attributes sent in the request are affected. |
|
The following table describes the request headers:
Header | Values | Description |
Accept | Application/XML or Application/JSON | Indicates to the server what media type(s) this client is willing to accept |
Authorization | Basic authorization using username and password (per RFC 2617) | Identifies the authorized user making this request |
Content-Type | Application/XML or Application/JSON | Describes the representation and syntax of the request message body. |
ERS-Media-Type | Consists Of: resource-namespace.resource-name.resource-version | This Header is not mandatory. It describes ERS resource version. If not sent from client, the server will assume latest version. |
In the ERS, resource representations and request bodies are normally encoded in XML(as specified in RFC4267). Each type of resource has its own media-type, which matches the pattern xxx.yyy.version , where "xxx" represents the namespace, "yyy" the resource and version specifies the resource version used by the client. (RFC 3023) Example: MediaType for Internal User resource with schema version 1.0:
identity.internaluser.1.0
|
---|
The ERS MUST provide representations of all resources available in XML or JSON. Whenever the requested media type is not supported by the Cisco ISE Server, status 415 will be returned with a list of causes such as "Resource version is no longer supported".
The following example demonstrates a request sent using Linux curl command to fetch an internal user resource by its ID. The ACCEPT header is required by any request type and is added to the curl command using the -H option.
curl --tlsv1.1 -v -k -H 'ACCEPT: application/json' -H 'ERS-Media-Type: identity.internaluser.1.2' 'https://ers:password@10.56.52.187:9060/ers/config/internaluser' |