{
  "opencollection": "1.0.0",
  "info": {
    "name": "Capmo REST Organisation Companies Project Documents API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Project Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "getProjectDocumentsPaginated",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-files",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "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."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to list all project documents in a paginated response."
        },
        {
          "info": {
            "name": "createProjectDocument",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-files",
            "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 create a new project document. This must be called after obtaining an upload URL."
        },
        {
          "info": {
            "name": "getProjectDocument",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-files/:fileId",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to get a single project document."
        },
        {
          "info": {
            "name": "renameDocument",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-files/:fileId",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to rename a specific project document by its ID."
        },
        {
          "info": {
            "name": "deleteProjectDocument",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-files/:fileId",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to delete a project document."
        },
        {
          "info": {
            "name": "getProjectDocumentFolders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-folders",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "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": "parent_folder_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the document folder's parent folder ID."
              },
              {
                "name": "include_sub_folders",
                "value": "",
                "type": "query",
                "description": "Whether the response should include all sub-folders or not."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "The field to order the document folders by."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "Can be used to search for a document folder by a partial match on its name."
              },
              {
                "name": "folder_ids",
                "value": "",
                "type": "query",
                "description": "Can be used to filter the results to a list of document folders IDs."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to list all project document folders in a paginated response."
        },
        {
          "info": {
            "name": "createProjectDocumentFolder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-folders",
            "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 create a new project document folder."
        },
        {
          "info": {
            "name": "getProjectDocumentFolder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-folders/:folderId",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "folderId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to retrieve a specific project document folder by its ID."
        },
        {
          "info": {
            "name": "renameProjectDocumentFolder",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-folders/:folderId",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "folderId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to rename a project document folder."
        },
        {
          "info": {
            "name": "deleteProjectDocumentFolder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.capmo.de/api/v1/projects/:projectId/document-folders/:folderId",
            "headers": [
              {
                "name": "Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "projectId",
                "value": "",
                "type": "path"
              },
              {
                "name": "folderId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "This can be used to delete a project document folder."
        }
      ]
    }
  ],
  "bundled": true
}