Skip to content
Basenet
🇳🇱 Nederlands
🇳🇱 Nederlands🇬🇧 English
Esc
↑↓navigate↵open⌘Jpreview

Compute the server-owned sync plan for a matter

POST/api/v1/sync/matters/{id}/reconcile
Authorization
AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Path parameters
idstringrequired
Request body
application/json
supportedContractVersionsstring[]
min items 1 · default: ["v1"]
filesobject[]required
max items 50000
Show properties
Array of object
relativePathstringrequired
min length 1
checksumstringrequired
min length 1
sizeintegerrequired
min 0
Responses
200

Server-computed sync plan and DMS metadata for downloads/conflicts

contractVersionstringrequired
Allowed:v1
matterIdstringrequired
planobjectrequired
Show properties
actionsobject[]required
Show properties
Array of object
kindstringrequired
Allowed:downloaduploadconflictdms_deleteddevice_deleted
reasonstring
Allowed:newdms_changeddevice_changed
relativePathstringrequired
documentIdstring | null
detailstring
summaryobjectrequired
Show properties
downloadintegerrequired
min 0
uploadintegerrequired
min 0
conflictintegerrequired
min 0
dmsDeletedintegerrequired
min 0
deviceDeletedintegerrequired
min 0
noopintegerrequired
min 0
documentsobjectrequired
400

Invalid request

errorstringrequired
codestringrequired
rulestring
401

Unauthenticated

errorstringrequired
codestringrequired
rulestring
403

Forbidden (missing scope or permission)

errorstringrequired
codestringrequired
rulestring
429

Rate limited

errorstringrequired
codestringrequired
rulestring
Request
curl -X POST '/api/v1/sync/matters/string/reconcile' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "supportedContractVersions": [
    "v1"
  ],
  "files": [
    {
      "relativePath": "string",
      "checksum": "string",
      "size": 0
    }
  ]
}'
Response
{
  "contractVersion": "v1",
  "matterId": "string",
  "plan": {
    "actions": [
      {
        "kind": "download",
        "reason": "new",
        "relativePath": "string",
        "documentId": "string",
        "detail": "string"
      }
    ],
    "summary": {
      "download": 0,
      "upload": 0,
      "conflict": 0,
      "dmsDeleted": 0,
      "deviceDeleted": 0,
      "noop": 0
    }
  },
  "documents": {
    "property1": {
      "relativePath": "string",
      "checksum": "string",
      "size": 0,
      "contentType": "string",
      "contentPath": "string"
    },
    "property2": {
      "relativePath": "string",
      "checksum": "string",
      "size": 0,
      "contentType": "string",
      "contentPath": "string"
    }
  }
}