Collections

Retrieve Specific Metadata for a Collection

Permissions

In order to view this metadata it must be public or a user must have read permissions for collection.

Returns

Returns a JSON object containing data and links keys.

The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for pagination.

Errors

This request should never return an error.

get/collections/{collection_id}/collected_metadata/{cgm_id}

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/collections/{collection_id}/collected_metadata/{cgm_id}
  • Auth
    none declared

Path parameters

collection_idstring required

A short id for that collection

cgm_idstring required

A short id for that piece of metadata

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.