EMS API Resource
Go Up to EMS Administrative API
The API resource offers documentation of the EMS API in YAML and JSON formats.
To access the API documentation:
- YAML format:
localhost:8080/api/apidoc.yaml
- JSON format:
localhost:8080/api/apidoc.json
Contents
API Resource Endpoints
API Resource exposes the following EMS Resource Endpoints:
Endpoint Method Name | Resource Suffix | HTTP Request Type | Use | Path |
---|---|---|---|---|
API |
-- |
HTTP GET |
To retrieve all the API EndPoints. |
|
GetAPIYAMLFormat EndPoint |
|
HTTP GET |
To retrieve an EndPoint for the API EndPoints. |
|
GetAPIYAMLFormat |
|
HTTP GET |
To get the API documentation in YAML format. |
|
GetAPIJSONFormat |
|
HTTP GET |
To get the API documentation in JSON format. |
|
API Endpoint
Returns all the API Endpoints.
If successful, the response from the EMS server provides a list of the possible API calls:
[{"apicall":"apidoc.yaml"},{"apicall":"apidoc.json"}]
GetAPIYAMLFormat EndPoint
Returns the API documentation for the specified resource in YAML format.
If successful, the response from the EMS server provides the API documentation for the selected resource in YAML format.
Example Response
This is the response for requesting the API documentation of the Version resource.
localhost:8080/api/version/apidoc.yaml
---
swagger: '2.0'
info:
version: 0.0.0
title: EMS API Documentation
description: |
Enterprise Mobility Services API
[Learn about EMS](https://www.embarcadero.com/products/rad-studio/enterprise-mobility-services)
EMS (Enterprise Mobility Services) offers a Mobile Enterprise Application Platform (MEAP)
TurnKey Middleware for Interconnected Distributed Apps
host: localhost:8080
basePath: /
schemes:
- http
paths:
/version:
get:
tags:
- Version
summary: "Get version"
description: |
Used to retrieve the `Version` of the EMS Server.
operationId: GetVersion
produces:
- application/json
parameters:
- in: header
description: Header used by the EMS server
name: X-Embarcadero-Application-Id
type: string
- in: header
description: Header used by the EMS server
name: X-Embarcadero-App-Secret
type: string
- in: header
description: Header used by the EMS server
name: X-Embarcadero-Master-Secret
type: string
responses:
200:
description: Ok. Provides the current version of the EMS Server
schema:
$ref: '#/definitions/versionObject'
definitions:
#
versionObject:
type: object
properties:
version:
type: string
server:
type: string
GetAPIYAMLFormat
Returns the whole API documentation in YAML format.
GetAPIJSONFormat
Returns the whole API documentation in JSON format.