Inline compare

OpenAPI V2

Compare two inline files and show the difference between them.

post

Compare two inline files and show the difference between them.

Authorizations

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyoptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyoptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyoptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Body

filesToBeComparedobject | nullableoptional

The main and child files that are going to be compared.

Example: {"master":"base64 content","child":"base64 content"}

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /instance/inline-compare HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "filesToBeCompared": {
    "master": "base64 content",
    "child": "base64 content"
  }
}

{
  "validationType": "Compare",
  "compareResult": "Differences found.",
  "messages": [
    {
      "category": "text",
      "type": "text",
      "messageText": "text",
      "pair": {
        "first": {
          "arcRole": "text",
          "contextId": "text",
          "contextRef": "text",
          "continuationFrom": "text",
          "decimals": "text",
          "dimensionDetailsList": [
            {
              "dimensionName": "text",
              "member": "text",
              "dimensionType": "text"
            }
          ],
          "endDate": "text",
          "escape": "text",
          "extendedXLinkType": "text",
          "factName": "text",
          "factValue": "text",
          "footnoteId": "text",
          "footnoteRefs": "text",
          "footnoteValue": [
            "text"
          ],
          "footnoteRole": "text",
          "format": "text",
          "fromRefs": "text",
          "id": "text",
          "identifierContent": "text",
          "identifierScheme": "text",
          "instantDate": "text",
          "linkRole": "text",
          "measurement": "text",
          "name": "text",
          "order": "text",
          "periodType": "text",
          "precision": "text",
          "scale": "text",
          "sign": "text",
          "startDate": "text",
          "target": "text",
          "title": "text",
          "toRefs": "text",
          "tupleID": "text",
          "tupleRef": "text",
          "unitId": "text",
          "unitRef": "text",
          "source": "text",
          "elementType": 0,
          "taxonomyUri": "text",
          "namespaceUri": "text",
          "namespacePrefix": "text"
        },
        "second": {
          "arcRole": "text",
          "contextId": "text",
          "contextRef": "text",
          "continuationFrom": "text",
          "decimals": "text",
          "dimensionDetailsList": [
            {
              "dimensionName": "text",
              "member": "text",
              "dimensionType": "text"
            }
          ],
          "endDate": "text",
          "escape": "text",
          "extendedXLinkType": "text",
          "factName": "text",
          "factValue": "text",
          "footnoteId": "text",
          "footnoteRefs": "text",
          "footnoteValue": [
            "text"
          ],
          "footnoteRole": "text",
          "format": "text",
          "fromRefs": "text",
          "id": "text",
          "identifierContent": "text",
          "identifierScheme": "text",
          "instantDate": "text",
          "linkRole": "text",
          "measurement": "text",
          "name": "text",
          "order": "text",
          "periodType": "text",
          "precision": "text",
          "scale": "text",
          "sign": "text",
          "startDate": "text",
          "target": "text",
          "title": "text",
          "toRefs": "text",
          "tupleID": "text",
          "tupleRef": "text",
          "unitId": "text",
          "unitRef": "text",
          "source": "text",
          "elementType": 0,
          "taxonomyUri": "text",
          "namespaceUri": "text",
          "namespacePrefix": "text"
        }
      }
    }
  ],
  "htmlContent": "base64 content"
}