Return a metadata archive for the requested folder

get/commons/catalog/folders/{folderId}
Internal-Use Only

This endpoint is used by the catalog service to retrieve information from a folder so that the members can be searched and displayed.

Request Samples

1

Response Samples

1{
2  "anchor": {
3    "uri": "/folders/folders/0c7ebcc1-b1b9-41b9-967d-a345bda1edaf"
4  },
5  "entities": [
6    {
7      "creationTimeStamp": "0001-01-01T00:00:00Z",
8      "modifiedTimeStamp": "0001-01-01T00:00:00Z",
9      "instanceId": "0c7ebcc1-b1b9-41b9-967d-a345bda1edaf",
10      "name": "My Folder",
11      "type": "folder",
12      "uri": "/folders/folders/0c7ebcc1-b1b9-41b9-967d-a345bda1edaf"
13    },
14    {
15      "creationTimeStamp": "0001-01-01T00:00:00Z",
16      "modifiedTimeStamp": "0001-01-01T00:00:00Z",
17      "anchor": {
18        "uri": "/files/files/a3906381-17d0-48ba-bbd6-9664cb97898d"
19      },
20      "name": "fiddle1.jpg",
21      "type": "file",
22      "uri": "/files/files/a3906381-17d0-48ba-bbd6-9664cb97898d"
23    }
24  ],
25  "relationships": [
26    {
27      "creationTimeStamp": "0001-01-01T00:00:00Z",
28      "modifiedTimeStamp": "0001-01-01T00:00:00Z",
29      "type": "itemFolder",
30      "endpoint1Uri": "/folders/folders/0c7ebcc1-b1b9-41b9-967d-a345bda1edaf",
31      "endpoint2Uri": "/files/files/a3906381-17d0-48ba-bbd6-9664cb97898d"
32    }
33  ],
34  "version": 1
35}

Path Parameters

NameTypeRequiredDescription
folderId
string
true

The identifier of the folder to catalog.

Responses

StatusMeaningDescription
200OKThe request was successfully processed. The body contains the resulting metadata archive.Schema