Skip to content
NimlesNimlesNimles Docs

Patch a file

PATCH
/api/tenant/{tenantId}/Files/{id}
curl --request PATCH \
  --url https://api.nimles.com/media/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Files/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "op": "example", "path": "example", "from": "example", "value": "example" } ]'

Changes a file with JSON Patch (RFC 6902) operations: add, remove, replace, move, copy and test. The members that can be patched are those PUT changes: name, description, folderId and fields (whole, or one field at /fields/{key}). As for PUT, a new folder must be a folder (not deleted) of the file’s resource group, and folderId must be set with add, replace or remove, not moved or copied from another member.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

The unique identifier of the file to patch.

tenantId
required
string format: uuid

Your tenant id.

Request Body

Section titled “Request Body”

The patch operations, applied in order and all or none.

Media typeapplication/json
Array<object>
object
op
required
string
>= 1 characters /^(add|remove|replace|move|copy|test)$/
path
required
string
>= 1 characters
from
string
nullable
value
nullable

Example generated

[
  {
    "op": "example",
    "path": "example",
    "from": "example",
    "value": "example"
  }
]

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
folderId
string format: uuid
nullable
ocr
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
language
required
string
nullable
textAngle
required
number format: double
nullable
orientation
required
string
nullable
regions
required
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
lines
required
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
words
required
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
text
required
string
nullable
fileDate
string format: date-time
nullable
uri
string
nullable
thumbnailUri
string
nullable
originalUri
string
nullable
fileName
string
nullable
size
integer format: int64
nullable
mimeType
string
nullable
name
string
nullable
description
string
nullable
provider
string
nullable
providerExternalId
string
nullable
author
string
nullable

Example generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "folderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "ocr": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "language": "example",
      "textAngle": 1,
      "orientation": "example",
      "regions": [
        {
          "fields": {
            "additionalProperty": {
              "value": "example",
              "valueType": "example"
            }
          },
          "accessibility": "example",
          "lines": [
            {
              "fields": {
                "additionalProperty": {
                  "value": "example",
                  "valueType": "example"
                }
              },
              "accessibility": "example",
              "words": [
                {
                  "fields": {
                    "additionalProperty": {
                      "value": "example",
                      "valueType": "example"
                    }
                  },
                  "accessibility": "example",
                  "text": "example"
                }
              ]
            }
          ]
        }
      ]
    },
    "fileDate": "2026-04-15T12:00:00Z",
    "uri": "example",
    "thumbnailUri": "example",
    "originalUri": "example",
    "fileName": "example",
    "size": 1,
    "mimeType": "example",
    "name": "example",
    "description": "example",
    "provider": "example",
    "providerExternalId": "example",
    "author": "example"
  }
}

204

Section titled “204”

No Content: done, with no item to return.

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

Conflict: the item kept changing under concurrent writes; read it again and retry.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

422

Section titled “422”

Unprocessable: the body or the change is invalid. The errors are keyed by member.

Media typeapplication/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object
errors
object
key
additional properties
Array<string>
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "status": 1,
  "title": "example",
  "type": "example"
}