Get history operations for file

note

[Since 2.3]

POST /api/v1/{fileId}/history HTTP/1.1

Path parameters

Parameter	Description
`fileId`	The ID of the file.
`offset`	Offset of operations, used for pagination. By default = 0.
`limit`	Limit of operations, used for pagination. By default = 0.
`period`	Time period for operations.

Example request

curl 'http://localhost:8080/api/v1/files/c50b0133-ac62-4a0f-af73- 1220eff26a74/history?offset=0&limit=5&period=3600' -i -X GET \
-H 'X-co-auth-token: 66d5a198d7eb4ecc239952bca46248ec'

Example response headers

HTTP/1.1 200 OK
X-co-request-id: kjjzfKBDUQQ25re3merMp4T0Pup95XuO
Content-Type: application/json
Content-Length: 1626
[ content of the response is skipped ]

Response fields

Path	Type	Description
`[]`	Array	Array of `HistoryOperation` objects.
`[].operationTime`	String	The time of creation of operation (formatted ISO 8601 timestamp).
`[].publicLinkExpirationTime`	Data	The time of expiration of the public link (formatted ISO 8601 timestamp).
`[].publicLinkBlockedUntilTime`	Data	The blocked until time of the public link (formatted ISO 8601 timestamp).
`[].historyOperationType`	String	Type of history opertaion.
`[].fileName`	String	File name.
`[].destinationDirId`	String	Destination directory id.
`[].destinationDirName`	String	Destination directory name.
`[].oldName`	String	Old name of file.
`[].isPasswordProtected`	Boolean	Mark of password protected.
`[].byAdmin`	Boolean	Mark of admin operation.
`[].userProfile.avatarId`	String	User avatar id
`[].userProfile.email`	String	User email.
`[].userProfile.firstName`	String	First name of user
`[].userProfile.isDeleted`	Boolean	User is deleted
`[].userProfile.id`	String	Unique identifier of user
`[].userProfile.lastName`	String	Last name of user
`[].userProfile.login`	String	User login.
`[].userProfile.middleName`	String	Middle name of user
`[].recipient.role`	String	The primary role for this user
`[].recipient.recipientType`	String	Recipient type
`[].recipient.groupName`	String	Name of the group
`[].recipient.userProfile`	Object	User profile structire
`[].recipient.userProfile.avatarId`	String	User avatar Id
`[].recipient.userProfile.email`	String	User email
`[].recipient.userProfile.firstName`	String	First name of user
`[].recipient.userProfile.isDeleted`	String	Flag user is deleted
`[].recipient.userProfile.id`	String	Unique identifier of user
`[].recipient.userProfile.lastName`	String	Last name of user
`[].recipient.userProfile.login`	String	User login
`[].recipient.userProfile.middleName`	String	Middle name of user

Example response

HTTP/1.1 200 OK
X-co-request-id: kjjzfKBDUQQ25re3merMp4T0Pup95XuO
Content-Type: application/json
Content-Length: 1380

[
  {
    "operationTime": "2022-11-14T11:48:31.000Z",
    "publicLinkExpirationTime": "2022-11-14T11:48:31.000Z",
    "userProfile": {
      "avatarId": "a00bbb30-993e-4632-925f-152939195049",
      "isDeleted": false,
      "email": "testsrvdocs@srv-one.tacos.devoffice.ru",
      "firstName": "testsrvdocs",
      "lastName": "testsrvdocs",
      "login": "testsrvdocs@srv-one.tacos.devoffice.ru",
      "middleName": "testsrvdocsich",
      "id": "f904-89D3-A1234",
      "userRole": "user"
    },
    "historyOperationType": "share_object",
    "recipient": {
      "role": "editor",
      "recipientType": "user",
      "userProfile": {
        "avatarId": " a00bbb30-993e-4632-925f-152939195049",
        "isDeleted": false,
        "email": "testsr@srv-one.ta.dev.ru",
        "firstName": "testsrvdocs2",
        "lastName": "testsrvdocs2",
        "login": "testsrvdocs2@srv-one.tacos.devoffice.ru",
        "middleName": "testsrvdocsich",
        "id": "f904-89D3-A1234",
        "userRole": "user"
      }
    }
  },
  {
    "operationTime": "2022-11-14T11:48:31.000Z",
    "userProfile": {
      "avatarId": "a00bbb30-993e-4632-925f-152939195049",
      "isDeleted": false,
      "email": "testsrvdocs@srv-one.tacos.devoffice.ru",
      "firstName": "testsrvdocs",
      "lastName": "testsrvdocs",
      "login": "testsrvdocs@srv-one.tacos.devoffice.ru",
      "middle_name": "testsrvdocs2ich",
      "id": "f904-89D3-A1235",
      "userRole": "user"
    },
    "historyOperationType": "create_public_link",
    "isPasswordProtected": true
  },
  {
    "operationTime": "2022-11-14T11:48:30.000Z",
    "userProfile": {
      "avatarId": "a00bbb30-993e-4632-925f-152939195049",
      "isDeleted": false,
      "email": "testsrvdocs@srv-one.tacos.devoffice.ru",
      "firstName": "testsrvdocs",
      "lastName": "testsrvdocs",
      "login": "testsrvdocs@srv-one.tacos.devoffice.ru",
      "middleName": "testsrvdocsich",
      "id": "f904-89D3-A1236",
      "userRole": "user"
    },
    "historyOperationType": "upload_document"
  }
]