Exago Logo
Search
Generic filters
Exact matches only

List of REST Endpoints

The following REST Web Service API endpoint paths are available. All calls require the following headers:

Content-Type: application/json
Accept: application/json
Authorization: {type} {authstring}

For more information, review REST — Introduction

/rest/Batch v2018.1.1+

  • POST

/rest/Sessions

  • POST
  • GET

/rest/Sessions/{sid}

  • GET
  • PATCH
  • DELETE

All of the following calls require the Session ID URL parameter: sid={sid}

Example

GET /rest/Settings?sid={sid}

/rest/DataSources

  • GET

/rest/DataSources/{Id}

  • POST
  • GET
  • PATCH

/rest/Entities

  • POST
  • GET

/rest/Entities/{Id}

  • GET
  • PATCH
  • DELETE

/rest/Entities/{Id}/Fields

  • GET

/rest/Entities/{Id}/Fields/{Field Id}

  • GET
  • PATCH
  • POST v2019.1.13+

/rest/Folders/{Name}

  • POST
  • DELETE

/rest/Folders/Rename

  • POST

/rest/Functions

  • POST
  • GET

/rest/Functions/{Id}

  • GET
  • PATCH
  • DELETE

/rest/Joins

  • POST
  • GET

/rest/Joins/{Id}

  • GET
  • PATCH
  • DELETE

/rest/Parameters

  • POST
  • GET

/rest/Parameters/{Id}

  • GET
  • PATCH
  • DELETE

/rest/Reports/List

  • GET

/rest/Reports/Execute/{Type}

  • POST

/rest/Roles

  • POST
  • GET

/rest/Roles/{Id}

  • GET
  • PATCH

/rest/Roles/{Id}/DataObjectRows

  • GET
  • PATCH

/rest/Roles/{Id}/Entities

  • GET
  • PATCH

/rest/Roles/{Id}/Folders

  • GET
  • PATCH

/rest/Roles/{Id}/Settings

  • GET
  • PATCH

/rest/SchedulesV2v2019.2.29+v2020.1.3+v2021.1.1+

  • GET
  • POST

/rest/SchedulesV2/{ScheduleID}v2019.2.29+v2020.1.3+v2021.1.1+

  • GET
  • PATCH
  • DELETE

/rest/SchedulesV2/Flushv2019.2.29+v2020.1.3+v2021.1.1+

  • POST

/rest/SchedulesV2/{ScheduleID}/Filtersv2019.2.29+v2020.1.3+v2021.1.1+

  • GET
  • PATCH

/rest/SchedulesV2/{ScheduleID}/Parametersv2019.2.29+v2020.1.3+v2021.1.1+

  • GET
  • PATCH

/rest/ServerEvents

  • GET

/rest/ServerEvents/{Id}

  • GET
  • DELETE

/rest/Settings

  • GET
  • PATCH

/rest/StorageMgmt v2020.1+

  • GET
  • PUT
  • PATCH
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Tags:
Table of Contents