Progress® Telerik® Reporting R2 2017

REST API Reference

The four main HTTP methods (GET, PUT, POST, and DELETE) are mapped to CRUD operations as follows:

  • GET retrieves the representation of the resource at a specified URI. GET have no side effects on the server.

  • PUT updates a resource at a specified URI.

  • POST creates a new resource. The server assigns the ID for the new object and returns this ID as part of the response message.

  • DELETE deletes a resource at a specified URI.

The API represent resources as hierarchical URIs in order to force the clients to use certain request sequence.

The reports API exposes following methods:

Action

HTTP method

Relative URI

Register Client

POST

/api/reports/clients

Unregister Client

DELETE

/api/reports/clients/{clientId}

Get Report Parameters

POST

/api/reports/clients/{clientId}/parameters

Create Report Instance

POST

/api/reports/clients/{clientId}/instances

Destroy Report Instance

DELETE

/api/reports/clients/{clientId}/instances/{instanceId}

Create Document

POST

/api/reports/clients/{clientId}/instances/{instanceId}/documents

Get Document Info

GET

/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}/info

Get Document

GET

/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}

Get Document Page

GET

/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}/pages/{pageNumber}

Get Document Resource

GET

/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}/resources/{resourceId}

Apply Interactive Action on Document

PUT

/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}/actions/{actionId}

Destroy Document

DELETE

/api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}

Get Available Document Formats

GET

/api/reports/formats