Service Application Engine
A Collaborative Computing Platform for Cloud and Web
 
REST Application Programming Interface
Release 3.8

Table of Contents

Table of Contents. 3

Document Conventions. 4

REST API Overview.. 5

Representational State Transfer (REST) 5

REST Architecture. 5

REST Interface Principles. 7

RESTful Web Services and API 8

Using the REST API 9

Accessing Service Engine Resources. 9

Application Engine Clients. 13

Security Considerations. 13

Authentication Framework. 13

Basic Authentication. 13

Digest Authentication. 13

Delegated Authorization. 13

SSL Encryption. 13

RESTful API Guide. 18

Authorize

Unauthorize

Invoke Service. 18

Raise Event 21

Raise Request 23

Receive Event 26

Receive Event with NoWait 28

Querying Service Configuration. 29

Get Service List 29

Get Service Reference. 29

Get Service Actionable Events. 30

Get Service Event Handlers. 30

Get Service Event Handler. 31

Get Service Configuration Object 31

Get Service Request Object 32

Get Service Response Object 33

Get Service Request Event 34

Get Service Response Event 35

Browsing the Entity Repository