Download OpenAPI specification:
This is the Results API proposed as part of the ACCORD project version: '1.0.0'. It is designed to be implemented by compliance checking microservices to allow interface between the ACCORD cloud architecture and the compliance checking microservices.
Retrieves the basic metadata about the compliance checking microservice and its capabilities.
{- "name": "string",
- "description": "string",
- "operator": "string",
- "supportedModelFormats": [
- "string"
], - "supportedTerms": [
- "string"
]
}Initiates a Compliance Check on the Microservice based on a document reference
The parameters to initiate the compliance check. The microservice should parse and execute all checks within the given BuildingCode that it is capable of executing.
| buildingCodeReferences required | Array of strings <url> [ items <url > ] The URLs to one or more building codes hosted on an endpoint compatible with the Building Codes and Regulations API |
required | Array of objects (ModelDetails) The list of models for this check |
| additionalData | object Any additional data (specified as valid JSON) required by the microservice for execution |
| entityIds | Array of strings The set of entity Ids to restrict those that the given compliance check is performed on. If blank it is assumed all entities are checked. |
| webhookUrl | string <url> A Webhook URL that the microservice can call to signify this check is complete. |
| webhookUpload | string <url> A Webhook URL that the microservice can call to upload any supportingFileData. |
{- "buildingCodeReferences": [
- "string"
], - "models": [
- {
- "URL": "string",
- "ContentType": "string"
}
], - "additionalData": { },
- "entityIds": [
- "string"
], - "webhookUrl": "string",
- "webhookUpload": "string"
}{- "CheckJobID": "5f07e7d2-8b11-4e96-8db4-054791375c11"
}Initiates a Compliance Check on the Microservice within a given document reference
| ComplianceCheckName required | string The name of the compliance check to be executed |
The parameters to initiate the compliance check. The microservice should execute only the named compliance check within the given BuildingCode.
| entityIds | Array of strings The set of entity Ids to perform the given compliance check on. If blank it is assumed all entities are checked. |
| comparator | string Enum: "!=" "==" ">=" "<=" "<" ">" The comparator used to determine if a specific individual check has passed |
| desiredValue | string The desired value for the result of the compliance check. |
| unit | string The unit of desiredValue. If absent the microservice will assume either unitless or a standard SI Unit. |
| buildingCodeReference required | string The URL to a building code hosted on an endpoint compatible with the Building Codes and Regulations API |
| additionalData | object Any additional data (specified as valid JSON) required by the microservice for execution |
required | Array of objects (ModelDetails) The list of models for this check |
| webhookUrl | string <url> A Webhook URL that the microservice can call to signify this check is complete. |
{- "entityIds": [
- "string"
], - "comparator": "!=",
- "desiredValue": "string",
- "unit": "string",
- "buildingCodeReference": "string",
- "additionalData": { },
- "models": [
- {
- "URL": "string",
- "ContentType": "string"
}
], - "webhookUrl": "string"
}{- "CheckJobID": "5f07e7d2-8b11-4e96-8db4-054791375c11"
}| CheckJobID required | string <uuid> The CheckJobID |
| Accept-Language | string The requested language of the response (taken from ISO 639) defaults to EN. |
{- "supportingFileContentType": "string",
- "supportingFileData": "string",
- "results": [
- {
- "documentReference": "string",
- "entityId": "string",
- "answer": true,
- "missValue": "string",
- "supportingFileData": "string"
}
]
}