# Rule
# Rule
A declarative rules engine underneath eligibility and validation across products, including model-assisted rule authoring.
Rules are data. A rule names the fields it reads, the condition it tests and the result it produces, and the engine evaluates it against a canonical record — which is what lets an eligibility rule change without a deployment of the product that runs it.
The same engine backs the conditional requirements in the model's semantic validation and the eligibility logic in the mortgage products.
## How it works
Rule authoring is assisted rather than automated. A model drafts a rule from a stated requirement, and the draft is validated against the model's own schema before it is accepted — so a generated rule that references a field that does not exist fails at authoring time rather than at evaluation time.
## Operations
### Engine
`POST` `/engine/data/jobs`
#### Invoke Ruleset
`invokeRuleset`
Invoke Ruleset: processes the input collection(s) according to the Ruleset operation as below:
- SELECTIVE_DATA_MERGE: merge collections in a new collection.
- Input: Staircase Collection(s).
- Process: Create new collection by running the ruleset on the input collections.
- Output: A new collection generated from running the ruleset.
- DATA_INFERRING: modify existing collection.
- Input: Staircase Collection.
- Process: Modify the collection by running the Ruleset.
- Output: Modified collection.
Callback URL: The callback is an POST HTTP call with a JSON request body with the following schema:
Show the rest
```
{
"type": "object",
"$schema": "",
"required": [
"job_id",
"job_status"
],
"properties": {
"job_id": {
"type": "string",
"format": "ulid"
},
"job_status": {
"type": "string",
"enum": [
"COMPLETED",
"FAILED"
]
},
"output": {
"type": "object",
"required": [
"data",
"metadata"
],
"properties": {
"data": {
"type": "object"
},
"metadata": {
"type": "object",
"description": "Metadata about output data",
"properties": {
"status": {
"type": "string",
"description": "Status of the data validity",
"enum": [
"HAS_VALIDATION_ERRORS"
]
},
"status_message": {
"type": "string",
"description": "Status description"
}
}
}
}
},
"failure_reason": {
"type": "string"
}
}
}
```
Example for completed job:
```
{
"job_id": "01FMPQ735YKJ0TFBXX3YKVWK7P",
"job_status": "COMPLETED",
"output": {
"metadata": {
"status": "HAS_VALIDATION_ERRORS",
"status_message": "Data has at least 1 object in $.data_validation_metadata with a has_validation_code >= 400"
},
"data": {
"documents": [
{
"@id": "01FKYN27FT44KKTAEC58S6Y6FY",
"@type": "closing_disclosure",
"has_document_date": {
"has_value": "2021-01-29"
},
"has_document_misclassified_indicator": {
"has_value": "false"
}
}
],
"loan_terms": [
{
"@id": "01FKYN27FH8P2WS39Z5KSV7CEA",
"@type": "loan_terms",
"has_hazard_insurance_escrow_required_indicator": {
"has_value": "true"
},
"has_initial_principal_and_interest_payment_amount": {
"has_value": 98.3
},
"has_prepaid_taxes_months_count": {
"has_value": "7"
},
"has_tax_escrow_required_indicator": {
"has_value": "true"
}
}
],
"payments": [
{
"@id": "01FKYN27FJN6M8MMFMH4PDSG5E",
"@type": "loan_payment",
"has_late_charge_rate_percent": {
"has_data_extraction_confidence_score": 95,
"has_value": "5"
}
}
]
}
}
}
```
Example for failed job:
```
{
"job_id": "01FMQCF7QW6BHZC7NC7XRRHRPN",
"job_status": "FAILED",
"failure_reason": "Unexpected error."
}
```
Example callback for running Ruleset Invocation:
The endpoint returns the job_id that can be tracked here
##### Request
application/json Copy
```
{
"ruleset_name": "selective_merge_ruleset",
"input": {
"data_objects": [
{
"data": {
"loans": [
{
"@id": "01FKYN27FFCBT3GHGNGWQ9S6CK",
"@type": "loan",
"with_insurance": [
"01FKYN27FHSK0MFKHD9WXC819J"
],
"with_loan_terms": [
"01FKYN27FH8P2WS39Z5KSV7CEB"
],
"with_payment": [
"01FKYN27FJN6M8MMFMH4PDSG5E"
]
}
],
"insurance": [
{
"@id": "01FKYN27FHSK0MFKHD9WXC819J",
"@type": "mortgage_insurance",
"has_insurance_escrowed_indicator": {
"has_value": "true"
}
}
],
"loan_terms": [
{
"@id": "01FKYN27FH8P2WS39Z5KSV7CEB",
"@type": "loan_terms",
"has_hazard_insurance_escrow_required_indicator": {
"has_value": "true"
},
"has_initial_principal_and_interest_payment_amount": {
"has_value": 91.5
},
"has_loan_amortization_type": {
"has_value": null
},
"has_prepaid_taxes_months_count": {
"has_value": "7"
},
"has_tax_escrow_required_indicator": {
"has_value": "true"
}
}
],
"payments": [
{
"@id": "01FKYN27FJN6M8MMFMH4PDSG5E",
"@type": "loan_payment",
"has_late_charge_rate_percent": {
"has_value": "5",
"has_data_extraction_confidence_score": 95
}
}
],
"documents": [
{
"@id": "01FKYN27FT44KKTAEC58S6Y6FY",
"@type": "closing_disclosure",
"has_document_date": {
"has_value": "2021-01-29"
},
"has_document_misclassified_indicator": {
"has_value": "false"
}
}
],
"mortgage_products": [
{
"@id": "01FKYN27FX3A94JY49JYCW7RG0",
"@type": "ide"
}
]
}
}
],
"collections": [
{
"transaction_id": "01FJC4DRGV5KNWWJZ9Y3D4X3KG",
"collection_id": "01FJC4E5E6M9ZJ5TRMJPRQ99C9"
},
{
"transaction_id": "01FJC4DRGV5KNWWJZ9Y3D4X3KG",
"collection_id": "01FJC4E9BXJZA254VTENY1RW9H"
},
{
"transaction_id": "01FJC4DRGV5KNWWJZ9Y3D4X3KG",
"collection_id": "01FJC4EGKZMA6T659B9XP64G4W"
}
]
},
"callback_url": "https://notify.me/please"
}
```
##### Response
201400
application/json Copy Created.
```
{
"ruleset_name": "selective_merge_ruleset",
"job_id": "01FJC4JGKFX3VYB0EZ75JNY4J6",
"job_status": "STARTED",
"input": {
"data_objects": [
{
"data": {
"loans": [
{
"@id": "01FKYN27FFCBT3GHGNGWQ9S6CK",
"@type": "loan",
"with_insurance": [
"01FKYN27FHSK0MFKHD9WXC819J"
],
"with_loan_terms": [
"01FKYN27FH8P2WS39Z5KSV7CEB"
],
"with_payment": [
"01FKYN27FJN6M8MMFMH4PDSG5E"
]
}
],
"insurance": [
{
"@id": "01FKYN27FHSK0MFKHD9WXC819J",
"@type": "mortgage_insurance",
"has_insurance_escrowed_indicator": {
"has_value": "true"
}
}
],
"loan_terms": [
{
"@id": "01FKYN27FH8P2WS39Z5KSV7CEB",
"@type": "loan_terms",
"has_hazard_insurance_escrow_required_indicator": {
"has_value": "true"
},
"has_initial_principal_and_interest_payment_amount": {
"has_value": 91.5
},
"has_loan_amortization_type": {
"has_value": null
},
"has_prepaid_taxes_months_count": {
"has_value": "7"
},
"has_tax_escrow_required_indicator": {
"has_value": "true"
}
}
],
"payments": [
{
"@id": "01FKYN27FJN6M8MMFMH4PDSG5E",
"@type": "loan_payment",
"has_late_charge_rate_percent": {
"has_value": "5",
"has_data_extraction_confidence_score": 95
}
}
],
"documents": [
{
"@id": "01FKYN27FT44KKTAEC58S6Y6FY",
"@type": "closing_disclosure",
"has_document_date": {
"has_value": "2021-01-29"
},
"has_document_misclassified_indicator": {
"has_value": "false"
}
}
],
"mortgage_products": [
{
"@id": "01FKYN27FX3A94JY49JYCW7RG0",
"@type": "ide"
}
]
}
}
],
"collections": [
{
"transaction_id": "01FJC4DRGV5KNWWJZ9Y3D4X3KG",
"collection_id": "01FJC4E5E6M9ZJ5TRMJPRQ99C9"
},
{
"transaction_id": "01FJC4DRGV5KNWWJZ9Y3D4X3KG",
"collection_id": "01FJC4E9BXJZA254VTENY1RW9H"
},
{
"transaction_id": "01FJC4DRGV5KNWWJZ9Y3D4X3KG",
"collection_id": "01FJC4EGKZMA6T659B9XP64G4W"
}
]
}
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Request body`application/json`
4 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id` | `string` | Transaction IDExample `01GKMKNNBG21DZ5GZXAQVS7AQC` |
| `ruleset_name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `input`required | `object` | Data for the processing |
| `data_objects` | `object[]` | The array of data objects that need to be processed |
| `data`required | `object` | The data in staircase v2 format |
| `collections` | `object[]` | The array of collection IDs that need to be processed |
| `transaction_id`required | `string (ulid)` | Transaction ID |
| `collection_id`required | `string (ulid)` | Collection ID |
| `callback_url` | `string (uri)` | The URL which is used to send the result of the job. |
##### Response `201``application/json`
5 fields
Created.
| Field | Type | Description |
| --- | --- | --- |
| `ruleset_name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `input`required | `object` | Data for the processing |
| `data_objects` | `object[]` | The array of data objects that need to be processed |
| `data`required | `object` | The data in staircase v2 format |
| `collections` | `object[]` | The array of collection IDs that need to be processed |
| `transaction_id`required | `string (ulid)` | Transaction ID |
| `collection_id`required | `string (ulid)` | Collection ID |
| `callback_url` | `string (uri)` | The URL which is used to send the result of the job. |
| `job_id`required | `string (ulid)` | Identifier of the job |
| `job_status`required | `string` | The status of the job`STARTED` |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400``422`
`GET` `/engine/data/jobs/{job_id}`
#### Get Ruleset Invocation Status
`getRulesetInvocationStatus`
Returns the status of invoking Ruleset associated with the input collection(s) and output collection.
##### Response
200400
application/json Copy Created.
```
{
"job_id": "01FM2G606MNKG8YKD62EB64DDR",
"job_status": "COMPLETED",
"ruleset_name": "test4",
"callback_url": "https://webhook.site/efc96f90-7e76-41bc-986f-5bcfaf1df8e3",
"input": {
"data_objects": [
{
"data": {
"loans": [
{
"@id": "01FKYN27FFCBT3GHGNGWQ9S6CK",
"@type": "loan",
"with_insurance": [
"01FKYN27FHSK0MFKHD9WXC819J"
],
"with_loan_terms": [
"01FKYN27FH8P2WS39Z5KSV7CEB"
],
"with_payment": [
"01FKYN27FJN6M8MMFMH4PDSG5E"
]
}
],
"insurance": [
{
"@id": "01FKYN27FHSK0MFKHD9WXC819J",
"@type": "mortgage_insurance",
"has_insurance_escrowed_indicator": {
"has_value": "true"
}
}
],
"loan_terms": [
{
"@id": "01FKYN27FH8P2WS39Z5KSV7CEB",
"@type": "loan_terms",
"has_hazard_insurance_escrow_required_indicator": {
"has_value": "true"
},
"has_initial_principal_and_interest_payment_amount": {
"has_value": 91.5
},
"has_loan_amortization_type": {
"has_value": null
},
"has_prepaid_taxes_months_count": {
"has_value": "7"
},
"has_tax_escrow_required_indicator": {
"has_value": "true"
}
}
],
"payments": [
{
"@id": "01FKYN27FJN6M8MMFMH4PDSG5E",
"@type": "loan_payment",
"has_late_charge_rate_percent": {
"has_value": "5",
"has_data_extraction_confidence_score": 95
}
}
],
"documents": [
{
"@id": "01FKYN27FT44KKTAEC58S6Y6FY",
"@type": "closing_disclosure",
"has_document_date": {
"has_value": "2021-01-29"
},
"has_document_misclassified_indicator": {
"has_value": "false"
}
}
],
"mortgage_products": [
{
"@id": "01FKYN27FX3A94JY49JYCW7RG0",
"@type": "ide"
}
]
}
}
],
"collections": [
{
"collection_id": "01FM1Z95YK35V2V5MYBV52V1H0",
"transaction_id": "01FM1Z7CAEHMA21C0GX78HGGSW"
}
]
},
"output": {
"data": {
"assets": [
{
"@id": "01FFSP6DRCFJEHQK8ZH38HAH6X",
"@type": "savings_account",
"owned_by": [
"01FFSP6DRCYYGGY9AER4H7GZXZ"
]
},
{
"@id": "01FFSP6DRCFJEHQK8ZH38HAH6Z",
"@type": "savings_account",
"owned_by": [
"01FFSP6DRCYYGGY9AER4H7GZXY",
"01FFSP6DRCYYGGY9AER4H7GZXX"
]
},
{
"@id": "01FFSP6DRCFJEHQK8ZH38HAH6Y",
"@type": "savings_account",
"owned_by": [
"01FFSP6DRCYYGGY9AER4H7GZXY - 01FFSP6DRCYYGGY9AER4H7GZXZ"
]
}
],
"people": [
{
"@id": "01FFSP6DRCYYGGY9AER4H7GZXY",
"@type": "borrower",
"has_first_name": {
"has_value": "John"
},
"has_last_name": {
"has_value": "Snow"
},
"owns_asset": [
"01FFSP6DRCFJEHQK8ZH38HAH6Z",
"01FFSP6DRCFJEHQK8ZH38HAH6Y"
]
},
{
"@id": "01FFSP6DRCYYGGY9AER4H7GZXZ",
"@type": "borrower",
"has_first_name": {
"has_value": "Jane"
},
"has_last_name": {
"has_value": "Snow"
},
"owns_asset": [
"01FFSP6DRCFJEHQK8ZH38HAH6X",
"01FFSP6DRCFJEHQK8ZH38HAH6Y"
]
},
{
"@id": "01FFSP6DRCYYGGY9AER4H7GZXX",
"@type": "borrower",
"has_first_name": {
"has_value": "Jack"
},
"has_last_name": {
"has_value": "Snow"
},
"owns_asset": [
"01FFSP6DRCFJEHQK8ZH38HAH6Z"
]
}
],
"relationships": [
{
"@type": "relationship",
"link_from": [
"01FFSP6DRCFJEHQK8ZH38HAH6Z"
],
"link_to": [
"01FFSP6DRCYYGGY9AER4H7GZXY"
],
"relationship_link": "ASSET_ROLE"
},
{
"@type": "relationship",
"link_from": [
"01FFSP6DRCFJEHQK8ZH38HAH6Y"
],
"link_to": [
"01FFSP6DRCYYGGY9AER4H7GZXY"
],
"relationship_link": "ASSET_ROLE"
},
{
"@type": "relationship",
"link_from": [
"01FFSP6DRCFJEHQK8ZH38HAH6Z"
],
"link_to": [
"01FFSP6DRCYYGGY9AER4H7GZXX"
],
"relationship_link": "ASSET_ROLE"
},
{
"@type": "relationship",
"link_from": [
"01FFSP6DRCFJEHQK8ZH38HAH6Y"
],
"link_to": [
"01FFSP6DRCYYGGY9AER4H7GZXZ"
],
"relationship_link": "ASSET_ROLE"
},
{
"@type": "relationship",
"link_from": [
"01FFSP6DRCFJEHQK8ZH38HAH6X"
],
"link_to": [
"01FFSP6DRCYYGGY9AER4H7GZXZ"
],
"relationship_link": "ASSET_ROLE"
}
]
}
}
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `job_id` required | `string` path | `01FJC4JGKFX3VYB0EZ75JNY4J6` | Identifier of the data processing job. |
##### Response `200``application/json`
8 fields
Created.
| Field | Type | Description |
| --- | --- | --- |
| `job_id`required | `string (ulid)` | Identifier of the job |
| `job_status`required | `string` | The status of the job`COMPLETED``FAILED``IN_PROGRESS` |
| `failure_reason` | `string` | The reason of a failing for jobs with status FAILED |
| `ruleset_name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `transaction_id`required | `string (ulid)` | Transaction ID |
| `input`required | `object` | Data for the processing |
| `data_objects` | `object[]` | The array of data objects that need to be processed |
| `data`required | `object` | The data in staircase v2 format |
| `collections` | `object[]` | The array of collection IDs that need to be processed |
| `transaction_id`required | `string (ulid)` | Transaction ID |
| `collection_id`required | `string (ulid)` | Collection ID |
| `callback_url` | `string (uri)` | The URL which is used to send the result of the job |
| `output`required | `object` | The data from rules applying |
| `data` | `object` | Raw result data |
| `metadata` | `object` | Metadata about output data |
| `status` | `string` | Status of the data validity`HAS_VALIDATION_ERRORS` |
| `status_message` | `string` | Status description |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
`GET` `/send-envelop`
#### Get Ruleset Invocation Status
`getRulesetInvocationStatus`
Returns the status of invoking Ruleset associated with the input collection(s) and output collection.
##### Response
application/json Copy Created.
```
{
"job_id": "01FM2G606MNKG8YKD62EB64DDR"
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `job_id` required | `string` path | `01FJC4JGKFX3VYB0EZ75JNY4J6` | Identifier of the data processing job. |
##### Response `200``application/json`
1 fields
Created.
| Field | Type | Description |
| --- | --- | --- |
| `job_id`required | `string (ulid)` | Identifier of the job |
### Rulesets
`GET` `/rulesets`
#### Get Rulesets
`getRulesets`
Get Rulesets returns a list of all the Rulesets.
##### Response
application/json Copy OK.
```
{
"count": 2,
"rulesets": [
{
"name": "selective_merge",
"description": "The ruleset for smart selecting data.",
"operation": "SELECTIVE_DATA_MERGE"
},
{
"name": "aus_relationships",
"description": "The ruleset for setting relationships between entities in v2 to the separated object to be able to map it to v0.",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
],
"operation": "DATA_INFERRING"
}
]
}
```
##### Response `200``application/json`
2 fields
OK.
| Field | Type | Description |
| --- | --- | --- |
| `count`required | `integer` | The number of returned rulesets |
| `rulesets`required | `object[]` | Rulesets list |
| `ruleset` | `object` | Ruleset. |
| `name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `description` | `string` | Ruleset descriptionExample `This ruleset can be used to select data from different collections.` |
| `operation`required | `string` | The purpose of the ruleset usage`DATA_INFERRING``SELECTIVE_DATA_MERGE` |
| `global_rdf_prefixes` | `object[]` | Array of RDF prefixes |
| `prefix` | `string` | Prefix that can be used in rules definitions |
| `IRI` | `string` | IRI that will be used instead of prefix in rules definitions |
| `_links` | `object` | Links to endpoints related to the ruleset |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
`GET` `/rulesets/{ruleset_name}`
#### Get Ruleset
`getRuleset`
Get Ruleset returns the Ruleset information.
##### Response
200 Selective Merge Ruleset200 Data Inferring Ruleset400
application/json Copy OK.
```
{
"name": "selective_merge",
"description": "The ruleset for smart selecting data.",
"operation": "SELECTIVE_DATA_MERGE",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
]
}
```
application/json Copy OK.
```
{
"name": "validation_ruleset",
"description": "The ruleset for validating if date of document is 2021 year.",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
],
"operation": "DATA_INFERRING"
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ruleset_name` required | `string` path | `my_ruleset` | Ruleset name |
##### Response `200``application/json`
2 fields
OK.
| Field | Type | Description |
| --- | --- | --- |
| `ruleset` | `object` | Ruleset. |
| `name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `description` | `string` | Ruleset descriptionExample `This ruleset can be used to select data from different collections.` |
| `operation`required | `string` | The purpose of the ruleset usage`DATA_INFERRING``SELECTIVE_DATA_MERGE` |
| `global_rdf_prefixes` | `object[]` | Array of RDF prefixes |
| `prefix` | `string` | Prefix that can be used in rules definitions |
| `IRI` | `string` | IRI that will be used instead of prefix in rules definitions |
| `_links` | `object` | Links to endpoints related to the ruleset |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
`POST` `/rulesets`
#### Create Ruleset
`createRuleset`
Creates Ruleset enable creation of Ruleset with the below attributes:
- name: Name of the Ruleset.
- description: Description of the Ruleset.
- operation: Type of the operation that will be executed when Invoking the Ruleset, supported operations:
- SELECTIVE_DATA_MERGE: merge collections in a new collection.
- Input: Staircase Collection(s).
- Process: Create new collection by running the ruleset on the input collections.
- Output: A new collection generated from running the ruleset.
- DATA_INFERRING: modify existing collection.
- Input: Staircase Collection.
- Process: Modify the collection by running the Ruleset.
- Output: Modified collection.
##### Request
Selective Merge RulesetData Inferring Ruleset
application/json Copy
```
{
"name": "selective_merge",
"description": "The ruleset for smart selecting data.",
"operation": "SELECTIVE_DATA_MERGE",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
]
}
```
application/json Copy
```
{
"name": "validation_ruleset",
"description": "The ruleset for validating if date of document is 2021 year.",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
],
"operation": "DATA_INFERRING"
}
```
##### Response
201 Selective Merge Ruleset201 Data Inferring Ruleset400
application/json Copy Created.
```
{
"name": "selective_merge",
"description": "The ruleset for smart selecting data.",
"operation": "SELECTIVE_DATA_MERGE",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
]
}
```
application/json Copy Created.
```
{
"name": "validation_ruleset",
"description": "The ruleset for validating if date of document is 2021 year.",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
],
"operation": "DATA_INFERRING"
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Request body`application/json`
4 fields
| Field | Type | Description |
| --- | --- | --- |
| `name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `description` | `string` | Ruleset descriptionExample `This ruleset can be used to select data from different collections.` |
| `operation`required | `string` | The purpose of the ruleset usage`DATA_INFERRING``SELECTIVE_DATA_MERGE` |
| `global_rdf_prefixes` | `object[]` | Array of RDF prefixes |
| `prefix` | `string` | Prefix that can be used in rules definitions |
| `IRI` | `string` | IRI that will be used instead of prefix in rules definitions |
##### Response `201``application/json`
4 fields
Created.
| Field | Type | Description |
| --- | --- | --- |
| `name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `description` | `string` | Ruleset descriptionExample `This ruleset can be used to select data from different collections.` |
| `operation`required | `string` | The purpose of the ruleset usage`DATA_INFERRING``SELECTIVE_DATA_MERGE` |
| `global_rdf_prefixes` | `object[]` | Array of RDF prefixes |
| `prefix` | `string` | Prefix that can be used in rules definitions |
| `IRI` | `string` | IRI that will be used instead of prefix in rules definitions |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `409``application/json`
1 fields
Resource already exists.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
`PATCH` `/rulesets/{ruleset_name}`
#### Update Ruleset
`updateRuleset`
Update Ruleset updates specific Ruleset, method shall update:
- Description;
- Operation;
- Global RDF Prefixes.
##### Request
Selective Merge RulesetData Inferring Ruleset
application/json Copy
```
{
"description": "The ruleset for smart selecting data.",
"operation": "SELECTIVE_DATA_MERGE",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
]
}
```
application/json Copy
```
{
"description": "The ruleset for validating if date of document is 2021 year.",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
],
"operation": "DATA_INFERRING"
}
```
##### Response
200 Selective Merge Ruleset200 Data Inferring Ruleset400
application/json Copy OK.
```
{
"description": "The ruleset for smart selecting data.",
"operation": "SELECTIVE_DATA_MERGE",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
]
}
```
application/json Copy OK.
```
{
"description": "The ruleset for validating if date of document is 2021 year.",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
],
"operation": "DATA_INFERRING"
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ruleset_name` required | `string` path | `my_ruleset` | Ruleset name |
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `description` | `string` | Ruleset descriptionExample `This ruleset can be used to select data from different collections.` |
| `operation` | `string` | The purpose of the ruleset usage`DATA_INFERRING``SELECTIVE_DATA_MERGE` |
| `global_rdf_prefixes` | `object[]` | Array of RDF prefixes |
| `prefix` | `string` | Prefix that can be used in rules definitions |
| `IRI` | `string` | IRI that will be used instead of prefix in rules definitions |
##### Response `200``application/json`
3 fields
OK.
| Field | Type | Description |
| --- | --- | --- |
| `description` | `string` | Ruleset descriptionExample `This ruleset can be used to select data from different collections.` |
| `operation` | `string` | The purpose of the ruleset usage`DATA_INFERRING``SELECTIVE_DATA_MERGE` |
| `global_rdf_prefixes` | `object[]` | Array of RDF prefixes |
| `prefix` | `string` | Prefix that can be used in rules definitions |
| `IRI` | `string` | IRI that will be used instead of prefix in rules definitions |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
`DELETE` `/rulesets/{ruleset_name}`
#### Delete Ruleset
`deleteRuleset`
Delete Ruleset deletes a specific Ruleset.
##### Response
200 Selective Merge Ruleset200 Data Inferring Ruleset400
application/json Copy OK.
```
{
"name": "selective_merge",
"description": "The ruleset for smart selecting data.",
"operation": "SELECTIVE_DATA_MERGE",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
]
}
```
application/json Copy OK.
```
{
"name": "validation_ruleset",
"description": "The ruleset for validating if date of document is 2021 year.",
"global_rdf_prefixes": [
{
"prefix": "rdf",
"IRI": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"prefix": "",
"IRI": "https://www.staircase.co/ontology/"
},
{
"prefix": "reserved",
"IRI": "https://www.staircase.co/reserved/"
}
],
"operation": "DATA_INFERRING"
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ruleset_name` required | `string` path | `my_ruleset` | Ruleset name |
##### Response `200``application/json`
4 fields
OK.
| Field | Type | Description |
| --- | --- | --- |
| `name`required | `string` | Ruleset nameExample `Some Ruleset` |
| `description` | `string` | Ruleset descriptionExample `This ruleset can be used to select data from different collections.` |
| `operation`required | `string` | The purpose of the ruleset usage`DATA_INFERRING``SELECTIVE_DATA_MERGE` |
| `global_rdf_prefixes` | `object[]` | Array of RDF prefixes |
| `prefix` | `string` | Prefix that can be used in rules definitions |
| `IRI` | `string` | IRI that will be used instead of prefix in rules definitions |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
### Rules
`GET` `/rulesets/{ruleset_name}/rules`
#### Get Rules
`getRules`
Get Rules Return all the rules associated with a Ruleset. If Rules count > 200, response body will contain pagination link(s).
##### Response
200 Selective Merge Rules200 Data Inferring Rules (Validation)400
application/json Copy OK.
```
{
"count": 2,
"rules": [
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :documents ?document .\n ?document ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MIN(?document_date_value) as ?earliest_date_value)\n WHERE\n {\n ?document :has_document_date / :has_value ?document_date_value .\n }\n }\n ?document :has_document_date / :has_value ?earliest_date_value .\n ?document ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
},
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :loan_terms ?loan_term .\n ?loan_term ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MAX(?payment_amount_value) as ?max_payment_amount_value)\n WHERE\n {\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?payment_amount_value .\n }\n }\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?max_payment_amount_value .\n ?loan_term ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
}
]
}
```
application/json Copy OK.
```
{
"count": 4,
"rules": [
{
"id": "PERCENT_IS_INTEGER_CONVERTABLE",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_DATA_FORMAT\" ;\n :has_validation_description \"Value is not integer.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n FILTER NOT EXISTS\n {\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value))\n }\n}\n"
}
},
{
"id": "NOT_LATER_THAN_TODAY",
"definition": {
"raw_sparql": "INSERT\n{\n\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Date is later than date of rule applying date.\"\n ]\n}\nWHERE\n{\n [] :documents / :has_document_date ?target_node .\n ?target_node :has_value ?document_date_value .\n BIND (NOW() as ?now)\n FILTER(\n ?document_date_value > CONCAT(\n STR(YEAR(?now)), \"-\", STR(MONTH(?now)), \"-\", STR(DAY(?now))\n )\n )\n}\n"
}
},
{
"id": "LOAN_AMORTIZATION_TYPE_IS_MISSING",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 404 ;\n :has_validation_code_type \"MISSING_DATA\" ;\n :has_validation_description \"Data is missing.\"\n ]\n}\nWHERE\n{\n [] :loan_terms / :has_loan_amortization_type ?target_node .\n FILTER NOT EXISTS { ?target_node :has_value ?value }\n}\n"
}
},
{
"id": "PERCENT_IS_GREATER_THAN_100",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Value is greater than 100.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value) > 100)\n}\n"
}
}
]
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ruleset_name` required | `string` path | `my_ruleset` | Ruleset name |
| `sort` | `string` query | `asc` | Sorting direction |
| `after_id` | `string` query | `a0533c96-937e-42cg-83b8-b63efe3cac8a` | Pagination marker. ID of the last rule from previous response. |
##### Response `200``application/json`
3 fields
OK.
| Field | Type | Description |
| --- | --- | --- |
| `count`required | `integer` | The number of returned rules |
| `_links`required | `object` | Pagination links |
| `next` | `string` | Next page |
| `previous` | `string` | Previous page |
| `rules`required | `array` | Rules list |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
`GET` `/rulesets/{ruleset_name}/rules/{rule_id}`
#### Get Rule
`getRule`
Get Rule returns a specific Rule by ID and associated Ruleset name.
##### Response
200 Selective Merge Rule 1200 Selective Merge Rule 2200 Constructing Entity Rule200 Data Validation Rule 1200 Data Validation Rule 2200 Data Validation Rule 3200 Data Validation Rule 4400
application/json Copy OK.
```
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :documents ?document .\n ?document ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MIN(?document_date_value) as ?earliest_date_value)\n WHERE\n {\n ?document :has_document_date / :has_value ?document_date_value .\n }\n }\n ?document :has_document_date / :has_value ?earliest_date_value .\n ?document ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
}
```
application/json Copy OK.
```
{
"id": "loan_terms_selection_rule",
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :loan_terms ?loan_term .\n ?loan_term ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MAX(?payment_amount_value) as ?max_payment_amount_value)\n WHERE\n {\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?payment_amount_value .\n }\n }\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?max_payment_amount_value .\n ?loan_term ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
}
```
application/json Copy OK.
```
{
"definition": {
"raw_sparql": "PREFIX: \nPREFIX rdf: \nPREFIX reserved: \n\nCONSTRUCT\n{\n reserved:root :documents [\n :has_document_date [\n :has_value ?document_date_value ;\n :has_data_extraction_confidence_score ?max_document_date_confidence_score\n ] ;\n :has_document_misclassified_indicator [\n :has_value ?document_misclassified_indicator_value ;\n :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score\n ]\n ]\n}\nWHERE\n{\n # GET DOCUMENT DATE DATA BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score) as ?max_document_date_confidence_score)\n WHERE\n {\n ?any_document :has_document_date / :has_data_extraction_confidence_score ?confidence_score .\n }\n }\n ?any_document :has_document_date ?end_node .\n ?end_node :has_data_extraction_confidence_score ?max_document_date_confidence_score .\n ?end_node :has_value ?document_date_value .\n\n\n # GET MISCLASSIFIED INDICATOR BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score_2) as ?max_document_misclassified_indicator_confidence_score)\n WHERE\n {\n ?any_document_2 :has_document_misclassified_indicator / :has_data_extraction_confidence_score ?confidence_score_2 .\n }\n }\n ?any_document_2 :has_document_misclassified_indicator ?end_node_2 .\n ?end_node_2 :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score .\n ?end_node_2 :has_value ?document_misclassified_indicator_value .\n}\n"
}
}
```
application/json Copy OK.
```
{
"id": "PERCENT_IS_INTEGER_CONVERTABLE",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_DATA_FORMAT\" ;\n :has_validation_description \"Value is not integer.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n FILTER NOT EXISTS\n {\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value))\n }\n}\n"
}
}
```
application/json Copy OK.
```
{
"id": "NOT_LATER_THAN_TODAY",
"definition": {
"raw_sparql": "INSERT\n{\n\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Date is later than date of rule applying date.\"\n ]\n}\nWHERE\n{\n [] :documents / :has_document_date ?target_node .\n ?target_node :has_value ?document_date_value .\n BIND (NOW() as ?now)\n FILTER(\n ?document_date_value > CONCAT(\n STR(YEAR(?now)), \"-\", STR(MONTH(?now)), \"-\", STR(DAY(?now))\n )\n )\n}\n"
}
}
```
application/json Copy OK.
```
{
"id": "LOAN_AMORTIZATION_TYPE_IS_MISSING",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 404 ;\n :has_validation_code_type \"MISSING_DATA\" ;\n :has_validation_description \"Data is missing.\"\n ]\n}\nWHERE\n{\n [] :loan_terms / :has_loan_amortization_type ?target_node .\n FILTER NOT EXISTS { ?target_node :has_value ?value }\n}\n"
}
}
```
application/json Copy OK.
```
{
"id": "PERCENT_IS_GREATER_THAN_100",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Value is greater than 100.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value) > 100)\n}\n"
}
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ruleset_name` required | `string` path | `my_ruleset` | Ruleset name |
| `rule_id` required | `string` path | `my_rule` | Rule id (name) |
##### Response `200``application/json`
4 fields
OK.
| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | Rule ID. Can be specified to identify it later. Otherwise, it will be set automatically. |
| `description` | `string` | Description of rule. |
| `local_rdf_prefixes` | `object[]` | Array of RDF prefixes. |
| `prefix`required | `string` | Prefix that can be used in rule definition. |
| `IRI`required | `string` | IRI that will be used instead of prefix in rule definition. |
| `definition`required | `object` | Definition of rule. |
| `raw_sparql`required | `string` | Raw SPARQL query (or insert) expression. |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
`POST` `/rulesets/{ruleset_name}/rules`
#### Create Or Update Rules
`createOrUpdateRules`
Create or Update Rules
Create Or Update Rules enables creating or updating multiple Rules using the same request. The endpoint shall check the pre-existence of Rule by ID. If the id doesn't exist, the rule will be created.
##### Request
Selective Merge RulesConstructing Entity RulesData Validation Rules
application/json Copy
```
{
"rules": [
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :documents ?document .\n ?document ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MIN(?document_date_value) as ?earliest_date_value)\n WHERE\n {\n ?document :has_document_date / :has_value ?document_date_value .\n }\n }\n ?document :has_document_date / :has_value ?earliest_date_value .\n ?document ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
},
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :loan_terms ?loan_term .\n ?loan_term ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MAX(?payment_amount_value) as ?max_payment_amount_value)\n WHERE\n {\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?payment_amount_value .\n }\n }\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?max_payment_amount_value .\n ?loan_term ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
}
]
}
```
application/json Copy
```
{
"rules": [
{
"definition": {
"raw_sparql": "PREFIX: \nPREFIX rdf: \nPREFIX reserved: \n\nCONSTRUCT\n{\n reserved:root :documents [\n :has_document_date [\n :has_value ?document_date_value ;\n :has_data_extraction_confidence_score ?max_document_date_confidence_score\n ] ;\n :has_document_misclassified_indicator [\n :has_value ?document_misclassified_indicator_value ;\n :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score\n ]\n ]\n}\nWHERE\n{\n # GET DOCUMENT DATE DATA BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score) as ?max_document_date_confidence_score)\n WHERE\n {\n ?any_document :has_document_date / :has_data_extraction_confidence_score ?confidence_score .\n }\n }\n ?any_document :has_document_date ?end_node .\n ?end_node :has_data_extraction_confidence_score ?max_document_date_confidence_score .\n ?end_node :has_value ?document_date_value .\n\n\n # GET MISCLASSIFIED INDICATOR BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score_2) as ?max_document_misclassified_indicator_confidence_score)\n WHERE\n {\n ?any_document_2 :has_document_misclassified_indicator / :has_data_extraction_confidence_score ?confidence_score_2 .\n }\n }\n ?any_document_2 :has_document_misclassified_indicator ?end_node_2 .\n ?end_node_2 :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score .\n ?end_node_2 :has_value ?document_misclassified_indicator_value .\n}\n"
}
}
]
}
```
application/json Copy
```
{
"rules": [
{
"id": "PERCENT_IS_INTEGER_CONVERTABLE",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_DATA_FORMAT\" ;\n :has_validation_description \"Value is not integer.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n FILTER NOT EXISTS\n {\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value))\n }\n}\n"
}
},
{
"id": "NOT_LATER_THAN_TODAY",
"definition": {
"raw_sparql": "INSERT\n{\n\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Date is later than date of rule applying date.\"\n ]\n}\nWHERE\n{\n [] :documents / :has_document_date ?target_node .\n ?target_node :has_value ?document_date_value .\n BIND (NOW() as ?now)\n FILTER(\n ?document_date_value > CONCAT(\n STR(YEAR(?now)), \"-\", STR(MONTH(?now)), \"-\", STR(DAY(?now))\n )\n )\n}\n"
}
},
{
"id": "LOAN_AMORTIZATION_TYPE_IS_MISSING",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 404 ;\n :has_validation_code_type \"MISSING_DATA\" ;\n :has_validation_description \"Data is missing.\"\n ]\n}\nWHERE\n{\n [] :loan_terms / :has_loan_amortization_type ?target_node .\n FILTER NOT EXISTS { ?target_node :has_value ?value }\n}\n"
}
},
{
"id": "PERCENT_IS_GREATER_THAN_100",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Value is greater than 100.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value) > 100)\n}\n"
}
}
]
}
```
##### Response
200 Selective Merge Rules200 Constructing Entity Rules200 Data Validation Rules400
application/json Copy OK. Created or updated.
```
{
"rules": [
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :documents ?document .\n ?document ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MIN(?document_date_value) as ?earliest_date_value)\n WHERE\n {\n ?document :has_document_date / :has_value ?document_date_value .\n }\n }\n ?document :has_document_date / :has_value ?earliest_date_value .\n ?document ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
},
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :loan_terms ?loan_term .\n ?loan_term ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MAX(?payment_amount_value) as ?max_payment_amount_value)\n WHERE\n {\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?payment_amount_value .\n }\n }\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?max_payment_amount_value .\n ?loan_term ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
}
]
}
```
application/json Copy OK. Created or updated.
```
{
"rules": [
{
"definition": {
"raw_sparql": "PREFIX: \nPREFIX rdf: \nPREFIX reserved: \n\nCONSTRUCT\n{\n reserved:root :documents [\n :has_document_date [\n :has_value ?document_date_value ;\n :has_data_extraction_confidence_score ?max_document_date_confidence_score\n ] ;\n :has_document_misclassified_indicator [\n :has_value ?document_misclassified_indicator_value ;\n :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score\n ]\n ]\n}\nWHERE\n{\n # GET DOCUMENT DATE DATA BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score) as ?max_document_date_confidence_score)\n WHERE\n {\n ?any_document :has_document_date / :has_data_extraction_confidence_score ?confidence_score .\n }\n }\n ?any_document :has_document_date ?end_node .\n ?end_node :has_data_extraction_confidence_score ?max_document_date_confidence_score .\n ?end_node :has_value ?document_date_value .\n\n\n # GET MISCLASSIFIED INDICATOR BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score_2) as ?max_document_misclassified_indicator_confidence_score)\n WHERE\n {\n ?any_document_2 :has_document_misclassified_indicator / :has_data_extraction_confidence_score ?confidence_score_2 .\n }\n }\n ?any_document_2 :has_document_misclassified_indicator ?end_node_2 .\n ?end_node_2 :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score .\n ?end_node_2 :has_value ?document_misclassified_indicator_value .\n}\n"
}
}
]
}
```
application/json Copy OK. Created or updated.
```
{
"rules": [
{
"id": "PERCENT_IS_INTEGER_CONVERTABLE",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_DATA_FORMAT\" ;\n :has_validation_description \"Value is not integer.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n FILTER NOT EXISTS\n {\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value))\n }\n}\n"
}
},
{
"id": "NOT_LATER_THAN_TODAY",
"definition": {
"raw_sparql": "INSERT\n{\n\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Date is later than date of rule applying date.\"\n ]\n}\nWHERE\n{\n [] :documents / :has_document_date ?target_node .\n ?target_node :has_value ?document_date_value .\n BIND (NOW() as ?now)\n FILTER(\n ?document_date_value > CONCAT(\n STR(YEAR(?now)), \"-\", STR(MONTH(?now)), \"-\", STR(DAY(?now))\n )\n )\n}\n"
}
},
{
"id": "LOAN_AMORTIZATION_TYPE_IS_MISSING",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 404 ;\n :has_validation_code_type \"MISSING_DATA\" ;\n :has_validation_description \"Data is missing.\"\n ]\n}\nWHERE\n{\n [] :loan_terms / :has_loan_amortization_type ?target_node .\n FILTER NOT EXISTS { ?target_node :has_value ?value }\n}\n"
}
},
{
"id": "PERCENT_IS_GREATER_THAN_100",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Value is greater than 100.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value) > 100)\n}\n"
}
}
]
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ruleset_name` required | `string` path | `my_ruleset` | Ruleset name |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `rules`required | `array` | Rules list |
##### Response `200``application/json`
1 fields
OK. Created or updated.
| Field | Type | Description |
| --- | --- | --- |
| `rules`required | `array` | Rules list |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `409``application/json`
1 fields
Resource already exists.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
`DELETE` `/rulesets/{ruleset_name}/rules/{rule_id}`
#### Delete Rule
`deleteRule`
Delete Rules
Delete Rule deletes a specific Rule using Rule ID and Ruleset name.
##### Response
200 Selective Merge Rule 1200 Selective Merge Rule 2200 Constructing Entity Rule200 Data Validation Rule 1200 Data Validation Rule 2200 Data Validation Rule 3200 Data Validation Rule 4400
application/json Copy Deleted.
```
{
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :documents ?document .\n ?document ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MIN(?document_date_value) as ?earliest_date_value)\n WHERE\n {\n ?document :has_document_date / :has_value ?document_date_value .\n }\n }\n ?document :has_document_date / :has_value ?earliest_date_value .\n ?document ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
}
```
application/json Copy Deleted.
```
{
"id": "loan_terms_selection_rule",
"definition": {
"raw_sparql": "CONSTRUCT\n{\n reserved:root :loan_terms ?loan_term .\n ?loan_term ?p ?o .\n ?o ?po ?oo .\n}\nWHERE\n{\n {\n SELECT (MAX(?payment_amount_value) as ?max_payment_amount_value)\n WHERE\n {\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?payment_amount_value .\n }\n }\n ?loan_term :has_initial_principal_and_interest_payment_amount / :has_value ?max_payment_amount_value .\n ?loan_term ?p ?o .\n OPTIONAL { ?o ?po ?oo . }\n}\n"
}
}
```
application/json Copy Deleted.
```
{
"definition": {
"raw_sparql": "PREFIX: \nPREFIX rdf: \nPREFIX reserved: \n\nCONSTRUCT\n{\n reserved:root :documents [\n :has_document_date [\n :has_value ?document_date_value ;\n :has_data_extraction_confidence_score ?max_document_date_confidence_score\n ] ;\n :has_document_misclassified_indicator [\n :has_value ?document_misclassified_indicator_value ;\n :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score\n ]\n ]\n}\nWHERE\n{\n # GET DOCUMENT DATE DATA BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score) as ?max_document_date_confidence_score)\n WHERE\n {\n ?any_document :has_document_date / :has_data_extraction_confidence_score ?confidence_score .\n }\n }\n ?any_document :has_document_date ?end_node .\n ?end_node :has_data_extraction_confidence_score ?max_document_date_confidence_score .\n ?end_node :has_value ?document_date_value .\n\n\n # GET MISCLASSIFIED INDICATOR BY MAX CONFIDENCE SCORE\n {\n SELECT (MAX(?confidence_score_2) as ?max_document_misclassified_indicator_confidence_score)\n WHERE\n {\n ?any_document_2 :has_document_misclassified_indicator / :has_data_extraction_confidence_score ?confidence_score_2 .\n }\n }\n ?any_document_2 :has_document_misclassified_indicator ?end_node_2 .\n ?end_node_2 :has_data_extraction_confidence_score ?max_document_misclassified_indicator_confidence_score .\n ?end_node_2 :has_value ?document_misclassified_indicator_value .\n}\n"
}
}
```
application/json Copy Deleted.
```
{
"id": "PERCENT_IS_INTEGER_CONVERTABLE",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_DATA_FORMAT\" ;\n :has_validation_description \"Value is not integer.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n FILTER NOT EXISTS\n {\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value))\n }\n}\n"
}
}
```
application/json Copy Deleted.
```
{
"id": "NOT_LATER_THAN_TODAY",
"definition": {
"raw_sparql": "INSERT\n{\n\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Date is later than date of rule applying date.\"\n ]\n}\nWHERE\n{\n [] :documents / :has_document_date ?target_node .\n ?target_node :has_value ?document_date_value .\n BIND (NOW() as ?now)\n FILTER(\n ?document_date_value > CONCAT(\n STR(YEAR(?now)), \"-\", STR(MONTH(?now)), \"-\", STR(DAY(?now))\n )\n )\n}\n"
}
}
```
application/json Copy Deleted.
```
{
"id": "LOAN_AMORTIZATION_TYPE_IS_MISSING",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 404 ;\n :has_validation_code_type \"MISSING_DATA\" ;\n :has_validation_description \"Data is missing.\"\n ]\n}\nWHERE\n{\n [] :loan_terms / :has_loan_amortization_type ?target_node .\n FILTER NOT EXISTS { ?target_node :has_value ?value }\n}\n"
}
}
```
application/json Copy Deleted.
```
{
"id": "PERCENT_IS_GREATER_THAN_100",
"definition": {
"raw_sparql": "INSERT\n{\n ?target_node :with_data_validation_metadata [\n rdf:type :data_validation_metadata ;\n :has_validation_code 400 ;\n :has_validation_code_type \"INVALID_BUSINESS_SENSE\" ;\n :has_validation_description \"Value is greater than 100.\"\n ]\n}\nWHERE\n{\n [] :payments / :has_late_charge_rate_percent ?target_node .\n ?target_node :has_value ?value .\n FILTER (xsd:integer(?value) > 100)\n}\n"
}
}
```
text/html Copy Bad request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `ruleset_name` required | `string` path | `my_ruleset` | Ruleset name |
| `rule_id` required | `string` path | `my_rule` | Rule id (name) |
##### Response `200``application/json`
4 fields
Deleted.
| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | Rule ID. Can be specified to identify it later. Otherwise, it will be set automatically. |
| `description` | `string` | Description of rule. |
| `local_rdf_prefixes` | `object[]` | Array of RDF prefixes. |
| `prefix`required | `string` | Prefix that can be used in rule definition. |
| `IRI`required | `string` | IRI that will be used instead of prefix in rule definition. |
| `definition`required | `object` | Definition of rule. |
| `raw_sparql`required | `string` | Raw SPARQL query (or insert) expression. |
##### Response `403``application/json`
1 fields
Forbidden.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Response `404``application/json`
1 fields
Resource is not found.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Message |
##### Other responses
`400`
### Operations
`POST` `/rule-engine`
#### Create Rule Engine
`post-rule-engine`
Create Rule Engine creates views of products, risk factors and other business intelligence that have been evaluated by a set of rules affecting the decisioning process.
##### Request
application/json Copy
```
{
"transaction_id": "uhz6t54e-9d74-g17e-99ca-a36b30vdfd35",
"collection_id": "hg62e49f-9d74-g17e-99ca-a36b30vdfd35",
"partner_name": "PartnerName"
}
```
##### Response
application/json Copy Rule Engine request created successfully.
```
{
"collection_id": "e4502ed2-8df8-4b8f-84bd-a1097e999a77",
"message": "When ready, data will be available under the following collection_id. Use this new collection_id to get the execution status."
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Authorization key |
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | Transaction ID |
| `collection_id`required | `string` | Collection ID |
| `partner_name`required | `string` | — |
##### Response `200``application/json`
2 fields
Rule Engine request created successfully.
| Field | Type | Description |
| --- | --- | --- |
| `collection_id` | `string` | Collection ID |
| `message` | `string` | Message |
## Errors
`400``403``404``409``422`
## More in Data
- Previous product: Persistence
- Next product: Site