OSF APIv2 Documentation, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.test.osf.io/v2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
OSF APIv2 Documentation, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Root #### Returns A JSON object with `meta` and `links` keys. The `meta` key contains information such as a w |
GET | /actions/ | Actions A log can have one of many actions. The complete list of loggable actions (in the format {identifier}: |
GET | /addons/ | List all addons A paginated list of addons configurable with the OSF, for read purposes only. #### Returns Ret |
GET | /citations/styles/ | List all citation styles A paginated list of all standard citation styles available for rendering citations. # |
GET | /citations/styles/{style_id}/ | Retrieve a citation style Retrieves the details of a citation style. #### Returns Returns a JSON object with a |
GET | /collections/ | List all Collections Retrieves a list collections, either public or related to the user #### Permissions Anony |
POST | /collections/ | Create a Collection Retrieves a list collections, either public or related to the user #### Permissions Anonym |
GET | /collections/{collection_id}/ | Retrieve a Collection Retrieves a collection, if the user has appropriate permissions. #### Permissions Anony |
DELETE | /collections/{collection_id}/ | Delete a Collection Deletes a collection, if the user has appropriate permissions. #### Permissions Users must |
GET | /collections/{collection_id}/collected_metadata/ | Retrieve a list of collected metadata for a collection List of user created metadata for entities within a col |
POST | /collections/{collection_id}/collected_metadata/ | Add Metadata or Subjects to a Entity in a Collection List of user created metadata for entities within a colle |
GET | /collections/{collection_id}/collected_metadata/{cgm_id} | Retrieve Specific Metadata for a Collection #### Permissions In order to view this metadata it must be public |
POST | /collections/{collection_id}/collected_metadata/{cgm_id} | Add Metadata or Subjects to an Entity in a Collection List of user created metadata for entities within a coll |
DELETE | /collections/{collection_id}/collected_metadata/{cgm_id} | Delete Collection Metadata from entitiy #### Permissions Only a user with collection admin permissions can del |
GET | /collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/ | Retrieve subject metadata for a specific piece of metadata in a collection #### Permissions This is public for |
POST | /collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/ | Update subjects for a specific piece of metadata in a collection #### Permissions This is editable for a user |
GET | /collections/{collection_id}/collected_metadata/{cgm_id}/subjects/ | Retrieve subject data for a specific piece of metadata info for a collection #### Permissions In order to view |
GET | /collections/{collection_id}/linked_nodes | List All Linked Nodes for a Collection List of all nodes linked to the given collection. #### Permissions This |
GET | /collections/{collection_id}/linked_nodes/relationships/ | Give a Sparse List of Node Ids List of all the node ids linked to the given collection. #### Permissions This |
POST | /collections/{collection_id}/linked_nodes/relationships/ | Link Nodes to Collection This endpoint allow users to a add a node to a collection by issuing a POST request. |
DELETE | /collections/{collection_id}/linked_nodes/relationships/ | Remove Nodes From Collection This removes associated nodes from a collection #### Permissions Any user with wr |
GET | /collections/{collection_id}/linked_preprints/ | List All Linked Preprints for a Collection List of all preprints linked to the given collection. #### Permissi |
GET | /collections/{collection_id}/linked_registrations/ | List All Linked Registrations for a Collection List of all registrations linked to the given collection. #### |
GET | /collections/{collection_id}/linked_registrations/relationships/ | Give a Sparse List of Registrations Ids List of all the registration ids linked to the given collection. #### |
POST | /collections/{collection_id}/linked_registrations/relationships/ | Link Registrations to Collection This endpoint allow users to a add a registration to a collection by issuing |
DELETE | /collections/{collection_id}/linked_registrations/relationships/ | Remove Registrations From Collection This removes associated registrations from a collection #### Permissions |
GET | /comments/{comment_id}/ | Retrieve a comment Retrieves the details of a comment #### Returns Returns a JSON object with a `data` key con |
PUT | /comments/{comment_id}/ | Update a comment Updates the specified comment by setting the values of the parameters passed. Any parameters |
DELETE | /comments/{comment_id}/ | Delete a comment Deletes a comment. This action can be undone by setting deleted to False in a comment update |
GET | /draft_registrations/ | Retrieve a list of Draft Registrations Retrieve a list of all currently available Draft Registrations for that |
POST | /draft_registrations/ | Create a Draft Registration This creates a Draft Registration that can be used to edit and register research. |
GET | /draft_registrations/{draft_id}/ | Retrieve a Draft Registration Retrieve the details of a given Draft Registration Draft Registrations contain R |
PATCH | /draft_registrations/{draft_id}/ | Update a Draft Registration Updates a Draft Registration by setting the values of the attributes specified in |
DELETE | /draft_registrations/{draft_id}/ | Delete a draft registration Permanently deletes a draft registration. A draft that has already been registered |
GET | /draft_registrations/{draft_id}/contributors/ | Retreive a list Contributors from a Draft Registration Retrieves the details of all given Contributors for a D |
POST | /draft_registrations/{draft_id}/contributors/ | Add a contributor to a Draft Registration Adds a contributor to a Draft Registration, contributors can view, e |
GET | /draft_registrations/{draft_id}/contributors/{user_id}/ | Retreive a Contributor from a Draft Registration Retrieves the details of a given contributor. Contributors a |
GET | /draft_registrations/{draft_id}/institutions/ | Retrieve Institutions afilliated with a Draft Registration Once a properly authenticated user has marked their |
GET | /draft_registrations/{draft_id}/subjects/ | Retrieve Subjects associated with a Draft Registration This retrieves a list of subjects associated with a Dra |
GET | /files/{file_id}/ | Retrieve a file Retrieves the details of a file (or folder) #### Returns Returns a JSON object with a `data` k |
and 116 more operation(s) in this specification, all searchable.
specification origin: http://developer.osf.io/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.