Items
API | Description |
---|---|
GET api/v1/{systemName}/items/{key} |
Gets an information item for a given key |
POST api/v1/{systemName}/items/{typeId} |
Saves a dictionary of field names and values as an information item. |
POST api/v1/{systemName}/items/{typeId}/{fieldId} |
Saves the Body of the Request as a string to a new Information Item of the Defined Type within the Defined Field. Use as a generic way to accept any request and then use additional tools inside the platform to interact with the request. |
PUT api/v1/{systemName}/items/{key} |
Updates an item based on a dictionary of field names and values. |
Attachment
API | Description |
---|---|
POST api/v1/{systemName}/attachments/{key} |
Saves a file as an attachment to the specified item. Request content type must be multipart/form-data. Maximum filesize: 50MB. |
GET api/v1/{systemName}/attachments/{key}/{elementNumber} |
Retrieves an Attachment by ID and provides the file. |
Process
API | Description |
---|---|
GET api/v1/{systemName}/processes/{id}/{key} |
Performs an EIM process on selected item |
POST api/v1/{systemName}/processes/{id}/{key} |
Performs a process with input |
Utilities
API | Description |
---|---|
GET api/v1/{systemName}/utilities/encrypt/{value} |
Encrypts an item key or id. Can be used by super users only. |
GET api/v1/{systemName}/utilities/decrypt/{value} |
Decrypts an item key or id. Can be used by super users only. |
Search
API | Description |
---|---|
GET api/v1/{systemName}/search/{id} |
Performs a filter to get a set of search results |