BLbluestaq
File/Folder Operations

GET /scs/v2/list

Changed on

Returns a list of ScsEntity objects, each directly nested under the provided path.

Request

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

Query parameters

orderstring

The order in which entries should be sorted.

pathstring required

The base path to list.

searchAfterstring

The starting point for pagination results, usually set to the value of the SEARCH_AFTER header returned in the previous request.

sizeinteger

The number of results to retrieve.

sortstring

The field on which to sort entries.

firstResultinteger
maxResultsinteger

Response

Success

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 response

[
  {
    "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"
    }
  }
]

Changes

  • 09bd422d5ac1Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 45631f9bb3f0Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new file enum value to the / response property for the response status

    • warning

      added the new folder enum value to the / response property for the response status

    • info

      api tag File/Folder Operations added

    • info

      api tag SCS V2 removed

    • info

      added the new optional query request parameter order

    • info

      added the new optional query request parameter searchAfter

    • info

      added the new optional query request parameter size

    • info

      added the new optional query request parameter sort

    • info

      added the optional property / to the response with the status

    • info

      added to the / response property allOf list for the response status

Some revisions have not been checked yet.