RESTful Commands

The Rest API Framework supports the following HTTP commands:

  • GET
  • POST
  • PUT
  • DELETE

The functionality of these commands varies according to the type of object to which it is applied and the actions that are associated with that object. The following table shows example resources and illustrates how these commands are used:

Object Example Commands Result
Service Document
GET /
Returns all accessible URLs.
Query
GET/<incidents>
Returns all Incidents
GET/<incidents>/<id>
Returns an Incident with the specified ID.
GET/<incidents>?query=<url-encoded-string>&sort=number:ascending
Returns a subset of Incidents as specified by the URL encoded string, in ascending order.
Resources with Actions
POST /<incidents>
Creates an Incident
PUT /<incidents>/<id>
Updates an specific Incident
POST /<incidents>/<id>/action/<action>
Invokes a customized action on a specific Incident