Entity System Configuration REST API
- Mickey Bushman
- Jason Andrew
Resource URL
Create or update system configuration for a specific entity
POST /seiapi/v3/SysConfig/${System}
Retrieve system configuration for a specific entity
GET /seiapi/v3/SysConfig/${System}
API Specific Parameters
| Parameter | Description |
|---|---|
${System} | The system identifier for target system. Valid values are:
|
HTTP Headers
| Header | Description |
|---|---|
| Content-Type | Specifies the body content type and must be set to application/json |
| x-access-token | Must contain a valid JSON Web Token (JWT). |
Create or update system configuration for a specific entity
This REST API will modify or update default system configuration values for a specific entity in the system. If configuration settings were added then the HTTP response code of 200 will be returned. Otherwise, on error, the appropriate HTTP response code will be returned along with details of the error in the response body.
URL
POST /seiapi/v3/SysConfig/${System}
HTTP Request Body
The HTTP request body must contain a valid Entity System Configuration Object.
HTTP Response
On success the API will return a status code of 200.
Retrieve system configuration for a specific entity
This REST API will return entity system configuration object for a specific entity. The entity must already exist in the system.
URL
GET /seiapi/v3/SysConfig/${System}
HTTP Request Body
Not required.
HTTP Response
The HTTP response body, on success, will contain a Entity System Configuration Object. Otherwise, on error, the response body will contain a descriptive reason for the error.