Resource URL
Create a new Entity
PUT /saas/v3/Entity/${EntityID}
Get the details of an existing Entity
GET /saas/v3/Entity/${EntityID}
API Specific Parameters
| Parameter | Description |
|---|---|
${EntityId} | The identifier for the new entity to be created. |
HTTP Headers
This API uses the default ServiceMobility HTTP Headers.
API Specifics
Create a new Entity
Create a new ServiceMobility entity. The specified Entity ID must not exist.
URL
POST /saas/v3/Entity/${EntityID}
HTTP Request Body
The HTTP request body must contain a valid REST Object Definitions Configuration Related Objects Entity Object.
HTTP Response Body
On success, an HTTP response code of 200 will be returned, and the body will contain the ID of the newly created entity.
Otherwise, the response body will contains details regarding the reason why the entity was not created.
Get the details of an existing Entity
Get the details of an existing ServiceMobility entity. The specified Entity ID must exist.
URL
GET /saas/v3/Entity/${EntityID}
HTTP Request Body
This request does not require a request body.
HTTP Response Body
On success, an HTTP response code of 200 will be returned, and the body will contain an REST Object Definitions Configuration Related Objects Entity Object.
Otherwise, the response body will contains details regarding the error.