API calls
Each Web API Service Agent call must be constructed with the expected HTTP headers. The majority of calls are HTTP GET requests and require specific HTTP headers.
The expected HTTP headers are indicated in the following tables. Incorrectly constructed requests are aborted and returned with an HTTP error code. The exposed calls have differing security levels.
The first table below provides an overview of all supported calls, requirements, and properties. The second table shows the supported calls and their required HTTP headers.
Properties and Requirements
| Call | Group | HTTP Type | Auth. Req. | Response Type |
|---|---|---|---|---|
| PingUTC | Public | GET | String-JSON Format | |
| ServerVersion | Public | GET | String-JSON Format | |
| RegisterDeviceID | Device | GET | ● | String-JSON Format |
| GetUniqueDevice ID | Device | GET | ● | String-JSON Format |
| GetSpecifiedFile | Message | GET | ● | HTTP Response |
| SendFileToServer | Message | POST | ● | HTTP Response |
| LogLocation | Message | GET | ● | HTTP Response |
| CallFunction | Function | GET | ● | HTTP Response |
| RunApplication | Function | GET | ● | String-JSON Format |
| GetFunctionDef | Function | GET | ● | String-JSON Format |
| SQLTransaction | SQL | GET | ● | String-JSON Format |
| GetTableStructure | DeviceDBSync | GET | ● | String-JSON Format |
| GetPartialUpdate | DeviceDBSync | GET | ● | String-JSON Format |
| GetFullUpdate | DeviceDBSync | GET | ● | HTTP Response |
| GetDBSyncStatus | DeviceDBSync | GET | ● | String-JSON Format |
| SendNotification | Notification | GET | ● | HTTP Response |
| MarkStatus Change Notification | Notification | GET | ● | HTTP Response |
| CheckInItem | DevStudio | POST | ● | HTTP Response |
| CheckInAllItems | DevStudio | POST | ● | HTTP Response |
| CheckOutItem | DevStudio | POST | ● | HTTP Response |
| CheckOutAllItems | DevStudio | POST | ● | HTTP Response |
| GetAppItem RefApps | DevStudio | GET | ● | HTTP Response |
| GetAppItem RefItems | DevStudio | GET | ● | HTTP Response |
| GetProject Components | DevStudio | GET | ● | HTTP Response |
| GetPromoPkg Bundle | DevStudio | GET | ● | HTTP Response |
| PublishApp | DevStudio | POST | ● | HTTP Response |
| PublishAll ProjectApps | DevStudio | POST | ● | HTTP Response |
| PromoteApp | DevStudio | POST | ● | HTTP Response |
| UploadProject | DevStudio | POST | ● | HTTP Response |
| UploadPromo Package | DevStudio | POST | ● | HTTP Response |
Required HTTP Headers and parameters
| Call | deviceid | access_token | Input parameters |
|---|---|---|---|
| PingUTC | |||
| ServerVersion | |||
| RegisterDeviceID | ● | ● | |
| GetUnique DeviceID | ● | ● | ● |
| GetSpecifiedFile | ● | ● | ● |
| SendFileToServer | ● | ● | ● |
| LogLocation | ● | ● | ● |
| CallFunction | ● | ● | ● |
| RunApplication | ● | ● | ● |
| GetFunctionDef | ● | ● | ● |
| SQLTransaction | ● | ● | ● |
| GetTableStructure | ● | ● | ● |
| GetPartialUpdate | ● | ● | ● |
| GetFullUpdate | ● | ● | ● |
| GetDBSyncStatus | ● | ● | ● |
| SendNotification | ● | ● | ● |
| MarkStatus Change Notification | ● | ● | ● |
| CheckInItem | ● | ● | |
| CheckInAllItems | ● | ● | |
| CheckOutItem | ● | ● | |
| CheckOutAllItems | ● | ● | |
| GetAppItem RefApps | ● | ● | |
| GetAppItem RefItems | ● | ● | |
| GetProject Components | ● | ● | |
| GetPromoPkg Bundle | ● | ● | |
| PublishApp | ● | ● | |
| PublishAll ProjectApps | ● | ● | |
| PromoteApp | ● | ● | |
| UploadProject | ● | ● | |
| UploadPromo Package | ● | ● |
Requests are categorized both by access requirements, and by function.
-
PingUTC and ServerVersion calls do not require HTTP headers to be invoked. These are denoted as "Public" due to their low risk/low requirement properties.
-
Token and revoke oauth2 calls are similarly grouped, since they require a ClientID (encoded in Basic Authentication), and share the same URS route.
-
For example, the following URI uses standard HTTP. The URI is not case sensitive.
"https://test.dsiglobal.com:8080/api/v1/serverversion"
Loading...
There was a problem loading this topic