{ "opencollection": "1.0.0", "info": { "name": "Capmo REST Organisation Companies Projects API", "version": "1.0" }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "getProjects", "type": "http" }, "http": { "method": "GET", "url": "https://api.capmo.de/api/v1/projects", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Field to order by. It can be any field of the entity." }, { "name": "order_direction", "value": "", "type": "query", "description": "Order direction of the `order_by` field. It can be `asc` or `desc`." }, { "name": "after", "value": "", "type": "query", "description": "The last element from the previous page. This is a cursor. It will be returned in the output to be used in the next request. When it is not present, the first page is returned. When it is `null`, there are no more pages." }, { "name": "limit", "value": "", "type": "query", "description": "How many items should be in the output." }, { "name": "source_id", "value": "", "type": "query", "description": "[Filtering Parameter] The unique identifier of the source. This is a user-generated string, used to link the project to a resource in an external system." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to list all projects in a paginated response." }, { "info": { "name": "createProject", "type": "http" }, "http": { "method": "POST", "url": "https://api.capmo.de/api/v1/projects", "headers": [ { "name": "Request-Id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to create a new project, including creating a new project from a template. If `project_template_id` is provided, the project will be created from the template, otherwise a new blank project will be created.\n\n Please note:\n - The API user will be added as project member with full access to the project.\n - Creating a project from a template can be a slow operation, as it may involve copying a lot of data. This can typically be in the order of a few seconds." }, { "info": { "name": "getProject", "type": "http" }, "http": { "method": "GET", "url": "https://api.capmo.de/api/v1/projects/:projectId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to retrieve a specific project by its ID." }, { "info": { "name": "updateProject", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.capmo.de/api/v1/projects/:projectId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to update a specific project by its ID." }, { "info": { "name": "deleteProject", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.capmo.de/api/v1/projects/:projectId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to delete a specific project by its ID." }, { "info": { "name": "archiveProject", "type": "http" }, "http": { "method": "PUT", "url": "https://api.capmo.de/api/v1/projects/:projectId/archived", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to archive a specific project by its ID. Archiving a project will also remove all pins associated with the project for the authenticated user." }, { "info": { "name": "unarchiveProject", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.capmo.de/api/v1/projects/:projectId/archived", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to unarchive a specific project by its ID." } ] } ], "bundled": true }