<span id="progress"></span>Long-running operations that cannot complete within a single request will instead return the location of a resource for tracking progress on that operation. The typical client work flow is:

−

Long running operations that cannot complete within a single request will instead return the location of a resource for tracking progress on that operation. The typical client work flow is:

+

# Client sends request to start operation. The <tt>Location</tt> header in the response indicates the location of a progress resource. The response code is 202 Accepted, which helps the client distinguish long running operations from operations that complete within a single method invocation.

# Client sends request to start operation. The <tt>Location</tt> header in the response indicates the location of a progress resource. The response code is 202 Accepted, which helps the client distinguish long running operations from operations that complete within a single method invocation.

−

# Client periodically checks state of progress resource.

+

# Client periodically checks state of progress resource. The response code will be 200 ok, but the Result (see below) will be undefined.

−

# When long running task completes, progress resource includes a link to a resource representing the completed operation.

+

# When long running task completes, progress resource includes a link to a resource representing the completed operation. Or maybe the Result is just what you want in the first place and the Location is somewhat related to something.

A progress resource has the following attributes:

A progress resource has the following attributes:

Line 100:

Line 99:

|-

|-

| Result

| Result

−

| Once the operation has completed, this is a status object describing the operation result. The status format is described in [[Orion/Server_API#Exception_Handling]]. While the operation is running, this property is undefined

+

| Once the operation has completed, this is a status object describing the operation result. Looks like Result.JsonData is what the original GET would have supplied if the task was not needed. While the operation is running, this property is undefined

| No

| No

|}

|}

== Resource locations ==

== Resource locations ==

−

<div id="location"></div>

+

<span id="location"></span>All server API resources have a "Location" attribute. This attribute has the following properties:

−

All server API resources have a "Location" attribute. This attribute has the following properties:

+

* When a resource is created, the POST operation that created it will return the location property both as an HTTP header, and in the response representation (attribute "Location" in JSON representations).

* When a resource is created, the POST operation that created it will return the location property both as an HTTP header, and in the response representation (attribute "Location" in JSON representations).

* Invoking GET on the resource location will return a representation of the resource.

* Invoking GET on the resource location will return a representation of the resource.

Revision as of 14:57, 30 October 2013

Contents

Overview

The Server API in Orion is not a single monolithic API. Rather Orion defines a series of distinct, standalone APIs for various kinds of tasks. A given server may implement one or more of these APIs, but not necessarily all of them.

All Orion server APIs have common design principles:

They are built on simple HTTP GET/PUT/POST/DELETE verbs with standard HTTP semantics.

GET operations are always non-destructive read-only operations

GET/PUT/DELETE are always idempotent, meaning the same operation can be safely repeated multiple times.

The relationship between resources is specified in links within response representations, rather than being inferred from the URI structure. For example a file's parent is specified by the Parent element in the response object, rather than by removing the last segment of the file's URI.

The default representation for request and response bodies is JSON, although a server may provide additional representations based on content type negotiation.

Version header

All server API requests must include the Orion-Version header. This allows the server to identify what protocol version is being used by the client, and produce appropriate responses for that version of client. This also allows a server to support other protocols for accessing the same resources (such as WebDAV). When the version header is absent, by default all modifying (PUT, POST) operations will fail. GET operations may return a reasonable default HTML response suitable for display in a browser.

Exception handling

When using the Orion Server API, errors are conveyed back to the client via a non-OK error code (4xx or 5xx). The response body contains a representation of a more detailed error status from the server.

Currently only a JSON representation is supported, with the following attributes:

Property

Value

Required

HttpCode

Integer HTTP response code

Yes

Code

Application specific integer response code

No

Severity

One of "Error", "Warning", "Info", "Cancel", or "Ok"

Yes

Message

A high level error message

Yes

DetailedMessage

Detailed error message

No

Cause

JSON object representation of another status that is the cause of this status (used for exception chaining)

No

SeeAlso

URL of a page for more information on how to resolve the error

No

Example:

{"Severity":"Error","Code":0,"Message":"This is the error message","DetailedMessage":"This is the exception message","HttpCode":500}

Progress reporting

Long-running operations that cannot complete within a single request will instead return the location of a resource for tracking progress on that operation. The typical client work flow is:

Client sends request to start operation. The Location header in the response indicates the location of a progress resource. The response code is 202 Accepted, which helps the client distinguish long running operations from operations that complete within a single method invocation.

Client periodically checks state of progress resource. The response code will be 200 ok, but the Result (see below) will be undefined.

When long running task completes, progress resource includes a link to a resource representing the completed operation. Or maybe the Result is just what you want in the first place and the Location is somewhat related to something.

A progress resource has the following attributes:

Property

Value

Required

Id

String identifier of the long running operation

Yes

Message

A message indicating the current operation state

Yes

Running

A boolean indicating whether the operation has completed

Yes

PercentComplete

An integer between 0 and 100 indicating what percentage of the operation has completed

Yes

Location

Once the operation has completed, this is the location of the operation result. While the operation is running this is the location of the progress resource itself. A client can keep getting this location until it becomes the result they are looking for.

No

Result

Once the operation has completed, this is a status object describing the operation result. Looks like Result.JsonData is what the original GET would have supplied if the task was not needed. While the operation is running, this property is undefined

No

Resource locations

All server API resources have a "Location" attribute. This attribute has the following properties:

When a resource is created, the POST operation that created it will return the location property both as an HTTP header, and in the response representation (attribute "Location" in JSON representations).

Invoking GET on the resource location will return a representation of the resource.

Invoking PUT on the location will modify or replace the contents of the resource.