1 Definition | 2 Functional Requirements | 3 Syntax | 4 Semantics |
1 Definition
The Action of a User requesting an Inform Service to:
- Provide information about an Item or a Process relevant to the Information Request Item.
- Grant Rights to the Information Response Item based on Model Rights.
If the request is accepted, the Inform Service responds with an Information Item Response.
2 Functional Requirements
The Inform Process Action includes the following elements:
- In the request
- The Information Request Item.
- The Model Rights to the Inform Response Item.
- The ID of the User that should receive the Information Response Item.
- A Transaction if requested by the Inform Service.
- In the response
- The Information Response Item.
- The Rights to the Information Response Item per the Model Rights.
3 Syntax
https://schemas.mpai.community/MMM4/V2.1/data/InformPA.json
4 Semantics
Label | Description |
Header | Inform Process Action Header |
– Standard-InformPA | The characters “OSD-IFP-V” |
– Version | Major version – 1 or 2 characters |
– Dot-separator | The character “.” |
– Subversion | Minor version – 1 or 2 characters |
MInstanceID | Identifier of M-Instance. |
MEnvironmentID | Identifier of M-Environment. |
InformPAData | Data included in the Inform Item. |
– Time | Time of PA request emission and Time of PA request execution. |
– RQ-Complements | Complements in PA Request. |
– With Information | The Information Request Item. |
– With ModelRights | Requested Rights on the Information Response Item. |
– At User | User receiving Information Response Item with Rights. |
– With Transaction | If Inform Service requests it. |
– RS-Complements | Complements in PA Response. |
– With Information | Information Response Item. |
– With Rights | Actual Rights based on Model Rights if PA Request is accepted.. |
– With PAStatus | Possible Error Messages. |
– Ack | If PA Request could be performed |
– Err | If Error was found |
– FaultyPA | Faulty PA Request. |
– IncID | Incorrect ID. |
– InsRights | Insufficient Rights. |
– InsValue | Insufficient Value in Wallet. |
DescMetadata | Descriptive Metadata. |