Working with iMIS REST API
In the language of iMIS REST API web services, an instance of a business object (object, row in table, and so forth) is an Entity, and the type of business object is an Entity Type. For instance, common entity types in iMIS REST API web services include Party or Person, Event, Group, and so forth.
iMIS REST API web services provides a basic set of operations that can run against an entity or a collection of entities. These include the basic CRUD operations:
| Operation | Using REST |
|---|---|
| Create | Post |
| Read | Get (query or find data) |
| Update | Put |
| Delete | Delete |
The iMIS REST APIs provide the following additional operations:
- Validate
- Execute
- FindByIdentity
- FindMetaDataForEntity
- FindChangeLogByIdentity
Depending on the programming environment, access to web service operations generally involves the following steps:
- Get an instance to an object or proxy that represents the web service, with login credentials.
- (optional) Create instances of objects, such as a query object, that include operation data you want to pass to the web service.
- Call the web service, naming the entity type and required operation parameters.
- When the call returns results (which is the usual case), examine the results of the operation.
Updated 10 days ago