{"note":"OpenAPI conversion -- returning structured metadata","name":"osf-io","description":"OSF APIv2 Documentation","version":"2.0","base_url":"https://api.test.osf.io/v2","endpoints":343,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api OSF APIv2 Documentation\n@base https://api.test.osf.io/v2\n@version 2.0\n@endpoints 343\n@hint download_for_search\n@toc addons(1), root(1), citations(2), comments(2), files(5), licenses(1), license(1), logs(1), actions(5), institutions(11), schemas(2), schema_responses(10), nodes(65), preprints(24), preprint_providers(11), providers(37), registrations(39), draft_registrations(17), taxonomies(2), users(28), view_only_links(2), wikis(5), collections(21), collection_submissions(1), collection_submission_actions(2), provider(8), requests(2), resources(5), subjects(3), guids(1), custom_file_metadata_records(2), custom_item_metadata_records(2), subscriptions(3), registration_subscriptions(2), collection_subscriptions(2), regions(2), tokens(5), applications(6), scopes(2), identifiers(2)\n\n@group addons\n@endpoint GET /addons/\n@desc List all addons\n@returns(200) OK\n\n@endgroup\n\n@group root\n@endpoint GET /\n@desc Root\n@returns(200) OK\n\n@endgroup\n\n@group citations\n@endpoint GET /citations/styles/\n@desc List all citation styles\n@returns(200) OK\n\n@endpoint GET /citations/styles/{style_id}/\n@desc Retrieve a citation style\n@required {style_id: any # The unique identifier of the citation style.}\n@returns(200) OK\n\n@endgroup\n\n@group comments\n@endpoint GET /comments/{comment_id}/\n@desc Retrieve a comment\n@required {comment_id: any # The unique identifier of the comment you wish to retrieve.}\n@returns(200) OK\n\n@endpoint DELETE /comments/{comment_id}/\n@desc Delete a comment\n@required {comment_id: any # The unique identifier of the comment you wish to delete.}\n@returns(204) No content\n\n@endgroup\n\n@group files\n@endpoint GET /files/{file_id}/\n@desc Retrieve a file\n@required {file_id: any # The unique identifier of the file you wish to retrieve.}\n@returns(200) OK\n\n@endpoint PATCH /files/{file_id}/\n@desc Update a file\n@required {file_id: any # The unique identifier of the file you wish to update., body: map}\n@returns(200) OK\n\n@endpoint GET /files/{file_id}/versions/\n@desc List all file versions\n@required {file_id: any # The unique identifier of the file from which you want to retrieve versions.}\n@returns(200) OK\n\n@endpoint GET /files/{file_id}/versions/{version_id}/\n@desc Retrieve a file version\n@required {file_id: any # The unique identifier of the file from which you want to retrieve versions., version_id: any # The file version number you want to retrieve.}\n@returns(200) OK\n\n@endgroup\n\n@group licenses\n@endpoint GET /licenses/\n@desc List all licenses\n@returns(200) OK\n\n@endgroup\n\n@group license\n@endpoint GET /license/{license_id}/\n@desc Retrieve a license\n@required {license_id: any # The unique identifier of the license.}\n@returns(200) OK\n\n@endgroup\n\n@group logs\n@endpoint GET /logs/{log_id}/\n@desc Retrieve a log\n@required {log_id: any # The unique identifier of the log you wish to retrieve.}\n@returns(200)\n\n@endgroup\n\n@group actions\n@endpoint GET /actions/\n@desc Actions\n@returns(200) OK\n\n@endgroup\n\n@group institutions\n@endpoint GET /institutions/\n@desc List all institutions\n@returns(200) OK\n\n@endpoint GET /institutions/{institution_id}/\n@desc Retrieve an institution\n@required {institution_id: any # The unique identifier of the institution you wish to retrieve.}\n@returns(200) OK\n\n@endpoint GET /institutions/{institution_id}/users/\n@desc List all affiliated users\n@required {institution_id: any # The unique identifier of the institution you wish to retrieve.}\n@returns(200) OK\n\n@endpoint GET /institutions/{institution_id}/nodes/\n@desc List all affiliated nodes\n@required {institution_id: any # The unique identifier of the institution you wish to retrieve.}\n@returns(200) OK\n\n@endpoint GET /institutions/{institution_id}/registrations/\n@desc List all affiliated registrations\n@required {institution_id: any # The unique identifier of the institution you wish to retrieve.}\n@returns(200) OK\n\n@endpoint GET /institutions/{institution_id}/relationships/nodes/\n@desc List nodes affiliated with an institution (relationship data)\n@required {institution_id: any # The unique identifier of the institution.}\n@returns(200) Successfully retrieved node relationships.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view this institution's nodes., 404: Institution not found.}\n\n@endpoint POST /institutions/{institution_id}/relationships/nodes/\n@desc Add node relationships to an institution\n@required {institution_id: any # The unique identifier of the institution., body: map # List of node relationships to add.}\n@returns(201) Nodes successfully affiliated with institution.\n@returns(204) No changes made (nodes already affiliated).\n@errors {400: Invalid request payload., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to affiliate these nodes., 404: Institution not found.}\n\n@endpoint DELETE /institutions/{institution_id}/relationships/nodes/\n@desc Remove node relationships from an institution\n@required {institution_id: any # The unique identifier of the institution., body: map # List of node relationships to remove.}\n@returns(204) Nodes successfully removed from affiliation.\n@errors {400: Invalid request payload., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to modify these nodes., 404: Institution not found.}\n\n@endpoint GET /institutions/{institution_id}/relationships/registrations/\n@desc List registrations affiliated with an institution (relationship data)\n@required {institution_id: any # The unique identifier of the institution.}\n@returns(200) Successfully retrieved registration relationships.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view this institution's registrations., 404: Institution not found.}\n\n@endpoint POST /institutions/{institution_id}/relationships/registrations/\n@desc Add registration relationships to an institution\n@required {institution_id: any # The unique identifier of the institution., body: map # List of registration relationships to add.}\n@returns(201) Registrations successfully affiliated with institution.\n@returns(204) No changes made (registrations already affiliated).\n@errors {400: Invalid request payload., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to affiliate these registrations., 404: Institution not found.}\n\n@endpoint DELETE /institutions/{institution_id}/relationships/registrations/\n@desc Remove registration relationships from an institution\n@required {institution_id: any # The unique identifier of the institution., body: map # List of registration relationships to remove.}\n@returns(204) Registrations successfully removed from affiliation.\n@errors {400: Invalid request payload., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to modify these registrations., 404: Institution not found.}\n\n@endgroup\n\n@group schemas\n@endpoint GET /schemas/registrations/\n@desc Retrieve a list of Registration Schemas\n@returns(200) OK\n\n@endpoint GET /schemas/registrations/{registration_schema_id}\n@desc Retrieve a Registration Schema\n@required {registration_schema_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.}\n@returns(200) OK\n\n@endgroup\n\n@group schema_responses\n@endpoint GET /schema_responses/\n@desc List all Schema Responses\n@returns(200) OK\n\n@endpoint POST /schema_responses/\n@desc Create a new Schema Response\n@required {body: map}\n@returns(201) OK\n\n@endpoint GET /schema_responses/{schema_response_id}\n@desc Retrieve a Schema Response\n@required {schema_response_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.}\n@returns(200) OK\n\n@endpoint PATCH /schema_responses/{schema_response_id}\n@desc Update a Registration's Schema Response\n@required {schema_response_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`., body: map}\n@returns(201) OK\n\n@endpoint DELETE /schema_responses/{schema_response_id}\n@desc Delete a Incomplete Schema Response\n@required {schema_response_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.}\n@returns(204) No Content\n\n@endpoint GET /schema_responses/{schema_response_id}/actions/\n@desc Retrieve a list of Schema Response Actions for a Schema Response\n@required {schema_response_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.}\n@returns(200) OK\n\n@endpoint POST /schema_responses/{schema_response_id}/actions/\n@desc Create a new Schema Response Action\n@required {schema_response_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.}\n@returns(201) OK\n\n@endpoint GET /schema_responses/{schema_response_id}/actions/{schema_response_action_id}\n@desc A Schema Response Action from a Schema Response\n@required {schema_response_id: any # The unique identifier of the Schema Response example `61b9cd62eb66180215222669`., schema_response_action_id: any # The unique identifier of the Schema Response Action example `61b9eae1a7d8ac025c4c46d3`.}\n@returns(200) OK\n\n@endpoint GET /schema_responses/{schema_response_id}/schema_blocks/\n@desc Retrieve a list of Registration Schema Blocks for a Schema Response\n@required {schema_response_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.}\n@returns(200) OK\n\n@endpoint GET /schema_responses/{schema_response_id}/schema_blocks/{schema_response_block_id}\n@desc Retrieve a Registration Schema Block\n@required {schema_response_id: any # The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`., schema_response_block_id: any # The unique identifier of the Schema Response Block example `61b79f9eadbb5701424a2d5e`.}\n@returns(200) OK\n\n@endgroup\n\n@group nodes\n@endpoint GET /nodes/\n@desc List all nodes\n@returns(200) OK\n\n@endpoint POST /nodes/\n@desc Create a node\n@required {body: map}\n@returns(201) Success\n\n@endpoint GET /nodes/{node_id}/\n@desc Retrieve a node\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint PATCH /nodes/{node_id}/\n@desc Update a node\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) OK\n\n@endpoint DELETE /nodes/{node_id}/\n@desc Delete a node\n@required {node_id: any # The unique identifier of the node.}\n@returns(204) No content\n\n@endpoint GET /nodes/{node_id}/addons/\n@desc List all addons\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/addons/{provider}/folders/\n@desc List all addon folders\n@required {node_id: any # The unique identifier of the node., provider: any # The unique identifier of the provider}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/addons/{provider}/\n@desc Retrieve an addon\n@required {node_id: any # The unique identifier of the node., provider: any # The unique identifier of the addon.}\n@returns(200) OK\n\n@endpoint PATCH /nodes/{node_id}/addons/{provider}/\n@desc Update an addon\n@required {node_id: any # The unique identifier of the node., provider: any # The unique identifier of the addon., body: map}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/children/\n@desc List all child nodes\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint POST /nodes/{node_id}/children/\n@desc Create a child node\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(201) Created\n\n@endpoint GET /nodes/{node_id}/citation/\n@desc Retrieve citation details\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/citation/{style_id}/\n@desc Retrieve a styled citation\n@required {style_id: any # The unique identifier of the citation style., node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/comments/\n@desc List all comments\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint POST /nodes/{node_id}/comments/\n@desc Create a comment\n@required {node_id: any # The unique identifier of the node you want to comment on., body: map}\n@returns(201) Success\n\n@endpoint GET /nodes/{node_id}/contributors/\n@desc List all contributors\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint POST /nodes/{node_id}/contributors/\n@desc Create a contributor\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(201) Success\n\n@endpoint GET /nodes/{node_id}/contributors/{user_id}/\n@desc Retrieve a contributor\n@required {node_id: any # The unique identifier of the node., user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint PATCH /nodes/{node_id}/contributors/{user_id}/\n@desc Update a contributor\n@required {node_id: any # The unique identifier of the node., user_id: any # The unique identifier of the user., body: map}\n@returns(200) OK\n\n@endpoint DELETE /nodes/{node_id}/contributors/{user_id}/\n@desc Delete a contributor\n@required {node_id: any # The unique identifier of the node., user_id: any # The unique identifier of the user.}\n@returns(204) No content\n\n@endpoint GET /nodes/{node_id}/draft_registrations/\n@desc List all draft registrations\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint POST /nodes/{node_id}/draft_registrations/\n@desc Create a draft registration based on your current project Node.\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(201) Created\n\n@endpoint GET /nodes/{node_id}/draft_registrations/{draft_id}/\n@desc Retrieve a Draft Registration\n@required {node_id: any # The unique identifier of the node., draft_id: any # The unique identifier of the draft registration.}\n@returns(200) OK\n\n@endpoint PATCH /nodes/{node_id}/draft_registrations/{draft_id}/\n@desc Update a draft registration\n@required {node_id: any # The unique identifier of the node., draft_id: any # The unique identifier of the draft registration., body: map}\n@returns(200) OK\n\n@endpoint DELETE /nodes/{node_id}/draft_registrations/{draft_id}/\n@desc Delete a draft registration\n@required {node_id: any # The unique identifier of the node., draft_id: any # The unique identifier of the draft registration.}\n@returns(204) No Content\n\n@endpoint GET /nodes/{node_id}/files/\n@desc List all storage providers\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/files/providers/{provider}/\n@desc Retrieve a storage provider\n@required {node_id: any # The unique identifier of the node., provider: any # The unique identifier of the storage provider.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/files/{provider}/\n@desc List all node files\n@required {node_id: any # The unique identifier of the node., provider: any # The unique identifier of the storage provider.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/files/{provider}/{path}/\n@desc Retrieve a file\n@required {node_id: any # The unique identifier of the node., provider: any # The unique identifier of the storage provider., path: any # The unique identifier of the file path.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/identifiers/\n@desc Retrieve Identifiers for a Node\n@required {node_id: any # The unique identifier of the node for which you want to retrieve associated identifiers.}\n@returns(200) Successful retrieval of identifiers.\n\n@endpoint POST /nodes/{node_id}/identifiers/\n@desc Mint a New Identifier for a Node\n@required {node_id: any # The unique identifier of the node for which you want to create an identifier.}\n@returns(201) Identifier successfully created.\n@errors {400: Bad Request. Possible reasons include:  - The node already has a DOI identifier.  - The requested identifier category is not supported (only `doi` is allowed).  - The node is not eligible for DOI creation (e.g., it's a folder or collection)., 403: Forbidden. You do not have permission to create identifiers on this node. This may occur if:  - The node is private.  - You do not have Admin or Write access to the node., 404: Node not found. Verify the node ID is correct and that you have permission to view the node.}\n\n@endpoint GET /nodes/{node_id}/institutions/\n@desc List all institutions\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint POST /nodes/{node_id}/forks/\n@desc Create a fork of this node\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(201) Created\n\n@endpoint GET /nodes/{node_id}/forks/\n@desc List all forks of this node\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/linked_nodes/\n@desc List all linked nodes\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/logs/\n@desc List all logs\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/preprints/\n@desc List all preprints\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/registrations/\n@desc List all registrations\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/view_only_links/\n@desc List all view only links\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/view_only_links/{link_id}/\n@desc Retrieve a view only link\n@required {node_id: any # The unique identifier of the node., link_id: any # The unique identifier of the view only link.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/wikis/\n@desc List all wikis\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endpoint GET /nodes/{node_id}/linked_by_nodes/\n@desc List Nodes Linking to a Node\n@required {node_id: any # The unique identifier of the node to look up linked nodes for.}\n@returns(200) A paginated list of nodes linking to the specified node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view nodes linking to this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/linked_by_registrations/\n@desc List Registrations Linking to a Node\n@required {node_id: any # The unique identifier of the node to look up linked registrations for.}\n@optional {page: any # Page number of the results to return (pagination)., filter: any # Filter results by registration attributes (e.g., `filter[title]=example`)., sort: any # Sort the returned registrations. - `date_created`: Sort by creation date. - `title`: Sort alphabetically by title.}\n@returns(200) A paginated list of registrations linking to the node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view registrations linking to this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/relationships/institutions/\n@desc Retrieve relationships between a Node and its affiliated Institutions\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) Successfully retrieved affiliated institutions for the node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view institutions for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint PATCH /nodes/{node_id}/relationships/institutions/\n@desc Replace relationships between a Node and its affiliated Institutions\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully replaced affiliated institutions for the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify institutions for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint POST /nodes/{node_id}/relationships/institutions/\n@desc Add relationships between a Node and Institutions\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully added affiliated institutions to the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify institutions for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint DELETE /nodes/{node_id}/relationships/institutions/\n@desc Remove relationships between a Node and Institutions\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(204) Successfully removed affiliated institutions from the node. No content returned.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify institutions for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/relationships/linked_nodes/\n@desc Retrieve relationships between a Node and its linked Nodes\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) Successfully retrieved linked nodes for the node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view linked nodes for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint PATCH /nodes/{node_id}/relationships/linked_nodes/\n@desc Replace relationships between a Node and its linked Nodes\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully replaced linked nodes for the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify linked nodes for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint POST /nodes/{node_id}/relationships/linked_nodes/\n@desc Add relationships between a Node and linked Nodes\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully added linked nodes to the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify linked nodes for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint DELETE /nodes/{node_id}/relationships/linked_nodes/\n@desc Remove relationships between a Node and linked Nodes\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(204) Successfully removed linked nodes from the node. No content returned.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify linked nodes for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/relationships/linked_registrations/\n@desc Retrieve relationships between a Node and its linked Registrations\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) Successfully retrieved linked registrations for the node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view linked registrations for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint PATCH /nodes/{node_id}/relationships/linked_registrations/\n@desc Replace relationships between a Node and linked Registrations\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully replaced linked registrations for the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify linked registrations for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint POST /nodes/{node_id}/relationships/linked_registrations/\n@desc Add relationships between a Node and linked Registrations\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully added linked registrations to the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify linked registrations for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint DELETE /nodes/{node_id}/relationships/linked_registrations/\n@desc Remove relationships between a Node and linked Registrations\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(204) Successfully removed linked registrations from the node. No content returned.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify linked registrations for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/relationships/subjects/\n@desc Retrieve the relationships between a Node and its Subjects\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) Successfully retrieved the subject relationships for the node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view subjects on this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint PATCH /nodes/{node_id}/relationships/subjects/\n@desc Update the relationships between a Node and its Subjects\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully updated the subject relationships for the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify subjects on this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint POST /nodes/{node_id}/relationships/subjects/\n@desc Add relationships between a Node and Subjects\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Successfully added subjects to the node.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify subjects on this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint DELETE /nodes/{node_id}/relationships/subjects/\n@desc Remove relationships between a Node and Subjects\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(204) Successfully deleted the subject relationship(s) from the node. No content returned.\n@errors {400: Bad Request. The submitted data is invalid., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify subjects on this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/requests/\n@desc List Requests for a Node\n@required {node_id: any # The unique identifier of the node.}\n@optional {filter[type]: any # Filter requests by type (e.g., `withdrawal`, `registration`)., filter[state]: any # Filter requests by current state (e.g., `pending`, `accepted`, `rejected`).}\n@returns(200) Successfully retrieved the list of requests for the node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access requests for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/settings/\n@desc Retrieve Node Settings\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) Successfully retrieved node settings.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access node settings., 404: Not Found. No node matches the given ID.}\n\n@endpoint PATCH /nodes/{node_id}/settings/\n@desc Update Node Settings\n@required {node_id: any # The unique identifier of the node., body: map}\n@returns(200) Node settings successfully updated.\n@errors {400: Bad Request. Invalid input was provided., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify node settings., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/storage/\n@desc List Storage Providers for a Node\n@required {node_id: any # The unique identifier of the node.}\n@optional {page: any # Page number of results to retrieve., embed: any # Comma-separated list of related resources to embed in the response.}\n@returns(200) Successful retrieval of storage providers for the specified node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view storage providers for this node., 404: Not Found. No node matches the given ID.}\n\n@endpoint GET /nodes/{node_id}/subjects/\n@desc List Subjects for a Node\n@required {node_id: any # The unique identifier of the node.}\n@optional {page: any # Page number of results to retrieve., filter: any # Filter subjects by specific fields.   Example: `filter[text]=biology`, embed: any # Comma-separated list of related resources to embed in the response.}\n@returns(200) Successful retrieval of subjects for the specified node.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view subjects for this node., 404: Not Found. No node matches the given ID.}\n\n@endgroup\n\n@group preprints\n@endpoint GET /preprints/\n@desc List all preprints\n@returns(200) OK\n\n@endpoint POST /preprints/\n@desc Create a preprint\n@required {data: map}\n@returns(201) Success\n\n@endpoint GET /preprints/{preprint_id}/versions/\n@desc List preprint versions\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) OK\n\n@endpoint POST /preprints/{preprint_id}/versions/\n@desc Create a preprint version\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(201) Success\n\n@endpoint GET /preprints/{preprint_id}/\n@desc Retrieve a preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) OK\n\n@endpoint PATCH /preprints/{preprint_id}/\n@desc Update a preprint\n@required {preprint_id: any # The unique identifier of the preprint., data: map}\n@returns(200) OK\n\n@endpoint GET /preprints/{preprint_id}/citation/\n@desc Retrieve citation details\n@required {preprint_id: any # The unique identifier of the preprint whose citation you wish to retrieve.}\n@returns(200)\n\n@endpoint GET /preprints/{preprint_id}/citation/{style_id}/\n@desc Retrieve a styled citation\n@required {style_id: any # The unique identifier of the citation style., preprint_id: any # The unique identifier of the preprint.}\n@returns(200)\n\n@endpoint GET /preprints/{preprint_id}/contributors/\n@desc List all Contributors for a Preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) OK\n\n@endpoint POST /preprints/{preprint_id}/contributors/\n@desc Create a Contributor\n@required {preprint_id: any # The unique identifier of the Preprint., body: map}\n@returns(201) Success\n\n@endpoint GET /preprints/{preprint_id}/contributors/{user_id}/\n@desc Retrieve a contributor\n@required {preprint_id: any # The unique identifier of the Preprint., user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint GET /preprints/{preprint_id}/bibliographic_contributors/\n@desc List all Bibliographic Contributors\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) OK\n\n@endpoint GET /preprints/{preprint_id}/institutions/\n@desc List all Institutional Affilations for a Preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) OK\n\n@endpoint GET /preprints/{preprint_id}/relationships/institutions/\n@desc List all Institutions for a Preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) Success\n\n@endpoint PUT /preprints/{preprint_id}/relationships/institutions/\n@desc Update a Preprints Institutional Affilation\n@required {preprint_id: any # The unique identifier of the Preprint., body: map}\n@returns(201) Success\n\n@endpoint GET /preprints/{preprint_id}/files/\n@desc List storage providers for a preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) Successful retrieval of storage providers.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view storage providers for this preprint., 404: Not Found. No preprint matches the given ID.}\n\n@endpoint GET /preprints/{preprint_id}/files/osfstorage/\n@desc List files for a preprint in osfstorage\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) Successful retrieval of files in osfstorage.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view these files., 404: Not Found. No preprint matches the given ID.}\n\n@endpoint GET /preprints/{preprint_id}/identifiers/\n@desc List identifiers for a preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) Successful retrieval of preprint identifiers.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view identifiers for this preprint., 404: Not Found. No preprint matches the given ID.}\n\n@endpoint GET /preprints/{preprint_id}/relationships/node/\n@desc Retrieve the relationship to the supplemental node of the preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(200) Successful retrieval of the node relationship.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view the supplemental node., 404: Not Found. No preprint matches the given ID.}\n\n@endpoint PATCH /preprints/{preprint_id}/relationships/node/\n@desc Update the relationship to the supplemental node of the preprint\n@required {preprint_id: any # The unique identifier of the preprint., body: map # The relationship data for the supplemental node.}\n@returns(200) Successfully updated the supplemental node relationship.\n@errors {400: Bad request. The node ID may be invalid or missing., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to update this relationship., 404: Not Found. No preprint or node matches the given ID.}\n\n@endpoint DELETE /preprints/{preprint_id}/relationships/node/\n@desc Remove the supplemental node relationship from the preprint\n@required {preprint_id: any # The unique identifier of the preprint.}\n@returns(204) Successfully removed the supplemental node relationship.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify this relationship., 404: Not Found. No preprint matches the given ID.}\n\n@endpoint POST /preprints/{preprint_id}/requests/\n@desc Create a Preprint Request\n@required {preprint_id: any # The unique identifier of the preprint to create a request for., body: map # The request object to be created.}\n@returns(201) Successfully created the preprint request.\n@errors {400: Bad request. Invalid input or missing fields., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to create a request., 404: Not Found. No preprint matches the given ID.}\n\n@endpoint GET /preprints/{preprint_id}/review_actions/\n@desc List Review Actions for a Preprint\n@required {preprint_id: any # The unique identifier of the preprint whose review actions are being requested.}\n@returns(200) Successful retrieval of review actions.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view these review actions., 404: Not Found. No preprint matches the given ID.}\n\n@endpoint GET /preprints/{preprint_id}/subjects/\n@desc List Preprint Subjects\n@required {preprint_id: any # The unique identifier of the preprint whose subjects are being requested.}\n@returns(200) Successful retrieval of preprint subjects.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view these subjects., 404: Not Found. No preprint matches the given ID.}\n\n@endgroup\n\n@group preprint_providers\n@endpoint GET /preprint_providers/\n@desc List all preprint providers\n@returns(200) OK\n\n@endpoint GET /preprint_providers/{provider_id}/\n@desc Retrieve a preprint provider\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@returns(200) OK\n\n@endpoint GET /preprint_providers/{provider_id}/preprints/\n@desc List all preprints\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@returns(200) OK\n\n@endpoint GET /preprint_providers/{provider_id}/taxonomies/\n@desc List Taxonomies for a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@returns(200) Successful retrieval of taxonomies for the preprint provider.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access taxonomies for this provider., 404: Not Found. No preprint provider matches the given ID.}\n\n@endpoint GET /preprint_providers/{provider_id}/taxonomies/highlighted/\n@desc List Highlighted Taxonomies for a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@returns(200) Successful retrieval of highlighted taxonomies.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access taxonomies for this provider., 404: Not Found. No preprint provider matches the given ID.}\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/preprints/{provider_id}/citation_styles/\n@desc List Citation Styles for a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@optional {filter[default]: any # Filter citation styles by whether they are marked as default., page: any # Page number of results to return (for pagination)., per_page: any # Number of results per page. Defaults to 10.}\n@returns(200) Successful retrieval of citation styles.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access citation styles for this provider., 404: Not Found. No preprint provider matches the given ID.}\n\n@endgroup\n\n@group preprint_providers\n@endpoint GET /preprint_providers/{provider_id}/licenses/\n@desc List all licenses\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@returns(200) OK\n\n@endpoint GET /preprint_providers/{provider_id}/moderators/\n@desc List Moderators for a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@optional {page: any # Page number of results to view., filter[permission_group]: any # Filter moderators by permission group (`moderator` or `admin`).}\n@returns(200) Successful retrieval of the moderators list.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access this list., 404: Not Found. No preprint provider matches the given ID.}\n\n@endpoint POST /preprint_providers/{provider_id}/moderators/\n@desc Add a Moderator to a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider., body: map}\n@returns(201) Moderator successfully added.\n@errors {400: Bad Request. Invalid input provided., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to add a moderator., 404: Not Found. No preprint provider matches the given ID.}\n\n@endpoint GET /preprint_providers/{provider_id}/moderators/{moderator_id}/\n@desc Retrieve a Moderator for a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider., moderator_id: any # The unique identifier of the moderator.}\n@returns(200) Successful retrieval of the moderator.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access this moderator., 404: Not Found. No moderator matches the given ID.}\n\n@endpoint PATCH /preprint_providers/{provider_id}/moderators/{moderator_id}/\n@desc Update a Moderator's Permission Group for a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider., moderator_id: any # The unique identifier of the moderator., body: map}\n@returns(200) Moderator successfully updated.\n@errors {400: Bad Request. Invalid input provided., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to update this moderator., 404: Not Found. No moderator matches the given ID.}\n\n@endpoint DELETE /preprint_providers/{provider_id}/moderators/{moderator_id}/\n@desc Remove a Moderator from a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider., moderator_id: any # The unique identifier of the moderator.}\n@returns(204) Moderator successfully removed. No content returned.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to remove this moderator., 404: Not Found. No moderator matches the given ID.}\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/preprints/{provider_id}/withdraw_requests/\n@desc List Withdraw Requests for a Preprint Provider\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@returns(200) Successful retrieval of withdraw requests.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access withdraw requests for this provider., 404: Not Found. No preprint provider matches the given ID.}\n\n@endgroup\n\n@group registrations\n@endpoint GET /registrations/\n@desc List all registrations\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/\n@desc Retrieve a registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint PATCH /registrations/{registration_id}/\n@desc Update a registration\n@required {registration_id: any # The unique identifier of the registration., body: map}\n@returns(200) Created\n\n@endpoint GET /registrations/{registration_id}/citations/\n@desc List all citation styles\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/citations/{citation_id}/\n@desc Retrieve a citation\n@required {registration_id: any # The unique identifier of the registration., citation_id: any # The unique identifier of the citation.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/children/\n@desc List all child registrations\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/comments/\n@desc List all comments\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/contributors/\n@desc List all contributors\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/contributors/{user_id}/\n@desc Retrieve a contributor\n@required {registration_id: any # The unique identifier of the registration., user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/files/\n@desc List all storage providers\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/files/{provider}/\n@desc List all files\n@required {registration_id: any # The unique identifier of the registration., provider: any # The unique identifier of the storage provider.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/files/{provider}/{path}/\n@desc Retrieve a file\n@required {registration_id: any # The unique identifier of the registration., provider: any # The unique identifier of the storage provider., path: any # The unique identifier of the file path.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/forks/\n@desc List all forks\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint POST /registrations/{registration_id}/forks/\n@desc Create a fork\n@required {registration_id: any # The unique identifier of the registration., body: map}\n@returns(201) Created\n\n@endpoint GET /registrations/{registration_id}/identifiers/\n@desc List all identifiers\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/institutions/\n@desc List all institutions\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/linked_nodes/\n@desc List all linked nodes\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/logs/\n@desc List all logs\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/actions/\n@desc List Registration Actions\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of registration actions.\n@errors {401: Unauthorized. Authentication credentials were not provided or are invalid., 403: Forbidden. You do not have permission to view registration actions for this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/bibliographic_contributors/\n@desc List Bibliographic Contributors for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of bibliographic contributors for the specified registration.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view contributors on this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/cedar_metadata_records/\n@desc List CEDAR Metadata Records for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of CEDAR metadata records for the specified registration.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view CEDAR metadata records on this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/citation/\n@desc List all citation styles\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/citation/{citation_id}/\n@desc Retrieve a citation\n@required {registration_id: any # The unique identifier of the registration., citation_id: any # The unique identifier of the citation.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/implicit_contributors/\n@desc List Implicit Contributors for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of implicit contributors for the specified registration.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view the implicit contributors., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/linked_by_nodes/\n@desc List Linked By Nodes\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of nodes linking to the specified registration.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view linked by nodes., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/linked_by_registrations/\n@desc List Linked By Registrations\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of registrations linking to the specified registration.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view linked by registrations., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/node_links/\n@desc List Node Links for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of node links for the specified registration.\n@errors {401: Unauthorized. Authentication is required to access this resource., 403: Forbidden. You do not have permission to view node links for this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/registrations/\n@desc List Child Registrations of a Registration\n@required {registration_id: any # The unique identifier of the parent registration.}\n@optional {page: any # Page number of results to view (pagination)., filter: any # Filter results by specific fields, e.g., `filter[title]=keyword`., embed: any # Comma-separated list of related resources to embed.}\n@returns(200) Successful retrieval of child registrations.\n@errors {401: Unauthorized. Authentication is required to access this resource., 403: Forbidden. You do not have permission to access these registrations., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/relationships/institutions/\n@desc Retrieve Institution Relationships for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successfully retrieved the affiliated institutions relationship data for this registration.\n@errors {401: Unauthorized. Authentication is required to access this resource., 403: Forbidden. You do not have permission to access the institutions of this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/relationships/linked_nodes/\n@desc Retrieve Linked Nodes Relationship for a Registration or Node\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successfully retrieved linked nodes relationship data for this registration/node.\n@errors {401: Unauthorized. Authentication is required to access this resource., 403: Forbidden. You do not have permission to access the linked nodes of this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/relationships/linked_registrations/\n@desc Retrieve Linked Registrations Relationship for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successfully retrieved linked registrations relationship data for this registration.\n@errors {401: Unauthorized. Authentication is required to access this resource., 403: Forbidden. You do not have permission to access the linked registrations of this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/relationships/subjects/\n@desc Retrieve Subjects Relationship for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) Successfully retrieved the subject relationship data for this registration.\n@errors {401: Unauthorized. Authentication is required to access this resource., 403: Forbidden. You do not have permission to access this registration's subjects., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/requests/\n@desc List Requests for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@optional {filter[type]: any # Filter requests by type. Allowed values:   - withdrawal   - embargo   - schema_update, page: any # Page number of results to return (pagination).}\n@returns(200) Successfully retrieved the list of requests for this registration.\n@errors {401: Unauthorized. Authentication is required to access requests for this registration., 403: Forbidden. You do not have permission to view requests for this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/resources/\n@desc List Related Resources for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@optional {page: any # Page number of results to return (pagination).}\n@returns(200) Successfully retrieved related resources for this registration.\n@errors {401: Unauthorized. Authentication is required to access related resources for this registration., 403: Forbidden. You do not have permission to view the related resources for this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/schema_responses/\n@desc List Schema Responses for a Registration\n@required {registration_id: any # The unique identifier of the registration.}\n@optional {page: any # Page number of results to view (pagination)., filter[state]: any # Filter schema responses by their state (e.g., `in_progress`, `unapproved`, `approved`, `pending_moderation`).}\n@returns(200) Successfully retrieved list of schema responses for this registration.\n@errors {401: Unauthorized. Authentication is required to access schema responses for a private registration., 403: Forbidden. You do not have permission to view schema responses for this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/subjects/\n@desc List Registration Subjects\n@required {registration_id: any # The unique identifier of the registration.}\n@optional {page: any # Page number of results to view (pagination)., filter[text]: any # Filter subjects by name.}\n@returns(200) Successfully retrieved list of subjects for this registration.\n@errors {401: Unauthorized. Authentication is required to access subjects for a private registration., 403: Forbidden. You do not have permission to view subjects for this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /registrations/{registration_id}/view_only_links/\n@desc List all view only links\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/view_only_links/{link_id}/\n@desc Retrieve a view only link\n@required {registration_id: any # The unique identifier of the registration., link_id: any # The unique identifier of the view only link.}\n@returns(200) OK\n\n@endpoint GET /registrations/{registration_id}/wikis/\n@desc List all wikis\n@required {registration_id: any # The unique identifier of the registration.}\n@returns(200) OK\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/registrations/\n@desc List all Registration Providers\n@returns(200) OK\n\n@endpoint GET /providers/registrations/{provider_id}/\n@desc Retrieve a Registration Provider\n@required {provider_id: any # The unique identifier of the Registration Provider.}\n@returns(200) OK\n\n@endpoint GET /providers/registrations/{provider_id}/registrations/\n@desc List Registration Requests\n@required {provider_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of registration requests.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access these registration requests., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /providers/registrations/{provider_id}/taxonomies/\n@desc List Provider Taxonomies\n@required {provider_id: any}\n@optional {filter[parent]: any # Filter by parent taxonomy ID ('null' for top-level).}\n@returns(200) Taxonomies retrieved successfully.\n\n@endpoint GET /providers/registrations/{provider_id}/taxonomies/highlighted/\n@desc List Highlighted Taxonomies\n@required {provider_id: any}\n@returns(200) Highlighted taxonomies retrieved successfully.\n\n@endpoint GET /providers/registrations/{provider_id}/licenses/\n@desc Registration Providers Licenses List\n@required {provider_id: any # A short id for that Registration}\n@returns(200) OK\n\n@endpoint GET /providers/registrations/{provider_id}/actions/\n@desc List Registration Actions\n@required {provider_id: any # The unique identifier of the registration.}\n@optional {page: any # Page number of results to return (for pagination)., per_page: any # Number of results per page. Defaults to 10.}\n@returns(200) Successful retrieval of registration actions.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access these registration actions., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /providers/registrations/{provider_id}/requests/\n@desc List Registration Requests\n@required {provider_id: any # The unique identifier of the registration.}\n@returns(200) Successful retrieval of registration requests.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access these registration requests., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /providers/registrations/{provider_id}/schemas/\n@desc List Registration Schemas for a Provider\n@required {provider_id: any # The unique identifier of the registration provider.}\n@optional {filter[active]: any # Filter schemas by their active status., page: any # Page number of results to return (pagination)., per_page: any # Number of results per page.}\n@returns(200) Successful retrieval of registration schemas for the provider.\n@errors {400: Bad request. Invalid parameters or input., 404: Not found. Registration provider does not exist.}\n\n@endpoint GET /providers/registrations/{provider_id}/subjects/\n@desc List Subjects for a Registration\n@required {provider_id: any # The unique identifier of the registration.}\n@optional {page: any # Page number of results to return (pagination)., per_page: any # Number of results per page (default 10, maximum 100).}\n@returns(200) Successful retrieval of subjects for the registration.\n@errors {401: Unauthorized. Authentication is required to access this registration's subjects., 403: Forbidden. You do not have permission to access subjects for this registration., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /providers/registrations/{provider_id}/submissions/\n@desc List Submissions for a Registration\n@required {provider_id: any # The unique identifier of the registration.}\n@optional {filter[state]: any # Filter submissions by their state. Available values: - in_progress - pending - accepted - rejected - removed, page: any # Page number of results to return (pagination)., per_page: any # Number of results per page (default 10, maximum 100).}\n@returns(200) Successful retrieval of the list of submissions for the registration.\n@errors {401: Unauthorized. Authentication is required to access these submissions., 403: Forbidden. You do not have permission to view these submissions., 404: Not Found. No registration matches the given ID.}\n\n@endpoint GET /providers/registrations/{provider_id}/subjects/highlighted/\n@desc List Highlighted Subjects\n@required {provider_id: any}\n@returns(200) Highlighted subjects retrieved successfully.\n\n@endpoint GET /providers/registrations/{provider_id}/moderators/\n@desc List Moderators\n@required {provider_id: any}\n@returns(200) List of moderators retrieved successfully.\n\n@endpoint POST /providers/registrations/{provider_id}/moderators/\n@desc Add Moderator\n@required {provider_id: any, body: map}\n@returns(201) Moderator added successfully.\n@errors {400: Invalid request – user already moderator or invalid data., 403: Forbidden – insufficient permissions.}\n\n@endpoint GET /providers/registrations/{provider_id}/moderators/{moderator_id}/\n@desc Retrieve Moderator Details\n@required {provider_id: any # The unique identifier of the provider., moderator_id: any # The unique identifier of the moderator.}\n@returns(200) Moderator details retrieved successfully.\n@errors {403: Forbidden – insufficient permissions., 404: Not found – moderator does not exist.}\n\n@endpoint PATCH /providers/registrations/{provider_id}/moderators/{moderator_id}/\n@desc Update Moderator Permissions\n@required {provider_id: any, moderator_id: any, body: map}\n@returns(200) Moderator permissions updated successfully.\n@errors {400: Invalid request – validation errors., 403: Forbidden – insufficient permissions.}\n\n@endpoint DELETE /providers/registrations/{provider_id}/moderators/{moderator_id}/\n@desc Remove Moderator\n@required {provider_id: any, moderator_id: any}\n@returns(204) Moderator removed successfully.\n@errors {403: Forbidden – insufficient permissions., 404: Not found – moderator does not exist.}\n\n@endgroup\n\n@group draft_registrations\n@endpoint GET /draft_registrations/\n@desc Retrieve a list of Draft Registrations\n@returns(200) OK\n\n@endpoint POST /draft_registrations/\n@desc Create a Draft Registration\n@required {body: map}\n@returns(201) Created\n\n@endpoint GET /draft_registrations/{draft_id}/\n@desc Retrieve a Draft Registration\n@required {draft_id: any # The unique identifier of the draft registration.}\n@returns(200) OK\n\n@endpoint PATCH /draft_registrations/{draft_id}/\n@desc Update a Draft Registration\n@required {draft_id: any # The unique identifier of the draft registration., body: map}\n@returns(200) OK\n\n@endpoint DELETE /draft_registrations/{draft_id}/\n@desc Delete a draft registration\n@required {draft_id: any # The unique identifier of the draft registration.}\n@returns(204) No Content\n\n@endpoint GET /draft_registrations/{draft_id}/contributors/\n@desc Retreive a list Contributors from a Draft Registration\n@required {draft_id: any # The unique identifier of the Draft Registration.}\n@returns(200) Success\n\n@endpoint POST /draft_registrations/{draft_id}/contributors/\n@desc Add a contributor to a Draft Registration\n@required {draft_id: any # The unique identifier of the Draft Registration., body: map}\n@returns(201) Success\n\n@endpoint GET /draft_registrations/{draft_id}/contributors/{user_id}/\n@desc Retreive a Contributor from a Draft Registration\n@required {draft_id: any # The unique identifier of the Draft Registration., user_id: any # The unique identifier of the Contributor.}\n@returns(200) Success\n\n@endpoint GET /draft_registrations/{draft_id}/institutions/\n@desc Retrieve Institutions afilliated with a Draft Registration\n@required {draft_id: any # The unique identifier of the draft registration.}\n@returns(200) OK\n\n@endpoint GET /draft_registrations/{draft_id}/subjects/\n@desc Retrieve Subjects associated with a Draft Registration\n@required {draft_id: any # The unique identifier of the draft registration.}\n@returns(200) OK\n\n@endpoint GET /draft_registrations/{draft_id}/bibliographic_contributors/\n@desc List bibliographic contributors on a draft registration\n@required {draft_id: any # Draft registration ID.}\n@returns(200) Bibliographic contributors retrieved successfully.\n@errors {403: Forbidden., 404: Draft registration not found.}\n\n@endpoint GET /draft_registrations/{draft_id}/relationships/institutions/\n@desc Retrieve affiliated institutions for a draft registration\n@required {draft_id: any # The unique identifier of the draft registration.}\n@returns(200) Institutions retrieved successfully.\n@errors {403: Forbidden. You do not have permission to view affiliated institutions., 404: Draft registration not found.}\n\n@endpoint POST /draft_registrations/{draft_id}/relationships/institutions/\n@desc Add affiliated institutions to a draft registration\n@required {draft_id: any # The unique identifier of the draft registration., body: map # JSON:API list of institution identifiers to associate with the draft registration.}\n@returns(204) Institutions added successfully.\n@errors {400: Bad Request. User is not affiliated with the specified institution(s)., 403: Forbidden. You do not have permission to add institutions., 404: Draft registration not found.}\n\n@endpoint DELETE /draft_registrations/{draft_id}/relationships/institutions/\n@desc Remove affiliated institutions from a draft registration\n@required {draft_id: any # The unique identifier of the draft registration., body: map # JSON:API list of institution identifiers to disassociate from the draft registration.}\n@returns(204) Institutions removed successfully.\n@errors {403: Forbidden. You do not have permission to modify institutions., 404: Draft registration not found.}\n\n@endpoint GET /draft_registrations/{draft_id}/relationships/subjects/\n@desc Retrieve subjects relationship for a draft registration\n@required {draft_id: any # The unique identifier of the draft registration.}\n@returns(200) Subjects retrieved successfully.\n@errors {403: Forbidden. You don't have permission to view these subjects., 404: Draft registration not found.}\n\n@endpoint POST /draft_registrations/{draft_id}/relationships/subjects/\n@desc Add subjects to a draft registration\n@required {draft_id: any # The unique identifier of the draft registration., body: map # JSON:API list of subject identifiers to associate with the draft registration.}\n@returns(204) Subjects added successfully.\n@errors {403: Forbidden. You don't have permission to modify subjects., 404: Draft registration not found.}\n\n@endpoint DELETE /draft_registrations/{draft_id}/relationships/subjects/\n@desc Remove subjects from a draft registration\n@required {draft_id: any # The unique identifier of the draft registration., body: map # JSON:API list of subject identifiers to disassociate from the draft registration.}\n@returns(204) Subjects removed successfully.\n@errors {403: Forbidden. You don't have permission to modify subjects., 404: Draft registration not found.}\n\n@endgroup\n\n@group taxonomies\n@endpoint GET /taxonomies/\n@desc List all taxonomies\n@returns(200) OK\n\n@endpoint GET /taxonomies/{taxonomy_id}/\n@desc Retrieve a taxonomy\n@required {taxonomy_id: any # The unique identifier of the taxonomy.}\n@returns(200) OK\n\n@endgroup\n\n@group users\n@endpoint GET /users/\n@desc List all users\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/\n@desc Retrieve a user\n@required {user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint PATCH /users/{user_id}/\n@desc Update a user\n@required {user_id: any # The unique identifier of the user., body: map}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/institutions/\n@desc List all institutions\n@required {user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/nodes/\n@desc List all nodes\n@required {user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/preprints/\n@desc List all preprints\n@required {user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/registrations/\n@desc List all registrations\n@required {user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/addons/\n@desc List all user addons\n@required {user_id: any # The unique identifier of the user.}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/addons/{provider}/\n@desc Retrieve a user addon\n@required {user_id: any # The unique identifier of the user., provider: any # The unique identifier of the addon provider.}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/addons/{provider}/accounts/\n@desc List all addon accounts\n@required {user_id: any # The unique identifier of the user., provider: any # The unique identifier of the addon provider.}\n@returns(200) OK\n\n@endpoint GET /users/{user_id}/addons/{provider}/accounts/{account_id}/\n@desc Retrieve an addon account\n@required {user_id: any # The unique identifier of the user., provider: any # The unique identifier of the addon provider., account_id: any # The unique identifier of the addon account.}\n@returns(200) OK\n\n@endpoint POST /users/{user_id}/claim/\n@desc Claim a User Account\n@required {user_id: any # The unique identifier of the user you are trying to claim. Example: `abc123`, body: map # A JSON API representation of the claim request. You must provide at least a `record id`. Optionally, an `email` may be included if you are not authenticated.}\n@returns(204) Successfully initiated the claim process. If the claimer is authenticated, they will receive an email confirming the claim. If not authenticated and an email is provided, the claim invitation will be sent to the specified email address.\n@errors {400: Bad request. The request payload is invalid or missing required fields (such as `id`)., 403: Permission denied. You do not have permission to claim this user, or the user has already been claimed., 404: Not found. The specified user or record could not be found.}\n\n@endpoint GET /users/{user_id}/draft_preprints/\n@desc List a User's Draft Preprints\n@required {user_id: any # The unique identifier of the user. Example: `abc123`}\n@optional {page: any # Page number of results to view (pagination). Default is 1., filter[title]: any # Filter draft preprints by title.}\n@returns(200) Successfully retrieved the list of draft preprints.\n@errors {403: Permission denied. You do not have permission to view these draft preprints., 404: User not found.}\n\n@endpoint GET /users/{user_id}/draft_registrations/\n@desc List a User's Draft Registrations\n@required {user_id: any # The unique identifier of the user. Example: `abc123`}\n@optional {page: any # Page number of results to view (pagination). Default is 1., filter[title]: any # Filter draft registrations by title.}\n@returns(200) Successfully retrieved the list of draft registrations.\n@errors {403: Permission denied. You do not have permission to view these draft registrations., 404: User not found.}\n\n@endpoint GET /users/{user_id}/relationships/institutions/\n@desc Retrieve a User's Institution Relationships\n@required {user_id: any # The unique identifier of the user. Example: `abc123`}\n@returns(200) Successfully retrieved the user's affiliated institutions.\n@errors {403: Permission denied. You do not have permission to view these institution relationships., 404: User not found.}\n\n@endpoint DELETE /users/{user_id}/relationships/institutions/\n@desc Remove Institutions from a User's Affiliations\n@required {user_id: any # The unique identifier of the user. Example: `abc123`, body: map # List of institution relationships to remove.}\n@returns(204) Successfully removed institutions from user's affiliations.\n@errors {400: Bad request. Possible reasons include: - Institution `type` does not match `institutions`. - Institution ID is invalid or not affiliated with the user., 403: Permission denied. You do not have permission to modify these affiliations., 404: User not found.}\n\n@endpoint GET /users/{user_id}/settings/\n@desc Retrieve a User's Settings\n@required {user_id: any # The unique identifier of the user. Example: `abc123`}\n@returns(200) Successfully retrieved the user's settings.\n@errors {403: Permission denied. You do not have permission to view these settings.}\n\n@endpoint PATCH /users/{user_id}/settings/\n@desc Update a User's Settings\n@required {user_id: any # The unique identifier of the user. Example: `abc123`, body: map # JSON API representation of the updates to the user's settings.}\n@returns(200) Successfully updated the user's settings.\n@errors {400: Bad request. This can occur if the two-factor verification code is invalid, or subscription values are incorrect., 403: Permission denied. You do not have permission to update these settings., 404: User not found.}\n\n@endpoint GET /users/{user_id}/settings/emails/\n@desc List User Email Addresses\n@required {user_id: any # The unique identifier of the user whose emails are being listed. Example: `abc123`}\n@returns(200) A list of confirmed and unconfirmed email addresses for the user.\n@errors {403: Permission denied. You do not have permission to view email addresses for this user.}\n\n@endpoint POST /users/{user_id}/settings/emails/\n@desc Add a New Email Address\n@required {user_id: any # The unique identifier of the user to whom the email will be added. Example: `abc123`, body: map # A JSON API representation of the new email address to add. You must provide an `email_address` in the attributes object.}\n@returns(201) The email address was successfully added and is pending confirmation.\n@errors {400: Bad request. The email address is invalid or already exists on this user., 403: Permission denied. You do not have permission to add an email for this user., 429: Too many requests. You have exceeded the allowed number of email additions. Please wait and try again later.}\n\n@endpoint GET /users/{user_id}/settings/emails/{email_id}/\n@desc Retrieve a User's Email Address\n@required {user_id: any # The unique identifier of the user. Example: `abc123`, email_id: any # The unique identifier of the email address (either a hashed ID or unconfirmed token). Example: `1a2b3c`}\n@optional {resend_confirmation: any # If true, resend a confirmation email to the unconfirmed address (if applicable).}\n@returns(200) Successfully retrieved the email address.\n@errors {403: Permission denied. You do not have permission to view this email., 404: Email address not found.}\n\n@endpoint PATCH /users/{user_id}/settings/emails/{email_id}/\n@desc Update a User's Email Address\n@required {user_id: any # The unique identifier of the user. Example: `abc123`, email_id: any # The unique identifier of the email address. Example: `1a2b3c`, body: map # JSON API representation of the updates to the email address.}\n@returns(200) Successfully updated the email address.\n@errors {400: Bad request. This can occur if trying to set an unconfirmed email as primary or verify an unconfirmed email., 403: Permission denied., 404: Email address not found.}\n\n@endpoint DELETE /users/{user_id}/settings/emails/{email_id}/\n@desc Remove a User's Email Address\n@required {user_id: any # The unique identifier of the user. Example: `abc123`, email_id: any # The unique identifier of the email address. Example: `1a2b3c`}\n@returns(204) Email address successfully removed.\n@errors {400: Bad request. Cannot delete the primary email address., 403: Permission denied., 404: Email address not found.}\n\n@endpoint POST /users/{user_id}/settings/export/\n@desc Request User Account Export\n@required {user_id: any # The unique identifier of the user requesting the export. Example: `abc123`, body: map # A JSON API representation of the export request. No additional attributes are required in the request payload.}\n@returns(204) Export request successfully submitted. The user will receive confirmation once the export process is completed.\n@errors {403: Permission denied. You do not have permission to request an export for this user., 429: Too many requests. You have exceeded the allowed number of export requests. Please wait and try again later.}\n\n@endpoint GET /users/{user_id}/settings/identities/\n@desc List User External Identities\n@required {user_id: any # The unique identifier of the user whose external identities are being listed. Example: `abc123`}\n@returns(200) A list of external identities associated with the user.\n@errors {403: Permission denied. You do not have permission to view external identities for this user.}\n\n@endpoint GET /users/{user_id}/settings/identities/{identity_id}\n@desc Retrieve a User's External Identity\n@required {user_id: any # The unique identifier of the user whose external identity is being retrieved. Example: `abc123`, identity_id: any # The unique identifier of the external identity to retrieve. Example: `orcid`}\n@returns(200) A single external identity for the user.\n@errors {403: Permission denied. You do not have permission to view external identities for this user., 404: External identity not found. No identity with the given ID exists for this user.}\n\n@endpoint DELETE /users/{user_id}/settings/identities/{identity_id}\n@desc Remove a User's External Identity\n@required {user_id: any # The unique identifier of the user whose external identity is being deleted. Example: `abc123`, identity_id: any # The unique identifier of the external identity to delete. Example: `orcid`}\n@returns(204) External identity successfully removed.\n@errors {403: Permission denied. You do not have permission to remove external identities for this user., 404: External identity not found. No identity with the given ID exists for this user.}\n\n@endpoint POST /users/{user_id}/settings/password/\n@desc Change a User's Password\n@required {user_id: any # The unique identifier of the user whose password is being changed. Example: `abc123`, body: map # A JSON API representation of the password change request. You must provide both the existing password and the new password.}\n@returns(204) Password successfully changed. All sessions for the user will be logged out and must be re-authenticated.\n@errors {400: Bad request. The existing password is incorrect, or the new password is invalid., 403: Permission denied. You do not have permission to change this user's password., 429: Too many failed attempts. Please wait before trying again.}\n\n@endgroup\n\n@group view_only_links\n@endpoint GET /view_only_links/{link_id}/\n@desc Retrieve a view only link\n@required {link_id: any # The unique identifier of the view only link.}\n@returns(200) OK\n\n@endpoint GET /view_only_links/{link_id}/nodes/\n@desc List all nodes\n@required {link_id: any # The unique identifier of the view only link.}\n@returns(200) OK\n\n@endgroup\n\n@group wikis\n@endpoint GET /wikis/{wiki_id}/\n@desc Retrieve a Wiki\n@required {wiki_id: any # The unique identifier of the wiki.}\n@returns(200) OK\n\n@endpoint GET /wikis/{wiki_id}/content/\n@desc Retrieve the Content of a Wiki\n@required {wiki_id: any # The unique identifier of the wiki.}\n@returns(200) OK\n\n@endpoint POST /wikis/{wiki_id}/versions/\n@desc Create a new version of a wiki page\n@required {wiki_id: any # The unique identifier for the wiki page., body: map # The content to save in the new wiki version.}\n@returns(201) Wiki version created successfully.\n@errors {400: Invalid request payload., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to update this wiki page., 404: Wiki page not found.}\n\n@endpoint GET /wikis/{wiki_id}/versions/{version_id}/\n@desc Retrieve details for a specific wiki version\n@required {wiki_id: any # The unique identifier for the wiki page., version_id: any # The version identifier for the specific wiki version.}\n@returns(200) Successfully retrieved the wiki version.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view this wiki version., 404: Wiki version not found.}\n\n@endpoint GET /wikis/{wiki_id}/versions/{version_id}/content/\n@desc Retrieve the raw content of a specific wiki version\n@required {wiki_id: any # The unique identifier for the wiki page., version_id: any # The version identifier for the specific wiki version.}\n@returns(200) Successfully retrieved raw wiki content.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view this wiki version content., 404: Wiki version not found.}\n\n@endgroup\n\n@group collections\n@endpoint GET /collections/\n@desc List all Collections\n@returns(200) OK\n\n@endpoint POST /collections/\n@desc Create a Collection\n@required {body: map}\n@returns(201) Created\n\n@endpoint GET /collections/{collection_id}/\n@desc Retrieve a Collection\n@required {collection_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint DELETE /collections/{collection_id}/\n@desc Delete a Collection\n@required {collection_id: any # A short id for that collection}\n@returns(204) No Content\n\n@endpoint GET /collections/{collection_id}/linked_nodes\n@desc List All Linked Nodes for a Collection\n@required {collection_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint POST /collections/{collection_id}/linked_nodes/relationships/\n@desc Link Nodes to Collection\n@required {collection_id: any # A short id for that collection, body: map}\n@returns(201) Created\n\n@endpoint GET /collections/{collection_id}/linked_nodes/relationships/\n@desc Give a Sparse List of Node Ids\n@required {collection_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint DELETE /collections/{collection_id}/linked_nodes/relationships/\n@desc Remove Nodes From Collection\n@required {collection_id: any # A short id for that collection, body: map}\n@returns(200) OK\n\n@endpoint GET /collections/{collection_id}/linked_registrations/\n@desc List All Linked Registrations for a Collection\n@required {collection_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint POST /collections/{collection_id}/linked_registrations/relationships/\n@desc Link Registrations to Collection\n@required {collection_id: any # A short id for that collection, body: map}\n@returns(201) Created\n\n@endpoint GET /collections/{collection_id}/linked_registrations/relationships/\n@desc Give a Sparse List of Registrations Ids\n@required {collection_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint DELETE /collections/{collection_id}/linked_registrations/relationships/\n@desc Remove Registrations From Collection\n@required {collection_id: any # A short id for that collection, body: map}\n@returns(200) OK\n\n@endpoint GET /collections/{collection_id}/linked_preprints/\n@desc List All Linked Preprints for a Collection\n@required {collection_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /collections/{collection_id}/collected_metadata/\n@desc Retrieve a list of collected metadata for a collection\n@required {collection_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint POST /collections/{collection_id}/collected_metadata/\n@desc Add Metadata or Subjects to a Entity in a Collection\n@required {collection_id: any # A short id for that collection, body: map}\n@returns(201) OK\n\n@endpoint GET /collections/{collection_id}/collected_metadata/{cgm_id}\n@desc Retrieve Specific Metadata for a Collection\n@required {collection_id: any # A short id for that collection, cgm_id: any # A short id for that piece of metadata}\n@returns(200) OK\n\n@endpoint POST /collections/{collection_id}/collected_metadata/{cgm_id}\n@desc Add Metadata or Subjects to an Entity in a Collection\n@required {collection_id: any # A short id for that collection, cgm_id: any # A short id for that piece of metadata, body: map}\n@returns(201) OK\n\n@endpoint DELETE /collections/{collection_id}/collected_metadata/{cgm_id}\n@desc Delete Collection Metadata from entitiy\n@required {collection_id: any # A short id for that collection, cgm_id: any # A short id for that piece of metadata}\n@returns(204) NO CONTENT\n\n@endpoint GET /collections/{collection_id}/collected_metadata/{cgm_id}/subjects/\n@desc Retrieve subject data for a specific piece of metadata info for a collection\n@required {collection_id: any # A short id for that collection, cgm_id: any # A short id for that piece of metadata}\n@returns(200) OK\n\n@endpoint GET /collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/\n@desc Retrieve subject metadata for a specific piece of metadata in a collection\n@required {collection_id: any # A short id for that collection, cgm_id: any # A short id for that piece of metadata}\n@returns(200) OK\n\n@endpoint POST /collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/\n@desc Update subjects for a specific piece of metadata in a collection\n@required {collection_id: any # A short id for that collection, cgm_id: any # A short id for that piece of metadata, body: map}\n@returns(201) OK\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/collections/\n@desc List Collections Providers\n@returns(200) OK\n\n@endpoint GET /providers/collections/{provider_id}/\n@desc Collections Providers Detail\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /providers/collections/{provider_id}/licenses/\n@desc Collections Providers Licenses List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /providers/collections/{provider_id}/taxonomies/\n@desc List Taxonomies for a Collection Provider (Deprecated)\n@required {provider_id: any # The unique ID of the collection provider.}\n@returns(200) A list of taxonomies.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view taxonomies for this provider., 404: Collection provider not found.}\n\n@endpoint GET /providers/collections/{provider_id}/taxonomies/highlighted/\n@desc List Highlighted Taxonomies for a Collection Provider (Deprecated)\n@required {provider_id: any # The unique ID of the collection provider.}\n@returns(200) A list of highlighted taxonomies.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view taxonomies for this provider., 404: Collection provider not found.}\n\n@endpoint GET /providers/collections/{provider_id}/submissions/\n@desc Collections Providers Submissions List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /providers/collections/{provider_id}/subjects/highlighted/\n@desc Collections Providers Highlighted Subject List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /providers/collections/{provider_id}/moderators/\n@desc Collections Providers Moderators List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /providers/collections/{provider_id}/moderators/{moderator_id}/\n@desc Collections Providers Moderators Detail\n@required {provider_id: any # A short id for that collection, moderator_id: any # A short id for that moderator}\n@returns(200) OK\n\n@endgroup\n\n@group collection_submissions\n@endpoint GET /collection_submissions/{collection_submission_id}/actions/\n@desc Get a list of Collection Submission Actions for a Collection Submission\n@required {collection_submission_id: any # A short id for that collection submission}\n@returns(200) OK\n\n@endgroup\n\n@group collection_submission_actions\n@endpoint GET /collection_submission_actions/{collection_submission_id}/\n@desc Retrieve a Collection Submission Action\n@required {collection_submission_id: any # A short id for that collection submission}\n@returns(200) OK\n\n@endpoint POST /collection_submission_actions/\n@desc Creates a Collection Submission Action\n@required {body: map}\n@returns(200) OK\n\n@endgroup\n\n@group provider\n@endpoint GET /provider/collections/\n@desc List Collections Providers\n@returns(200) OK\n\n@endpoint GET /provider/collections/{provider_id}/\n@desc Collections Providers Detail\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /provider/collections/{provider_id}/licenses/\n@desc Collections Providers Licenses List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /provider/collections/{provider_id}/submissions/\n@desc Collections Providers Submissions List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /provider/collections/{provider_id}/subjects/\n@desc Collections Providers Subject List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /provider/collections/{provider_id}/subjects/highlighted/\n@desc Collections Providers Highlighted Subject List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /provider/collections/{provider_id}/moderators/\n@desc Collections Providers Moderators List\n@required {provider_id: any # A short id for that collection}\n@returns(200) OK\n\n@endpoint GET /provider/collections/{provider_id}/moderators/{moderator_id}/\n@desc Collections Providers Moderators Detail\n@required {provider_id: any # A short id for that collection, moderator_id: any # A short id for that moderator}\n@returns(200) OK\n\n@endgroup\n\n@group requests\n@endpoint GET /requests/{request_id}/\n@desc Retrieve details for a specific request\n@required {request_id: any # The unique identifier for the request (either NodeRequest or PreprintRequest).}\n@returns(200) Successfully retrieved request details.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view this request., 404: Request not found.}\n\n@endpoint GET /requests/{request_id}/actions/\n@desc List actions associated with a request\n@required {request_id: any # The unique identifier for the request.}\n@optional {filter: any # Filter actions by attributes.  Supported filters:   - `machine_state`: Filter by current state (e.g., `pending`, `accepted`, `rejected`)  Example:   - filter[machine_state]=pending}\n@returns(200) Successfully retrieved actions for the request.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to view actions on this request., 404: Request not found or no actions are available for the given request.}\n\n@endgroup\n\n@group resources\n@endpoint GET /resources/\n@desc List resources\n@returns(200) Successful retrieval of resource list\n@errors {401: Authentication required., 403: Permission denied.}\n\n@endpoint POST /resources/\n@desc Create a new resource\n@required {body: map # JSON:API-compliant resource creation payload.}\n@returns(201) Successfully created a new resource.\n@errors {400: Validation error or invalid data., 401: Authentication required., 403: Permission denied.}\n\n@endpoint GET /resources/{resource_id}/\n@desc Retrieve a resource\n@required {resource_id: any # The unique identifier of the resource.}\n@returns(200) Successful retrieval of the resource.\n@errors {401: Authentication required., 403: Permission denied., 404: Resource not found.}\n\n@endpoint PATCH /resources/{resource_id}/\n@desc Update a resource\n@required {resource_id: any # The unique identifier of the resource to update., body: map # A JSON:API compliant object describing the updates.}\n@returns(200) Resource updated successfully.\n@errors {400: Validation error or malformed request data., 401: Authentication required., 403: Permission denied., 404: Resource not found.}\n\n@endpoint DELETE /resources/{resource_id}/\n@desc Delete a resource\n@required {resource_id: any # The unique identifier of the resource to delete.}\n@returns(204) Resource deleted successfully. No content returned.\n@errors {401: Authentication required., 403: Permission denied or resource cannot be deleted., 404: Resource not found.}\n\n@endgroup\n\n@group subjects\n@endpoint GET /subjects/\n@desc List available taxonomy subjects\n@optional {filter[text]: any # Filter subjects by matching text., filter[parent]: any # Filter subjects by parent subject ID., page: any # Page number for paginated results., page_size: any # Number of results per page (no max page size).}\n@returns(200) Successful retrieval of subjects.\n@errors {400: Bad request (e.g., invalid filter or pagination parameters)}\n\n@endpoint GET /subjects/{subject_id}/\n@desc Retrieve a single taxonomy subject\n@required {subject_id: any # The unique identifier of the subject.}\n@returns(200) Successfully retrieved the subject.\n@errors {404: Subject not found.}\n\n@endpoint GET /subjects/{subject_id}/children/\n@desc List child subjects for a given subject\n@required {subject_id: any # The unique identifier of the parent taxonomy subject.}\n@returns(200) Successful retrieval of child subjects.\n@errors {404: Parent subject not found.}\n\n@endgroup\n\n@group guids\n@endpoint GET /guids/{guid_id}/\n@desc Retrieve a GUID resource or redirect to its referent resource\n@required {guid_id: any # The unique identifier for the GUID.}\n@optional {resolve: any # If true (default), redirect to the referent resource. If false, return a representation of the GUID resource.}\n@returns(200) Successfully retrieved the GUID resource.\n@errors {302: Redirects to the referent resource if `resolve=true` or omitted., 401: Authentication required., 403: You do not have permission to view this GUID., 404: GUID not found., 410: The GUID has been deleted.}\n\n@endgroup\n\n@group files\n@endpoint POST /files/{file_id}/cedar_metadata_records/\n@desc Create a CEDAR metadata record for a file\n@required {file_id: any # The unique identifier of the file., body: map # CEDAR metadata record object to be created.}\n@returns(201) Successfully created a new CEDAR metadata record.\n@errors {400: Validation error or invalid data., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to create metadata for this file., 404: File not found.}\n\n@endgroup\n\n@group nodes\n@endpoint POST /nodes/{node_id}/cedar_metadata_records/\n@desc Create a CEDAR metadata record for a node\n@required {node_id: any # The unique identifier of the node., body: map # CEDAR metadata record object to be created.}\n@returns(201) Successfully created a new CEDAR metadata record.\n@errors {400: Validation error or invalid data., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to create metadata for this node., 404: Node not found.}\n\n@endgroup\n\n@group custom_file_metadata_records\n@endpoint GET /custom_file_metadata_records/{file_id}/\n@desc Retrieve custom file metadata for a file\n@required {file_id: any # The unique identifier of the file.}\n@returns(200) Successfully retrieved custom file metadata record.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to access this metadata record., 404: Metadata record not found.}\n\n@endpoint PATCH /custom_file_metadata_records/{file_id}/\n@desc Update custom file metadata for a file\n@required {file_id: any # The unique identifier of the file., body: map # Custom file metadata record object.}\n@returns(200) Successfully updated custom file metadata record.\n@errors {400: Validation error or invalid data., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to modify this metadata record., 404: Metadata record not found.}\n\n@endgroup\n\n@group custom_item_metadata_records\n@endpoint GET /custom_item_metadata_records/{guid_id}/\n@desc Retrieve custom item metadata for a node or preprint\n@required {guid_id: any # The unique identifier (GUID) of the node or preprint.}\n@returns(200) Successfully retrieved custom item metadata record.\n@errors {401: Authentication credentials were not provided or are invalid., 403: You do not have permission to access this metadata record., 404: Metadata record not found.}\n\n@endpoint PATCH /custom_item_metadata_records/{guid_id}/\n@desc Update custom item metadata for a node or preprint\n@required {guid_id: any # The unique identifier (GUID) of the node or preprint., body: map # Custom item metadata record object.}\n@returns(200) Successfully updated custom item metadata record.\n@errors {400: Validation error or invalid data., 401: Authentication credentials were not provided or are invalid., 403: You do not have permission to modify this metadata record., 404: Metadata record not found.}\n\n@endgroup\n\n@group subscriptions\n@endpoint GET /subscriptions/\n@desc Retrieve a List of Notification Subscriptions\n@optional {page: any # The page number of the paginated result set., filter[event_name]: any # Filter subscriptions by `event_name`.}\n@returns(200) Successful retrieval of the user's notification subscriptions.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access these subscriptions., 404: Not Found. No subscriptions found for the user.}\n\n@endpoint GET /subscriptions/{subscription_id}/\n@desc Retrieve a Notification Subscription\n@required {subscription_id: any # The unique identifier of the notification subscription.}\n@returns(200) Successful retrieval of the subscription.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to access this subscription., 404: Not Found. No subscription matches the given ID.}\n\n@endpoint PATCH /subscriptions/{subscription_id}/\n@desc Update a Notification Subscription\n@required {subscription_id: any # The unique identifier of the notification subscription., body: map}\n@returns(200) Subscription successfully updated.\n@errors {400: Bad Request. Invalid input provided., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to modify this subscription., 404: Not Found. No subscription matches the given ID.}\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/collections/{provider_id}/subscriptions/\n@desc List Notification Subscriptions for a Collection Provider\n@required {provider_id: any # The unique identifier of the collection provider.}\n@returns(200) Successful response with a paginated list of subscriptions.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. The user does not have permission to access subscriptions for this provider., 404: Not Found. The specified collection provider does not exist or has no subscriptions for the user.}\n\n@endpoint GET /providers/collections/{provider_id}/subscriptions/{subscription_id}/\n@desc Retrieve a Collection Provider Notification Subscription\n@required {provider_id: any # The unique identifier of the collection provider., subscription_id: any # The unique identifier of the notification subscription.}\n@returns(200) Successful retrieval of the subscription.\n@errors {401: Unauthorized. Authentication credentials are missing or invalid., 403: Forbidden. You do not have permission to access this subscription., 404: Not Found. No subscription matches the given ID or the collection provider does not exist.}\n\n@endpoint PATCH /providers/collections/{provider_id}/subscriptions/{subscription_id}/\n@desc Update a Collection Provider Notification Subscription\n@required {provider_id: any # The unique identifier of the collection provider., subscription_id: any # The unique identifier of the notification subscription., body: map}\n@returns(200) Subscription successfully updated.\n@errors {400: Bad Request. Invalid input provided or missing required fields., 401: Unauthorized. Authentication credentials are missing or invalid., 403: Forbidden. You do not have permission to update this subscription., 404: Not Found. No subscription matches the given ID or the collection provider does not exist.}\n\n@endpoint GET /providers/preprints/{provider_id}/subscriptions/\n@desc List Preprint Provider Subscriptions\n@required {provider_id: any # The unique identifier of the preprint provider.}\n@optional {page: any # The page number of results to retrieve.}\n@returns(200) OK\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint GET /providers/preprints/{provider_id}/subscriptions/{subscription_id}/\n@desc Retrieve a Preprint Provider Subscription\n@required {provider_id: any # The unique identifier of the preprint provider., subscription_id: any # The unique identifier of the subscription.}\n@returns(200) OK\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint PATCH /providers/preprints/{provider_id}/subscriptions/{subscription_id}/\n@desc Update a Preprint Provider Subscription\n@required {provider_id: any # The unique identifier of the preprint provider., subscription_id: any # The unique identifier of the subscription., body: map}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint GET /providers/registrations/{provider_id}/subscriptions/\n@desc List Registration Provider Subscriptions\n@required {provider_id: any # The unique identifier of the registration provider.}\n@optional {page: any # Page number of the results to retrieve.}\n@returns(200) OK\n\n@endpoint GET /providers/registrations/{provider_id}/subscriptions/{subscription_id}/\n@desc Retrieve a Registration Provider Notification Subscription\n@required {provider_id: any # The unique identifier of the registration provider associated with this subscription., subscription_id: any # The unique identifier of the notification subscription.}\n@returns(200) Subscription successfully retrieved.\n@errors {401: Unauthorized. Authentication credentials are missing or invalid., 403: Forbidden. You do not have permission to access this subscription., 404: Not Found. The subscription or provider does not exist.}\n\n@endpoint PATCH /providers/registrations/{provider_id}/subscriptions/{subscription_id}/\n@desc Update a Registration Provider Notification Subscription\n@required {provider_id: any # The unique identifier of the registration provider associated with this subscription., subscription_id: any # The unique identifier of the notification subscription., body: map # JSON API-formatted payload specifying the updated subscription attributes.}\n@returns(200) Subscription successfully updated.\n@errors {400: Bad Request. The request body is malformed or missing required fields., 401: Unauthorized. Authentication credentials are missing or invalid., 403: Forbidden. You do not have permission to modify this subscription., 404: Not Found. The subscription or provider does not exist.}\n\n@endgroup\n\n@group registration_subscriptions\n@endpoint GET /registration_subscriptions/{subscription_id}/\n@desc Retrieve a Registration Provider Subscription\n@required {subscription_id: any # The unique identifier of the notification subscription.}\n@returns(200) OK\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endpoint PATCH /registration_subscriptions/{subscription_id}/\n@desc Update a Registration Provider Subscription\n@required {subscription_id: any # The unique identifier of the notification subscription., body: map}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 403: Forbidden, 404: Not Found}\n\n@endgroup\n\n@group collection_subscriptions\n@endpoint GET /collection_subscriptions/{subscription_id}/\n@desc Retrieve a Collection Subscription\n@required {subscription_id: any # The unique identifier of the notification subscription.}\n@returns(200) Subscription successfully retrieved.\n@errors {401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to view this subscription., 404: Not Found. No subscription found matching the given ID.}\n\n@endpoint PATCH /collection_subscriptions/{subscription_id}/\n@desc Update a Collection Subscription\n@required {subscription_id: any # The unique identifier of the notification subscription., body: map # JSON:API-compliant payload specifying the updated subscription attributes.}\n@returns(200) Subscription successfully updated.\n@errors {400: Bad Request. Invalid input provided., 401: Unauthorized. Authentication is required., 403: Forbidden. You do not have permission to update this subscription., 404: Not Found. No subscription matches the given ID.}\n\n@endgroup\n\n@group regions\n@endpoint GET /regions/\n@desc List Regions\n@returns(200) Successfully retrieved the list of regions.\n\n@endpoint GET /regions/{region_id}/\n@desc Region Detail\n@required {region_id: any # The unique identifier for the region.}\n@returns(200) Successfully retrieved region details.\n@errors {404: Region not found.}\n\n@endgroup\n\n@group tokens\n@endpoint GET /tokens/\n@desc List Personal Access Tokens\n@returns(200) Successful retrieval of personal access tokens.\n\n@endpoint POST /tokens/\n@desc Create Personal Access Token\n@required {body: map}\n@returns(201) Token successfully created.\n\n@endpoint GET /tokens/{_id}/\n@desc Personal Access Token Detail\n@required {_id: any # The tokens's unique identifier.}\n@returns(200) Successful retrieval of tokens details.\n@errors {404: Token not found.}\n\n@endpoint DELETE /tokens/{_id}/\n@desc Deactivate Personal Access Token\n@required {_id: any # The tokens's unique identifier.}\n@returns(204) Token successfully deactivated.\n\n@endpoint GET /tokens/{_id}/scopes/\n@desc List Scopes of a Personal Access Token\n@required {_id: any # The token's unique identifier.}\n@returns(200) Successfully retrieved tokens scopes.\n@errors {404: Token not found.}\n\n@endgroup\n\n@group applications\n@endpoint GET /applications/\n@desc List Registered Applications\n@returns(200) Successfully retrieved list of applications.\n\n@endpoint POST /applications/\n@desc Create a New Application\n@required {body: map # JSON:API payload representing the new OAuth2 Application.}\n@returns(201) OAuth2 Application successfully created.\n\n@endpoint GET /applications/{client_id}/\n@desc Retrieve Application Details\n@required {client_id: any # The application's `client_id`.}\n@returns(200) Successfully retrieved application details.\n\n@endpoint PATCH /applications/{client_id}/\n@desc Update Application\n@required {client_id: any, body: map # JSON:API payload with updated OAuth2 Application fields.}\n@returns(200) Application successfully updated.\n\n@endpoint DELETE /applications/{client_id}/\n@desc Deactivate Application\n@required {client_id: any}\n@returns(204) Application successfully deactivated.\n\n@endpoint POST /applications/{client_id}/reset/\n@desc Reset Application Client Secret\n@required {client_id: any}\n@returns(201) Client secret successfully reset.\n@errors {404: Application not found or unauthorized., 410: Endpoint deprecated and removed in v2.15.}\n\n@endgroup\n\n@group scopes\n@endpoint GET /scopes/\n@desc List OAuth Scopes\n@returns(200) Successfully retrieved list of OAuth scopes.\n\n@endpoint GET /scopes/{scope_id}/\n@desc Retrieve OAuth Scope Detail\n@required {scope_id: any # The unique identifier of the OAuth scope.}\n@returns(200) Successfully retrieved OAuth scope details.\n@errors {404: OAuth scope not found or inaccessible.}\n\n@endgroup\n\n@group actions\n@endpoint GET /actions/reviews/\n@desc List Review Actions\n@optional {page: any # Page number of the results to fetch., per_page: any # Number of actions per page., filter[id]: any # Filter by the unique ID of the review action., filter[trigger]: any # Filter by the trigger that initiated the action., filter[from_state]: any # Filter by the previous state of the resource., filter[to_state]: any # Filter by the new state of the resource., filter[date_created]: any # Filter by the creation date of the action., filter[date_modified]: any # Filter by the last modification date of the action.}\n@returns(200) Successful retrieval of review actions.\n@errors {400: Bad request. Invalid filter or pagination parameters., 403: Forbidden. The user does not have permission to view these review actions.}\n\n@endpoint POST /actions/requests/nodes/\n@desc Create a Node Request Action\n@required {body: map # A JSON:API compliant payload describing the Node Request Action to create.}\n@returns(201) Node Request Action successfully created.\n@errors {400: Invalid or incomplete request payload., 403: Forbidden. Insufficient permissions for requested trigger., 409: Conflict. Invalid trigger for the node request's current state.}\n\n@endpoint POST /actions/requests/preprints/\n@desc Create a Preprint Request Action\n@required {body: map # A JSON:API compliant payload describing the Preprint Request Action to create.}\n@returns(201) Preprint Request Action successfully created.\n@errors {400: Invalid or incomplete request payload., 403: Forbidden. You do not have permission to perform this action., 409: Conflict. Trigger is invalid for the request's current state.}\n\n@endpoint GET /actions/{action_id}/\n@desc Retrieve an Action by ID\n@required {action_id: any # Unique identifier for the action (e.g., `abc123`).}\n@returns(200) Action retrieved successfully.\n@errors {403: Permission denied. Insufficient privileges to access the requested action., 404: Action not found or inaccessible. Verify action ID and permissions.}\n\n@endgroup\n\n@group identifiers\n@endpoint GET /identifiers/{identifier_id}/\n@desc Retrieve a Specific Identifier\n@required {identifier_id: any # The unique identifier for the identifier resource.}\n@returns(200) Successful retrieval of the identifier.\n\n@endpoint GET /identifiers/{node_id}/identifiers/\n@desc List all identifiers\n@required {node_id: any # The unique identifier of the node.}\n@returns(200) OK\n\n@endgroup\n\n@end\n"}