Reference Guide

SupportAssist Enterprise
7 REST API Guide – SupportAssist Enterprise
1.5 Resource Operations
The standard HTTP methods are used for performing create, retrieve, update, and delete operations on
resources. The mapping of the HTTP methods to operational semantics is described in the following table.
HTTP method
Description
GET
Used to retrieve the resource representation. This method does not modify
the resource across repeated invocations. The query parameters are
appended to the URI to appropriately filter the resource instances.
POST
Used to create a new instance of a resource or append to the existing
resource reference.
PUT
Used to update a specific instance or create a specific resource instance
with a specific identifier.
DELETE
Used to remove a specific resource. If the resource does not exist, success
is returned.
1.6 Connectivity Considerations
• REST API calls to SupportAssist Enterprise are available only on the SSL-enabled port.
• The REST API access token issued by SupportAssist Enterprise would be valid only for 30 mins.
• The REST API refresh token issued by SupportAssist Enterprise would be valid only for 24 hours.
• All the tokens are mapped with the IP address; if the IP address changes, the tokens would be discarded.
• By default, the REST API functionality is disabled.
• REST API is enabled only if the registration of SupportAssist Enterprise is complete.
• The request URLs are available only on the respective HTTP methods.
Note: Transport Layer Security (TLS) 1.2 must be enabled on the web browser.
1.7 Request Headers
The request header represents headers in the client HTTPS request that are used to communicate client
preferences to the service end-point. The service will indicate the supported preference in the response header.
The following table includes a few examples of request headers. For an extensive list of request headers, see List
of HTTP header fields.
Request Header
Description
Example
Accept
Format of the data requested by the
client. This could be one or more
comma-separated values.
Accept: application/json
Authorization
The bearer token is a cryptic string,
generated by the server in response to a
login request. The client must send this
token in the Authorization header
when making requests to protected
resources.
Authorization: Bearer <token>
Content-Type
The Content-Type header field is used to
specify the nature of the data in the body
of an entity.
Content-Type: application/json