Terminology
These are some terms that you should familiarize with before using the Client Compliance API:
- Compliance Document
- A file that contains one or more compliance expression items. The document is formatted as XML. The client maintains a file storage location for each Fixlet site where it locates compliance documents.
- Compliance Expression Item
- Contains a designator, relevance expression, and optionally, a description and comment.
- Compliance Response
- The response made available to the API by the client after it processes the compliance document. The response contains of one or more Compliance Result items.
- Compliance Result item
- Contains a designator, relevance result, description, and a comment.
- Designator
- The name/ID of the query. A string up to 64 characters in length, composed of alphanumeric characters, underscores, or periods.
- Relevance Expression
- Arbitrary relevance expression to be evaluated by the client and reported to the API with the corresponding designator.
- Relevance Result
- The result of evaluating the relevance expression. Plural expressions result in multiple Compliance Result Items that are shown in the response from the API.
- Description
- Some text that is carried from the Compliance Expression item to the Compliance result item. It is passed from the document to the API without processing and can therefore be used to convey arbitrary data about the Compliance expression item.
- Comment
- This is text handled the same as the Description.