This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
List all references in the given project
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:filesystem-read.
string (enum)Filter references by type. If not provided, all references are returned.
Enum values: EXTERNAL, FILESYSTEM
integerThe page size to use for the endpoint.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
booleanEnables the use of preview functionality.
objectlist<ProjectResourceReference>stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references?referenceType=EXTERNAL&preview=true"1
2
3
{
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}| Error Name | ||
|---|---|---|
Project | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Project could not be found. | |
| Parameters | projectRid | |
See Errors for a general overview of errors in the platform.