Reconcile API

GET /api/reconcile

Retrieve entities in accordance W3C Reconciliation

Reconciliation provides a way of matching similar entities. ATTENTION: This GET endpoint is only supposed to be used for interactive debugging of reconciliation queries in a web browser.

Parameters

Name	In	Type	Required	Description
queries	query	string	true	Query batch

Example responses

200 Response

{
  "q1": {
    "result": [
      {
        "id": "string",
        "name": "string",
        "score": 0,
        "features": [
          {
            "id": "string",
            "value": "string"
          }
        ],
        "match": true
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The reconciliation was successful and returned a result.	None
400	Bad Request	The request contains invalid input.	None
500	Internal Server Error	There was an issue while processing the query.	None

Response Schema

POST /api/reconcile

Retrieve entities in the format of W3C Reconciliation

Reconciliation provides a way of matching similar entities. SANTé is used in the background to facilitate the matching via a search query.

Body parameter

{
  "property1": {
    "query": "string",
    "type": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "limit": 1,
    "properties": [
      {
        "pid": "string",
        "v": "string"
      }
    ]
  },
  "property2": {
    "query": "string",
    "type": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "limit": 1,
    "properties": [
      {
        "pid": "string",
        "v": "string"
      }
    ]
  }
}

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» additionalProperties	body	ReconciliationQuery	false	none
»» query	body	string	true	none
»» type	body	[ReconciliationType]	false	none
»»» id	body	string	true	none
»»» name	body	string	true	none
»» limit	body	integer(int32)	false	none
»» properties	body	[ReconciliationProperty]	false	none
»»» pid	body	string	true	none
»»» v	body	string	true	none

Example responses

200 Response

{
  "q1": {
    "result": [
      {
        "id": "string",
        "name": "string",
        "score": 0,
        "features": [
          {
            "id": "string",
            "value": "string"
          }
        ],
        "match": true
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The query was successful and returned a result.	None
400	Bad Request	The request contains invalid input.	None
500	Internal Server Error	There was an issue while processing the request.	None