Audit

update conflict state

post

state can be 'managed', 'ignored' or 'detected'

Body

application/json

idstringRequired

statestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/conflict-information/set-state

HTTPcURLJavaScriptPython

POST /api/audit/conflict-information/set-state HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "id": "text",
  "state": "text"
}

{
  "response": true
}

count all conflicts

post

count all conflicts

Responses

200

Successful Response

application/json

post

/count-conflict-information

HTTPcURLJavaScriptPython

POST /api/audit/count-conflict-information HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "response": 1
}

update duplicate state

post

state can be 'managed', 'ignored' or 'detected'

Body

application/json

idstringRequired

statestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/duplicated-information/set-state

HTTPcURLJavaScriptPython

POST /api/audit/duplicated-information/set-state HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "id": "text",
  "state": "text"
}

{
  "response": true
}

count all duplicates

post

count all duplicates

Responses

200

Successful Response

application/json

post

/count-duplicated-information

HTTPcURLJavaScriptPython

POST /api/audit/count-duplicated-information HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "response": 1
}

list conflicts

post

list all conflicts

Body

application/json

queryany ofOptional

stringOptional

or

nullOptional

document_nameany ofOptional

stringOptional

or

nullOptional

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

stateany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/conflict-information

HTTPcURLJavaScriptPython

POST /api/audit/conflict-information HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "query": "text",
  "document_name": "text",
  "limit": 200,
  "offset": 0,
  "state": "text"
}

{
  "response": [
    {
      "id": "text",
      "subject": "text",
      "state": "DETECTED",
      "documents": [
        {
          "doc_id": "text",
          "information_involved": "text"
        }
      ],
      "explanation": "text"
    }
  ]
}

list duplicates

post

list all duplicates

Body

application/json

queryany ofOptional

stringOptional

or

nullOptional

document_nameany ofOptional

stringOptional

or

nullOptional

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

stateany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/duplicated-information

HTTPcURLJavaScriptPython

POST /api/audit/duplicated-information HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "query": "text",
  "document_name": "text",
  "limit": 200,
  "offset": 0,
  "state": "text"
}

{
  "response": [
    {
      "id": "text",
      "subject": "text",
      "state": "DETECTED",
      "documents": [
        {
          "doc_id": "text",
          "information_involved": "text"
        }
      ],
      "explanation": "text"
    }
  ]
}

count anomalies per document

post

count duplicates and conflicts per document

Responses

200

Successful Response

application/json

post

/document-ids-to-manage

HTTPcURLJavaScriptPython

POST /api/audit/document-ids-to-manage HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "response": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

get anomalies for a document

post

retrieve all conflicts and duplicates associated to the document

Body

application/json

idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/get-anomalies-for-document

HTTPcURLJavaScriptPython

POST /api/audit/get-anomalies-for-document HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}

{
  "response": {
    "conflicts": [
      {
        "id": "text",
        "subject": "text",
        "state": "DETECTED",
        "documents": [
          {
            "doc_id": "text",
            "information_involved": "text"
          }
        ],
        "explanation": "text"
      }
    ],
    "duplicated": [
      {
        "id": "text",
        "subject": "text",
        "state": "DETECTED",
        "documents": [
          {
            "doc_id": "text",
            "information_involved": "text"
          }
        ],
        "explanation": "text"
      }
    ]
  }
}

count conflict anomalies by date

post

count conflict anomalies by date

Body

application/json

begin_dateany ofOptional

stringOptional

or

nullOptional

end_dateany ofOptional

stringOptional

or

nullOptional

stateany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/count-conflict-by-date

HTTPcURLJavaScriptPython

POST /api/audit/count-conflict-by-date HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "begin_date": "text",
  "end_date": "text",
  "state": "text"
}

{
  "response": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

count duplicate anomalies by date

post

count duplicate anomalies by date

Body

application/json

begin_dateany ofOptional

stringOptional

or

nullOptional

end_dateany ofOptional

stringOptional

or

nullOptional

stateany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/count-duplicate-by-date

HTTPcURLJavaScriptPython

POST /api/audit/count-duplicate-by-date HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "begin_date": "text",
  "end_date": "text",
  "state": "text"
}

{
  "response": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

count conflicts per subject

post

count conflicts anomalies per subject

Responses

200

Successful Response

application/json

post

/count-conflict-by-subject

HTTPcURLJavaScriptPython

POST /api/audit/count-conflict-by-subject HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "response": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

count duplicates per subject

post

count duplicates anomalies per subject

Responses

200

Successful Response

application/json

post

/count-duplicate-by-subject

HTTPcURLJavaScriptPython

POST /api/audit/count-duplicate-by-subject HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "response": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

filter conflicts by subject

post

retrieve all conflicts anomalies by subject

Body

application/json

subjectany ofOptional

stringOptional

or

nullOptional

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/get-conflict-information-by-subject

HTTPcURLJavaScriptPython

POST /api/audit/get-conflict-information-by-subject HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "subject": "text",
  "limit": 200,
  "offset": 0
}

{
  "response": [
    {
      "id": "text",
      "subject": "text",
      "state": "DETECTED",
      "documents": [
        {
          "doc_id": "text",
          "information_involved": "text"
        }
      ],
      "explanation": "text"
    }
  ]
}

check if a document is already audited

post

True if the document is already audited, else False

Body

application/json

idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/document-is-analyzed

HTTPcURLJavaScriptPython

POST /api/audit/document-is-analyzed HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}

{
  "response": true
}

filter duplicates by subject

post

retrieve all duplicates anomalies by subject

Body

application/json

subjectany ofOptional

stringOptional

or

nullOptional

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/get-duplicate-information-by-subject

HTTPcURLJavaScriptPython

POST /api/audit/get-duplicate-information-by-subject HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "subject": "text",
  "limit": 200,
  "offset": 0
}

{
  "response": [
    {
      "id": "text",
      "subject": "text",
      "state": "DETECTED",
      "documents": [
        {
          "doc_id": "text",
          "information_involved": "text"
        }
      ],
      "explanation": "text"
    }
  ]
}

Retrieve document ID pairs with potential conflicts.

post

Return a list of document id pairs in conflict information

Body

application/json

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

document_nameany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/get-conflict-document-pair

HTTPcURLJavaScriptPython

POST /api/audit/get-conflict-document-pair HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "limit": 200,
  "offset": 0,
  "document_name": "text"
}

[]

Retrieve document ID pairs with potential duplicates.

post

Return a list of document id pairs in duplicate information

Body

application/json

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

document_nameany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/get-duplicate-document-pair

HTTPcURLJavaScriptPython

POST /api/audit/get-duplicate-document-pair HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "limit": 200,
  "offset": 0,
  "document_name": "text"
}

[]

Retrieve all document conflicts by given document id pair.

post

Return a list of conflicts by given document id pair

Body

application/json

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

document_idsstring[]OptionalDefault: []

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/get-conflicts-by-document-id-pair

HTTPcURLJavaScriptPython

POST /api/audit/get-conflicts-by-document-id-pair HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "limit": 200,
  "offset": 0,
  "document_ids": [
    "text"
  ]
}

{
  "response": [
    {
      "id": "text",
      "subject": "text",
      "state": "DETECTED",
      "documents": [
        {
          "doc_id": "text",
          "information_involved": "text"
        }
      ],
      "explanation": "text"
    }
  ]
}

Retrieve all document duplicates by given document id pair.

post

Return a list of duplicates by given document id pair

Body

application/json

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

document_idsstring[]OptionalDefault: []

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/get-duplicates-by-document-id-pair

HTTPcURLJavaScriptPython

POST /api/audit/get-duplicates-by-document-id-pair HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "limit": 200,
  "offset": 0,
  "document_ids": [
    "text"
  ]
}

{
  "response": [
    {
      "id": "text",
      "subject": "text",
      "state": "DETECTED",
      "documents": [
        {
          "doc_id": "text",
          "information_involved": "text"
        }
      ],
      "explanation": "text"
    }
  ]
}

List missing information

post

Return a list of missing information

Body

application/json

queryany ofOptional

stringOptional

or

nullOptional

document_nameany ofOptional

stringOptional

or

nullOptional

limitany ofOptionalDefault: 200

integerOptional

or

nullOptional

offsetany ofOptionalDefault: 0

integerOptional

or

nullOptional

stateany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/list-missing-information

HTTPcURLJavaScriptPython

POST /api/audit/list-missing-information HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "query": "text",
  "document_name": "text",
  "limit": 200,
  "offset": 0,
  "state": "text"
}

[]

Delete missing information

post

Delete missing information from database

Body

application/json

idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/delete-missing-information

HTTPcURLJavaScriptPython

POST /api/audit/delete-missing-information HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}

{
  "response": true
}

Count missing information

post

Return total number of missing information

Responses

200

Successful Response

application/json

post

/count-missing-information

HTTPcURLJavaScriptPython

POST /api/audit/count-missing-information HTTP/1.1
Host: 
Accept: */*

200

Successful Response

{
  "response": 1
}