BLbluestaq
File/Folder Operations

PATCH /scs/v2/update

Changed on

Update folders and files. For a folder, you may update description, writeAcl, readAcl, classificationMarking, and tags. For a file, you may update description, classificationMarking, and tags. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/scs/v2/update
  • Auth
    none declared

Query parameters

pathstring required

The complete path for the object to be updated.

sendNotificationboolean

Whether or not to send a notification that the target file/folder was updated.

Request body

idstring

Unique identifier for document.

classificationMarkingstring

Classification marking of the folder or file in IC/CAPCO portion-marked format.

createdBystring

The creator of this document. Can be a person or a software entity.

createdAtstring

The time at which this document was created, represented in UTC ISO format.

updatedBystring

The person or software entity who updated this document most recently.

updatedAtstring

The time at which this document was most recently updated, represented in UTC ISO format.

filenamestring

The name of this document. Applicable to files and folders.

filePathstring

The absolute path to this document.

parentPathstring

The parent folder of this document. If this document is a root-level folder then the parent path is "/".

pathType'file' | 'folder'

The type of this document.

keywordsstring

Optional. Any keywords associated with this document. Only applicable to files whose contents are indexed (e.g. text files, PDFs).

descriptionstring

Optional description for the file or folder.

readAclstring

For folders only. Comma separated list of user and group ids that should have read access on this folder and the items nested in it.

writeAclstring

For folders only. Comma separated list of user and group ids that should have write access on this folder and the items nested in it.

tagsstring[]

Array of provider/source specific tags for this data, used for implementing data owner conditional access controls to restrict access to the data.

sizeinteger

Size of this document in bytes.

deleteOninteger

Time at which this document should be automatically deleted. Represented in milliseconds since Unix epoch.

Example request

{
  "id": "/my-folder/",
  "classificationMarking": "U",
  "createdBy": "John.Doe",
  "createdAt": "2025-07-03T16:27:57.970Z",
  "updatedBy": "John.Doe",
  "updatedAt": "2025-07-03T16:27:57.970Z",
  "filename": "my-folder",
  "filePath": "/my-folder/sub-folder/",
  "parentPath": "/",
  "readAcl": "user.id1,group.id1",
  "writeAcl": "user.id1,group.id1",
  "tags": [
    "TAG1",
    "TAG2"
  ],
  "attachment": {
    "date": "2025-07-03T16:27:57.970Z",
    "content_type": "text/plain",
    "author": "John.Doe",
    "language": "en"
  }
}

Response

Success

Changes

  • 09bd422d5ac1Revision changes
    • info

      added the non-success response with the status

  • 45631f9bb3f0Revision changes
    • info

      api tag File/Folder Operations added

    • info

      api tag SCS V2 removed

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

Some revisions have not been checked yet.