Base URL: dcom/v1/, Version:
This is the API that should be implemented by a software service to allow a DCOM Rule Engine to connect to it. version: '1.0.0'
| Path | Operation | Description |
|---|---|---|
| /v1/ | GET |
Retrieves the basic metadata about the data source component |
| /v1/{complianceCheckUID}/ | GET |
Enables the retrieval basic project information. |
| POST |
Enables the submission of feedback from the rule engine to the implementing service. |
|
| /v1/{complianceCheckUID}/answer | GET |
Enables the retrieval of the answer to a question (or a set of questions) from the implementing service |
| /v1/{complianceCheckUID}/data | GET |
Enables the retrieval of an item or set of data from the implementing service |
| /v1/{complianceCheckUID}/retrieveAnswerJob/{jobId} | GET |
Enables the retrieval of the answer to a question that could not be provided immediately |
| /v1/{complianceCheckUID}/retrieveDataJob/{jobId} | GET |
Enables the retrieval of the data to a question that could not be provided immediately |
A bearer token to identify the connecting service as an authorizied DCOM accredited rule engine
Retrieves the basic metadata about the data source component
Uses default content-types: application/json application/xml
Returns basic metadata about the data source component. Equivalent XML Response is returned if content type is set appropriately.
Enables the retrieval of basic project information and the set of unique identifiers of entities known by the implementing services
| complianceCheckUID | The unique id of the compliance check being conducted |
path | string |
Uses default content-types: application/json application/xml
Returns the set of IDs that have been requested
A human readable name for the project
The Set of IDs
| auth |
Enables the submission of feedback from the rule engine to the implementing service.
Uses default content-types: application/json application/xml
| complianceCheckUID | The unique id of the compliance check being conducted |
path | string |
Uses default content-types: application/json application/xml
| auth |
Enables the retrieval of the answer to a question (or a set of questions) from the implementing service
| complianceCheckUID | The unique id of the compliance check being conducted |
path | string | |
| id | The set of IDs to retrieve data about. |
query | string | |
| propertyName | The name of the property that we wish to retrieve |
query | string | |
| comparator | The comparator used to test against the property - defaults to = if absent |
query | string , x ∈ { '=' , '!=' , '>' , '>=' , '<' , '<=' } | |
| desiredAnswer | The desired answer - defaults to true if absent |
query | string | |
| unit | The unit requested - defaults to unitless if absent |
query | string | |
| complianceDocumentReference | A reference to the element in a compliance document the request is related to |
query | string |
Uses default content-types: application/json application/xml
Returns the set of answers that have been requested
A set of answers submitted to the rule engine.
| auth |
Enables the retrieval of an item or set of data from the implementing service
| complianceCheckUID | The unique id of the compliance check being conducted |
path | string | |
| id | The IDs to retrieve data about |
query | string | |
| propertyName | The name of the property that we wish to retrieve |
query | string | |
| unit | The unit of the property we wish to retrieve |
query | string | |
| complianceDocumentReference | A reference to the element in a compliance document the request is related to |
query | string |
Uses default content-types: application/json application/xml
Returns the set of data that has been requested
A set of data, returned in the same order as the ids specified in the id query parameter
A Job ID representing the fact the service cannot reply in a timely manor and the rule engine should contact it later for a response.
| auth |
Enables the retrieval of the answer to a question that could not be provided immediately
| jobId | The unique job id being requested |
paths | string | |
| id | The ID to retrieve data about |
query | string |
Uses default content-types: application/json application/xml
Returns the set of answers that have been requested
A set of answers submitted to the rule engine.
| auth |
Enables the retrieval of the data to a question that could not be provided immediately
| jobId | The unique job id being requested |
paths | string | |
| id | The ID to retrieve data about |
query | string |
Uses default content-types: application/json application/xml
Returns the set of data that have been requested
A set of data, returned in the same order as the ids specified in the id query parameter
| auth |
Represents an answer to questions posed by the rule engine
The id of the property being answered
The Entity ID to which this answer is relevant
The actual answer
The optional miss value. This is an indication, if the answer is false, how far out of tolerance the value is.
The BASE64 Encoded File Data that supports/evidences this answer
The MIME Content Type of the Support file data (if present)
A Job ID representing the fact the service cannot reply in a timely manor and the rule engine should contact it later for a response.
Feedback items to be provided to the implementing service
An ID refering to a clause within a compliance document against which feedback is given
The result that has been computed
A set of free text reasons for the given answer from the rule engine