{ "opencollection": "1.0.0", "info": { "name": "Coscine Web Admin Tree API", "version": "2.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Tree", "type": "folder" }, "items": [ { "info": { "name": "Retrieves the file tree associated with a resource.", "type": "http" }, "http": { "method": "GET", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/files", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." }, { "name": "Path", "value": "", "type": "query", "description": "Gets or sets the path of the file tree." }, { "name": "PageNumber", "value": "", "type": "query", "description": "Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1." }, { "name": "PageSize", "value": "", "type": "query", "description": "Gets or sets the desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10." }, { "name": "OrderBy", "value": "", "type": "query", "description": "Gets or sets the field name used for ordering the results.\r\nThe order is constructed by an order string.\r\nUse the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.\r\nCan be used like this: \"propertyA asc, propertyB desc\"." } ] }, "docs": "The `OrderBy` query is currently not supported." }, { "info": { "name": "Retrieves the metadata tree associated with a resource.", "type": "http" }, "http": { "method": "GET", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/metadata", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." }, { "name": "Path", "value": "", "type": "query", "description": "Gets or sets the path of the metadata tree." }, { "name": "Format", "value": "", "type": "query", "description": "Gets or sets the format of the RDF data." }, { "name": "IncludeExtractedMetadata", "value": "", "type": "query", "description": "Gets or sets if extracted metadata should be included." }, { "name": "IncludeProvenance", "value": "", "type": "query", "description": "Gets or sets if provenance metadata should be included." }, { "name": "PageNumber", "value": "", "type": "query", "description": "Gets or sets the desired page number. Should be greater than or equal to 1. Default is 1." }, { "name": "PageSize", "value": "", "type": "query", "description": "Gets or sets the desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10." }, { "name": "OrderBy", "value": "", "type": "query", "description": "Gets or sets the field name used for ordering the results.\r\nThe order is constructed by an order string.\r\nUse the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.\r\nCan be used like this: \"propertyA asc, propertyB desc\"." } ] }, "docs": "Retrieves the metadata tree associated with a resource." }, { "info": { "name": "Creates a new metadata tree for a resource.", "type": "http" }, "http": { "method": "POST", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/metadata", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new metadata tree for a resource." }, { "info": { "name": "Updates an existing metadata tree of a resource.", "type": "http" }, "http": { "method": "PUT", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/metadata", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing metadata tree of a resource." }, { "info": { "name": "Deletes (invalidates) a metadata tree associated with a resource.", "type": "http" }, "http": { "method": "DELETE", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/metadata", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Required JWT roles for access: administrator.

" }, { "info": { "name": "Retrieves the specific metadata tree associated with a resource.", "type": "http" }, "http": { "method": "GET", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/metadata/specific", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." }, { "name": "Path", "value": "", "type": "query", "description": "Gets or sets the path of the metadata tree." }, { "name": "Format", "value": "", "type": "query", "description": "Gets or sets the format of the RDF data." }, { "name": "IncludeExtractedMetadata", "value": "", "type": "query", "description": "Gets or sets if extracted metadata should be included." }, { "name": "IncludeProvenance", "value": "", "type": "query", "description": "Gets or sets if provenance should be included." }, { "name": "Version", "value": "", "type": "query", "description": "Gets or sets the desired version.\r\nIf the version is null, the newest will be returned." } ] }, "docs": "Retrieves the specific metadata tree associated with a resource." }, { "info": { "name": "Creates a new extracted metadata tree for a resource.", "type": "http" }, "http": { "method": "POST", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/metadata/extracted", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Required JWT roles for access: administrator.

" }, { "info": { "name": "Updates an existing metadata tree of a resource.", "type": "http" }, "http": { "method": "PUT", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees/metadata/extracted", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "The unique identifier or slug of the project." }, { "name": "resourceId", "value": "", "type": "path", "description": "The unique identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Required JWT roles for access: administrator.

" }, { "info": { "name": "Responds with the HTTP methods allowed for the endpoint.", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://coscine.rwth-aachen.de/coscine/api/v2/projects/:projectId/resources/:resourceId/trees", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "resourceId", "value": "", "type": "path" } ] }, "docs": "Responds with the HTTP methods allowed for the endpoint." } ] } ], "bundled": true }