Operation Categories
CMI Protocol operations can be categorized in different ways:
• | By type: Operations are categorized into four types: |
— | Session: See Sessions |
— | Read: See Read Operations |
— | Write: See Write Operations |
— | Batch: See Batch Transactions |
• | By target: Except for Session and Batch type, each operation has a “target” attribute, which is a particular type that the operation works on, such as Participant, Business Agreement, and so on. |
• | By command: Each operation falls into one of the pre-defined commands, as explained in CMI Protocol Commands. |
Command |
Definition |
|||||||||
Insert new data. If the data exists, an error message is returned. Used only for the |
||||||||||
Update existing data. If the data does not exist, an error message is returned. Used only for the |
||||||||||
Update or insert data. The CMI Protocol tries to insert the data if it does not exist, or update the data if it exists. In either case, a success response is returned. Used only for the |
||||||||||
Delete data. If the data does not exist, an Used only for the |
||||||||||
Get one data. If no data exists, an empty response is returned. If more than one data exists, the first matched data is returned. Used only for the |
||||||||||
Get a set of data. If no data exists, an empty response is returned. Used only for the |
||||||||||
Log in and create a session.
|
||||||||||
Log out and destroy the session.
|
||||||||||
Run a batch of requests.
|
||||||||||
Cancel a batch of requests.
|