Resource URL

Get the details of an existing Entity

GET /saas/v3/Entity/${EntityID}

Create a new Entity

POST /saas/v3/Entity

Create a new Entity

PUT /saas/v3/Entity/${EntityID}

Delete an existing Entity

DELETE /saas/v3/Entity/${EntityID}

API Specific Parameters

Parameter	Description
`${EntityId}`	The identifier for the entity to be obtained, created, or deleted.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

API Specifics

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 Entity Object.

Otherwise, the response body will contains details regarding the error.

Create a new Entity

Create a new ServiceMobility entity. The system will automatically assign an Entity ID for the object.

URL

POST /saas/v3/Entity

HTTP Request Body

The HTTP request body must contain a valid Entity Object.

HTTP Response Body

On success, an HTTP response code of 201 will be returned, and the URL of the newly created entity will be returned in the standard HTTP response headers.

Otherwise, the response body will contains details regarding the reason why the entity was not created.

Create a new Entity

Create a new ServiceMobility entity. The specified Entity ID must not exist.

URL

PUT /saas/v3/Entity/${EntityID}

HTTP Request Body

The HTTP request body must contain a valid 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.

Delete an existing Entity

Delete an existing ServiceMobility entity. The specified Entity ID must exist.

URL

DELETE /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. The system will return HTTP response code 410 in case of non-existent Entity Object.

Browser not supported