files

Set File Ranks Batch

Set the rank of several files of one object in a single request. All writes share the request-scoped transaction (get_db_session), so a failure on any file rolls back the whole batch — a reorder is applied atomically instead of leaving documents half-reordered.

PUT

/api/files/{company_name}/{permission_object_type}/{permission_object_id}/{object_type}/{object_id}/documentmeta

curl --request PUT \
  --url '/api/files/{company_name}/{permission_object_type}/{permission_object_id}/{object_type}/{object_id}/documentmeta' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "filepath": "<string>",
    "rank": "<string>"
  }
]
'

{
  "detail": "<string>"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_namestringrequired

permission_object_typeenum<string>required

Available options: machines, templates, chat

permission_object_idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

object_typeenum<string>required

object_idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

Body

itemsobject[]

Show child attributes

Response

Successful Response

detailstringrequired