{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenProject API V3 (Stable)",
    "version": "3"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Root",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View root",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3"
          },
          "docs": "Returns the root resource, containing basic information about the server instance and a collection of useful links."
        }
      ]
    },
    {
      "info": {
        "name": "Actions & Capabilities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List actions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/actions",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"id\": { \"operator\": \"=\", \"values\": [\"memberships/create\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n+ id: Returns only the action having the id or all actions except those having the id(s)."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:\n\n+ *No sort supported yet*"
              }
            ]
          },
          "docs": "Returns a collection of actions. The client can choose to filter the actions similar to how work packages are filtered.\nIn addition to the provided filters, the server will reduce the result set to only contain actions, for which the requesting client\nhas sufficient permissions."
        },
        {
          "info": {
            "name": "View action",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/actions/:id",
            "params": [
              {
                "name": "id",
                "value": "work_packages/create",
                "type": "path",
                "description": "action id which is the name of the action"
              }
            ]
          },
          "docs": "Returns an individual action."
        },
        {
          "info": {
            "name": "List capabilities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/capabilities",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"principal\": { \"operator\": \"=\", \"values\": [\"1\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\n\n+ action: Get all capabilities of a certain action\n\n+ principal: Get all capabilities of a principal\n\n+ context: Get all capabilities within a context. Note that for a workspace context the client needs to\n  provide `w{id}`, e.g. `w5` and for the global context a `g`.\n\n  + **Deprecation**: The now deprecated context `p` for project still works, but must eventually be replaced\n    with the `w` for the workspace context."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:\n\n+ id: Sort by the capabilities id"
              }
            ]
          },
          "docs": "Returns a collection of actions assigned to a principal in a context. The client can choose to filter the actions similar to how work packages are filtered. In addition to the provided filters, the server will reduce the result set to only contain actions, for which the requesting client has sufficient permissions"
        },
        {
          "info": {
            "name": "View global context",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/capabilities/context/global"
          },
          "docs": "Returns the global capability context. This context is necessary to consistently link to a context even if the context is not a project."
        },
        {
          "info": {
            "name": "View capabilities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/capabilities/:id",
            "params": [
              {
                "name": "id",
                "value": "work_packages/create/p123-567",
                "type": "path",
                "description": "capability id"
              }
            ]
          },
          "docs": "View capabilities"
        }
      ]
    },
    {
      "info": {
        "name": "Activities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get an activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/activities/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Activity id"
              }
            ]
          },
          "docs": "Returns the requested activity resource identified by its unique id."
        },
        {
          "info": {
            "name": "Update activity",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/activities/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Activity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an activity's comment and, on success, returns the updated activity."
        },
        {
          "info": {
            "name": "List attachments by activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/activities/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the activity whose attachments will be listed"
              }
            ]
          },
          "docs": "List all attachments of a single activity."
        },
        {
          "info": {
            "name": "Add attachment to activity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/activities/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the activity to receive the attachment"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Adds an attachment to the specified activity."
        },
        {
          "info": {
            "name": "List emoji reactions by activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/activities/:id/emoji_reactions",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the activity whose emoji reactions will be listed"
              }
            ]
          },
          "docs": "List all emoji reactions of a single activity."
        },
        {
          "info": {
            "name": "Toggle emoji reaction for an activity",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/activities/:id/emoji_reactions",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the activity to toggle emoji reaction for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Toggle an emoji reaction for a given activity. If the user has already reacted with the given emoji,\nthe reaction will be removed. Otherwise, a new reaction will be created.\n\n**Note:** The response contains the complete collection of all emoji reactions for this activity.\n\n**Required permission:**\n- `add_work_package_comments`\n- for internal comments: `add_internal_comments`"
        }
      ]
    },
    {
      "info": {
        "name": "Attachments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Attachment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/attachments"
          },
          "docs": "Clients can create attachments without a container first and attach them later on.\nThis is useful if the container does not exist at the time the attachment is uploaded.\nAfter the upload, the client can then claim such containerless attachments for any resource eligible (e.g. WorkPackage) on subsequent requests.\nThe upload and the claiming *must* be done for the same user account. Attachments uploaded by another user cannot be claimed and\nonce claimed for a resource, they cannot be claimed by an"
        },
        {
          "info": {
            "name": "View attachment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/attachments/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Attachment id"
              }
            ]
          },
          "docs": "View attachment"
        },
        {
          "info": {
            "name": "Delete attachment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/attachments/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Attachment id"
              }
            ]
          },
          "docs": "Permanently deletes the specified attachment."
        },
        {
          "info": {
            "name": "List attachments by meeting",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/meetings/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the meeting whose attachments will be listed"
              }
            ]
          },
          "docs": "List attachments by meeting"
        },
        {
          "info": {
            "name": "Add attachment to meeting",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/meetings/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the meeting to receive the attachment"
              }
            ]
          },
          "docs": "Adds an attachment with the meeting as its container."
        },
        {
          "info": {
            "name": "List attachments by post",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/posts/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the post whose attachments will be listed"
              }
            ]
          },
          "docs": "List attachments by post"
        },
        {
          "info": {
            "name": "Add attachment to post",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/posts/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the post to receive the attachment"
              }
            ]
          },
          "docs": "Adds an attachment with the post as its container."
        },
        {
          "info": {
            "name": "List attachments by wiki page",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/wiki_pages/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the wiki page whose attachments will be listed"
              }
            ]
          },
          "docs": "List attachments by wiki page"
        },
        {
          "info": {
            "name": "Add attachment to wiki page",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/wiki_pages/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the wiki page to receive the attachment"
              }
            ]
          },
          "docs": "Adds an attachment with the wiki page as its container."
        },
        {
          "info": {
            "name": "List attachments by work package",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the work package whose attachments will be listed"
              }
            ]
          },
          "docs": "List attachments by work package"
        },
        {
          "info": {
            "name": "Create work package attachment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/attachments",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the work package to receive the attachment"
              }
            ]
          },
          "docs": "To add an attachment to a work package, a client needs to issue a request of type `multipart/form-data`\nwith exactly two parts.\n\nThe first part *must* be called `metadata`. Its content type is expected to be `application/json`,\nthe body *must* be a single JSON object, containing at least the `fileName` and optionally the attachments `description`.\n\nThe second part *must* be called `file`, its content type *should* match the mime type of the file.\nThe body *must* be the raw content of the file.\nN"
        }
      ]
    },
    {
      "info": {
        "name": "Budgets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "view Budget",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/budgets/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Budget id"
              }
            ]
          },
          "docs": "view Budget"
        },
        {
          "info": {
            "name": "view Budgets of a Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/budgets",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "view Budgets of a Project"
        }
      ]
    },
    {
      "info": {
        "name": "Categories",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Category",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/categories/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Category id"
              }
            ]
          },
          "docs": "View Category"
        },
        {
          "info": {
            "name": "List categories of a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/categories",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the project whose categories will be listed"
              }
            ]
          },
          "docs": "List all categories of a project\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/categories`](https://www.openproject.org/docs/api/endpoints/categories/#list-categories-of-a-workspace) "
        },
        {
          "info": {
            "name": "List categories of a workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/categories",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the workspace whose categories will be listed"
              }
            ]
          },
          "docs": "List all categories of a project"
        }
      ]
    },
    {
      "info": {
        "name": "Configuration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/configuration"
          },
          "docs": "View configuration"
        },
        {
          "info": {
            "name": "View project configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/configuration",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Returns the configuration scoped to a specific project, including all global\nconfiguration properties plus project-specific settings."
        }
      ]
    },
    {
      "info": {
        "name": "Custom actions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a custom action",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/custom_actions/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "The id of the custom action to fetch"
              }
            ]
          },
          "docs": "Retrieves a custom action by id."
        },
        {
          "info": {
            "name": "Execute custom action",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/custom_actions/:id/execute",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "The id of the custom action to execute"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "A POST to this endpoint executes the custom action on the work package provided in the payload. The altered work package will be returned. In order to avoid executing\n the custom action unbeknown to a change that has already taken place, the client has to provide the work package's current lockVersion."
        }
      ]
    },
    {
      "info": {
        "name": "Default",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the custom field hierarchy items",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/custom_fields/:id/items",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "The custom field's unique identifier"
              },
              {
                "name": "parent",
                "value": "1337",
                "type": "query",
                "description": "The identifier of the parent hierarchy item"
              },
              {
                "name": "depth",
                "value": "1",
                "type": "query",
                "description": "The level of hierarchy depth"
              }
            ]
          },
          "docs": "Retrieves the hierarchy of custom fields.\n\nThe hierarchy is a tree structure of hierarchy items. It is represented as a flat list of items, where each item\nhas a reference to its parent and children. The list is ordered in a depth-first manner. The first item is the\nrequested parent. If parent was unset, the root item is returned as first element.\n\nPassing the `depth` query parameter allows to limit the depth of the hierarchy. If the depth is unset, the full\nhierarchy tree is returned. If the de"
        },
        {
          "info": {
            "name": "Get a custom field hierarchy item",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/custom_field_items/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "The custom field item's unique identifier"
              }
            ]
          },
          "docs": "Retrieves a single custom field item specified by its unique identifier."
        },
        {
          "info": {
            "name": "Get a custom field hierarchy item's branch",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/custom_field_items/:id/branch",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "The custom field item's unique identifier"
              }
            ]
          },
          "docs": "Retrieves the branch of a single custom field item specified by its unique identifier.\n\nA branch is list of all ancestors, starting with the root item and finishing with the item itself."
        }
      ]
    },
    {
      "info": {
        "name": "Custom Options",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Custom Option",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/custom_options/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "The custom option's identifier"
              }
            ]
          },
          "docs": "View Custom Option"
        }
      ]
    },
    {
      "info": {
        "name": "Work Schedule",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all non working days",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/days/non_working",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"date\": { \"operator\": \"<>d\", \"values\": [\"2022-05-02\",\"2022-05-26\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\n\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ date: the inclusive date interval to scope days to look up. When\n  unspecified, default is from the beginning to the end of current year.\n\n  Example: `{ \"date\": { \"operator\": \"<>d\", \"values\": [\"2022-05-02\",\"2022-05-26\"] } }`\n  would return days between May 5 and May 26 2022, inclusive."
              }
            ]
          },
          "docs": "Lists all one-time non working days, such as holidays.\nIt does not lists the non working weekdays, such as each Saturday, Sunday.\nFor listing the weekends, the `/api/v3/days` endpoint should be used.\n\nAll days from current year are returned by default."
        },
        {
          "info": {
            "name": "Creates a non-working day (NOT IMPLEMENTED)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/days/non_working",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**(NOT IMPLEMENTED)**\nMarks a day as being a non-working day.\n\nNote: creating a non-working day will not affect the start and finish dates\nof work packages but will affect their duration."
        },
        {
          "info": {
            "name": "View a non-working day",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/days/non_working/:date",
            "params": [
              {
                "name": "date",
                "value": "2022-05-06",
                "type": "path",
                "description": "The date of the non-working day to view in ISO 8601 format."
              }
            ]
          },
          "docs": "Returns the non-working day information for a given date."
        },
        {
          "info": {
            "name": "Update a non-working day attributes (NOT IMPLEMENTED)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/days/non_working/:date",
            "params": [
              {
                "name": "date",
                "value": "2022-05-06",
                "type": "path",
                "description": "The date of the non-working day to view in ISO 8601 format."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**(NOT IMPLEMENTED)**\nUpdate the non-working day information for a given date."
        },
        {
          "info": {
            "name": "Removes a non-working day (NOT IMPLEMENTED)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/days/non_working/:date",
            "params": [
              {
                "name": "date",
                "value": "2022-05-06",
                "type": "path",
                "description": "The date of the non-working day to view in ISO 8601 format."
              }
            ]
          },
          "docs": "**(NOT IMPLEMENTED)**\nRemoves the non-working day at the given date.\n\nNote: deleting a non-working day will not affect the start and finish dates\nof work packages but will affect their duration."
        },
        {
          "info": {
            "name": "Lists week days",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/days/week"
          },
          "docs": "Lists week days with work schedule information."
        },
        {
          "info": {
            "name": "Update week days (NOT IMPLEMENTED)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/days/week",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**(NOT IMPLEMENTED)**\nUpdate multiple week days with work schedule information."
        },
        {
          "info": {
            "name": "View a week day",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/days/week/:day",
            "params": [
              {
                "name": "day",
                "value": "",
                "type": "path",
                "description": "The week day from 1 to 7. 1 is Monday. 7 is Sunday."
              }
            ]
          },
          "docs": "View a week day and its attributes."
        },
        {
          "info": {
            "name": "Update a week day attributes (NOT IMPLEMENTED)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/days/week/:day",
            "params": [
              {
                "name": "day",
                "value": "",
                "type": "path",
                "description": "The week day from 1 to 7. 1 is Monday. 7 is Sunday."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**(NOT IMPLEMENTED)**\nMakes a week day a working or non-working day.\n\nNote: changing a week day working attribute will not affect the start and\nfinish dates of work packages but will affect their duration attribute."
        },
        {
          "info": {
            "name": "Lists days",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/days",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"date\": { \"operator\": \"<>d\", \"values\": [\"2022-05-02\",\"2022-05-26\"] } }, { \"working\": { \"operator\": \"=\", \"values\": [\"f\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\n\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ date: the inclusive date interval to scope days to look up. When\n  unspecified, default is from the beginning of current month to the end\n  of following month.\n\n  Example: `{ \"date\": { \"operator\": \"<>d\", \"values\": [\"2022-05-02\",\"2022-05-26\"] } }`\n  would return days between May 5 and May 26 2022, inclusive.\n\n+ working: when `true`, returns only the working days. When `false`,\n  returns only the non-working days (weekend days and non-working days).\n  When unspecified, returns both working and non-working days.\n\n  Example: `{ \"working\": { \"operator\": \"=\", \"values\": [\"t\"] } }`\n  would exclude non-working days from the response."
              }
            ]
          },
          "docs": "Lists days information for a given date interval.\n\nAll days from the beginning of current month to the end of following month\nare returned by default."
        },
        {
          "info": {
            "name": "View day",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/days/:date",
            "params": [
              {
                "name": "date",
                "value": "2022-05-06",
                "type": "path",
                "description": "The date of the non-working day to view in ISO 8601 format."
              }
            ]
          },
          "docs": "View the day information for a given date."
        }
      ]
    },
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/documents",
            "params": [
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "sortBy",
                "value": "[[\"created_at\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:\n\n+ id: Sort by primary key\n\n+ created_at: Sort by document creation datetime"
              }
            ]
          },
          "docs": "The documents returned depend on the provided parameters and also on the requesting user's permissions."
        },
        {
          "info": {
            "name": "View document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Document id"
              }
            ]
          },
          "docs": "View document"
        },
        {
          "info": {
            "name": "Update document",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/documents/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Document id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a document's attributes."
        }
      ]
    },
    {
      "info": {
        "name": "Forms",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "show or validate form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/example/form",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This is an example of how a form might look like. Note that this endpoint does not exist in the actual implementation."
        }
      ]
    },
    {
      "info": {
        "name": "Schemas",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "view the schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/example/schema"
          },
          "docs": "This is an example of how a schema might look like. Note that this endpoint does not exist in the actual implementation."
        }
      ]
    },
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "view aggregated result",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/examples",
            "params": [
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by.\nNote: Aggregation is as of now only supported by the work package collection.\nYou can pass any column name as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query"
              }
            ]
          },
          "docs": "view aggregated result"
        }
      ]
    },
    {
      "info": {
        "name": "File links",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a file link.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/file_links/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "File link id"
              }
            ]
          },
          "docs": "Gets a single file link resource of a work package."
        },
        {
          "info": {
            "name": "Removes a file link.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/file_links/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "File link id"
              }
            ]
          },
          "docs": "Removes a file link on a work package.\n\nThe request contains only the file link identifier as a path parameter. No request body is needed."
        },
        {
          "info": {
            "name": "Creates an opening uri of the linked file.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/file_links/:id/open",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "File link id"
              },
              {
                "name": "location",
                "value": "true",
                "type": "query",
                "description": "Boolean flag indicating, if the file should be opened directly or rather the directory location."
              }
            ]
          },
          "docs": "Creates a uri to open the origin file linked by the given file link. This uri depends on the storage type and\nis always located on the origin storage itself."
        },
        {
          "info": {
            "name": "Creates a download uri of the linked file.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/file_links/:id/download",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "File link id"
              }
            ]
          },
          "docs": "Creates a uri to download the origin file linked by the given file link. This uri depends on the storage type and\nis always located on the origin storage itself."
        },
        {
          "info": {
            "name": "Get Storages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/storages"
          },
          "docs": "Returns a collection of storages."
        },
        {
          "info": {
            "name": "Creates a storage.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/storages",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a storage resource. When creating a storage, a confidential OAuth 2 provider application is created\nautomatically. The oauth client id and secret of the created OAuth application are returned in the response.\n\n**IMPORTANT:** This is the only time, the oauth client secret is visible to the consumer. After that, the secret is\nhidden.\n\nTo update the storage with OAuth client credentials, which enable the storage resource to behave as an OAuth 2\nclient against an external OAuth 2 provider ap"
        },
        {
          "info": {
            "name": "Get a storage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              }
            ]
          },
          "docs": "Gets a storage resource. As a side effect, a live connection to the storages origin is established to retrieve\nconnection state data."
        },
        {
          "info": {
            "name": "Update a storage",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a storage resource. Only data that is not generated by the server can be updated. This excludes the OAuth 2\napplication data."
        },
        {
          "info": {
            "name": "Delete a storage",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              }
            ]
          },
          "docs": "Deletes a storage resource. This also deletes all related records, like the created oauth application, client, and\nany file links created within this storage."
        },
        {
          "info": {
            "name": "Gets files of a storage.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id/files",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              },
              {
                "name": "parent",
                "value": "/my/data",
                "type": "query",
                "description": "Parent file identification"
              }
            ]
          },
          "docs": "Gets a collection of files from a storage.\n\nIf no `parent` context is given, the result is the content of the document root. With `parent` context given, the\nresult contains the collections of files/directories from within the given parent file id.\n\nIf given `parent` context is no directory, `400 Bad Request` is returned."
        },
        {
          "info": {
            "name": "Preparation of a direct upload of a file to the given storage.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id/files/prepare_upload",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Executes a request that prepares a link for a direct upload to the storage.\n\nThe background here is, that the client needs to make a direct request to the storage instance for file uploading,\nbut should not get access to the credentials, which are stored in the backend. The response contains a link object,\nthat enables the client to execute a file upload without the real credentials."
        },
        {
          "info": {
            "name": "Creation of a new folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id/folders",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new folder under the given parent"
        },
        {
          "info": {
            "name": "Creates an oauth client credentials object for a storage.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id/oauth_client_credentials",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Inserts the OAuth 2 credentials into the storage, to allow the storage to act as an OAuth 2 client. Calling this\nendpoint on a storage that already contains OAuth 2 client credentials will replace them."
        }
      ]
    },
    {
      "info": {
        "name": "Grids",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List grids",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/grids",
            "params": [
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "filters",
                "value": "[{ \"page\": { \"operator\": \"=\", \"values\": [\"/my/page\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions. Accepts the same format as returned by\nthe [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters\nare:\n\n- page: Filter grid by work package"
              }
            ]
          },
          "docs": "Lists all grids matching the provided filters and being part of the selected query page. The grids returned will\nalso depend on the permissions of the requesting user."
        },
        {
          "info": {
            "name": "Create a grid",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/grids",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new grid applying the attributes provided in the body. The constraints applied to the grid depend on the\npage the grid is placed in which is why the create form endpoint should be used to be guided when wanting to\ncreate a grid."
        },
        {
          "info": {
            "name": "Grid Create Form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/grids/form"
          },
          "docs": "Grid Create Form"
        },
        {
          "info": {
            "name": "Get a grid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/grids/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "Grid id"
              }
            ]
          },
          "docs": "Fetches a single grid identified by its id."
        },
        {
          "info": {
            "name": "Update a grid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/grids/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "Grid id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given grid by applying the attributes provided in the body. The constraints applied to the grid depend\non the page the grid is placed in which is why the create form endpoint should be used to be guided when wanting\nto update a grid."
        },
        {
          "info": {
            "name": "Grid Update Form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/grids/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the grid being modified"
              }
            ]
          },
          "docs": "Grid Update Form"
        }
      ]
    },
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/groups",
            "params": [
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:\n\n+ id: Sort by primary key\n\n+ created_at: Sort by group creation datetime\n\n+ updated_at: Sort by the time the group was updated last"
              },
              {
                "name": "select",
                "value": "total,elements/name,elements/self,self",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Returns a collection of groups. The client can choose to filter the\ngroups similar to how work packages are filtered. In addition to the provided\nfilters, the server will reduce the result set to only contain groups, for which\nthe requesting client has sufficient permissions (*view_members*, *manage_members*)."
        },
        {
          "info": {
            "name": "Create group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new group applying the attributes provided in the body."
        },
        {
          "info": {
            "name": "Get group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Group id"
              }
            ]
          },
          "docs": "Fetches a group resource."
        },
        {
          "info": {
            "name": "Update group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Group id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given group by applying the attributes provided in the body.\n\nPlease note that the `members` array provided will override the existing set of members (similar to a PUT). A\nclient thus has to provide the complete list of members the group is to have after the PATCH even if only one\nmember is to be added."
        },
        {
          "info": {
            "name": "Delete group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/groups/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Group id"
              }
            ]
          },
          "docs": "Deletes the group."
        }
      ]
    },
    {
      "info": {
        "name": "Help texts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List help texts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/help_texts"
          },
          "docs": "List the complete collection of help texts."
        },
        {
          "info": {
            "name": "Get help text",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/help_texts/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Help text id"
              }
            ]
          },
          "docs": "Fetches the help text from the given id."
        }
      ]
    },
    {
      "info": {
        "name": "Meetings",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all visible meetings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/meetings"
          },
          "docs": "Retrieve a paginated collection of meetings visible to the authenticated user."
        },
        {
          "info": {
            "name": "Get a meeting",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/meetings/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Meeting identifier"
              }
            ]
          },
          "docs": "Retrieve an individual meeting as identified by the id parameter"
        }
      ]
    },
    {
      "info": {
        "name": "Memberships",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List memberships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/memberships",
            "params": [
              {
                "name": "filters",
                "value": "",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ any_name_attribute: filters memberships based on the name of the principal. All possible name variants\n  (and also email and login) are searched.\n+ blocked: reduces the result set to all memberships that are temporarily blocked or that are not blocked\n  temporarily.\n+ group: filters memberships based on the name of a group. The group however is not the principal used for\n  filtering. Rather, the memberships of the group are used as the filter values.\n+ name: filters memberships based on the name of the principal. Note that only the name is used which depends\n  on a setting in the OpenProject instance.\n+ principal: filters memberships based on the id of the principal.\n+ project: filters memberships based on the id of the project.\n+ role: filters memberships based on the id of any role assigned to the membership.\n+ status: filters memberships based on the status of the principal.\n+ created_at: filters memberships based on the time the membership was created.\n+ updated_at: filters memberships based on the time the membership was updated last."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported sorts are:\n\n+ id: Sort by primary key\n+ name: Sort by the name of the principal. Note that this depends on the setting for how the name is to be\n  displayed at least for users.\n+ email: Sort by the email address of the principal. Groups and principal users, which do not have an email,\n  are sorted last.\n+ status: Sort by the status of the principal. Groups and principal users, which do not have a status, are\n  sorted together with the active users.\n+ created_at: Sort by membership creation datetime\n+ updated_at: Sort by the time the membership was updated last"
              }
            ]
          },
          "docs": "Returns a collection of memberships. The client can choose to filter\nthe memberships similar to how work packages are filtered. In addition to the\nprovided filters, the server will reduce the result set to only contain memberships,\nfor which the requesting client has sufficient permissions (*view_members*, *manage_members*)."
        },
        {
          "info": {
            "name": "Create a membership",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/memberships",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new membership applying the attributes provided in the body.\n\nYou can use the form and schema to retrieve the valid attribute values and by that be guided towards successful\ncreation.\n\nBy providing a `notificationMessage` within the `_meta` block of the payload, the client can include a customized\nmessage to the user of the newly created membership. In case of a group, the message will be sent to every user\nbelonging to the group.\n\nBy including `{ \"sendNotifications\": false }` within t"
        },
        {
          "info": {
            "name": "Available projects for memberships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/memberships/available_projects"
          },
          "docs": "Gets a list of projects in which a membership can be created in. The list contains all projects in which the user\nissuing the request has the manage members permissions."
        },
        {
          "info": {
            "name": "Form create membership",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/memberships/form",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requests and validates the creation form for memberships. The request payload, if sent, is validated. The form\nendpoint itself does not create a membership."
        },
        {
          "info": {
            "name": "Schema membership",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/memberships/schema"
          },
          "docs": "Retrieves the schema for the membership resource object."
        },
        {
          "info": {
            "name": "Get a membership",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/memberships/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Membership id"
              }
            ]
          },
          "docs": "Retrieves a membership resource identified by the given id."
        },
        {
          "info": {
            "name": "Update membership",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/memberships/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Membership id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given membership by applying the attributes provided in the body.\n\nBy providing a `notificationMessage` within the `_meta` block of the payload, the client can include a customized message to the user\nof the updated membership. In case of a group, the message will be sent to every user belonging to the group.\n\nBy including `{ \"sendNotifications\": false }` within the `_meta` block of the payload, no notifications is send out at all."
        },
        {
          "info": {
            "name": "Delete membership",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/memberships/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Membership id"
              }
            ]
          },
          "docs": "Deletes the membership."
        },
        {
          "info": {
            "name": "Form update membership",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/memberships/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Membership id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requests and validates the update form for a membership identified by the given id. The request payload, if sent,\nis validated. The form endpoint itself does not change the membership."
        }
      ]
    },
    {
      "info": {
        "name": "UserPreferences",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Show my preferences",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/my_preferences"
          },
          "docs": "Show my preferences"
        },
        {
          "info": {
            "name": "Update my preferences",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/my_preferences",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing the properties that it wants to change, in the body."
        }
      ]
    },
    {
      "info": {
        "name": "News",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List News",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/news",
            "params": [
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "sortBy",
                "value": "[[\"created_at\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:\n\n+ id: Sort by primary key\n\n+ created_at: Sort by news creation datetime"
              },
              {
                "name": "filters",
                "value": "[{ \"project_id\": { \"operator\": \"=\", \"values\": [\"1\", \"2\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are:\n\n+ project_id: Filter news by project"
              }
            ]
          },
          "docs": "Lists news. The news returned depend on the provided parameters and also on the requesting user's permissions."
        },
        {
          "info": {
            "name": "Create News",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/news",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a news entry. Only administrators and users with \"Manage news\" permission in the given project are eligible.\nWhen calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body."
        },
        {
          "info": {
            "name": "View news",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/news/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "news id"
              }
            ]
          },
          "docs": "View news"
        },
        {
          "info": {
            "name": "Update news",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/news/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "News id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the news's writable attributes.\nWhen calling this endpoint the client provides a single object, containing the properties and links to be updated, in the body."
        },
        {
          "info": {
            "name": "Delete news",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/news/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "News id"
              }
            ]
          },
          "docs": "Permanently deletes the specified news entry."
        }
      ]
    },
    {
      "info": {
        "name": "Notifications",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get notification collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/notifications",
            "params": [
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "sortBy",
                "value": "[[\"reason\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:\n\n+ id: Sort by primary key\n\n+ reason: Sort by notification reason\n\n+ readIAN: Sort by read status"
              },
              {
                "name": "groupBy",
                "value": "reason",
                "type": "query",
                "description": "string specifying group_by criteria.\n\n+ reason: Group by notification reason\n\n+ project: Sort by associated project"
              },
              {
                "name": "filters",
                "value": "[{ \"readIAN\": { \"operator\": \"=\", \"values\": [\"t\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are:\n\n+ id: Filter by primary key\n\n+ project: Filter by the project the notification was created in\n\n+ readIAN: Filter by read status\n\n+ reason: Filter by the reason, e.g. 'mentioned' or 'assigned' the notification was created because of\n\n+ resourceId: Filter by the id of the resource the notification was created for. Ideally used together with the `resourceType` filter.\n\n+ resourceType: Filter by the type of the resource the notification was created for. Ideally used together with the `resourceId` filter."
              }
            ]
          },
          "docs": "Returns the collection of available in-app notifications. The notifications returned depend on the provided\nparameters and also on the requesting user's permissions.\n\nContrary to most collections, this one also links to and embeds schemas for the `details` properties of the notifications returned.\nThis is an optimization. Clients will receive the information necessary to display the various types of details that a notification\ncan carry."
        },
        {
          "info": {
            "name": "Read all notifications",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/notifications/read_ian",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"reason\": { \"operator\": \"=\", \"values\": [\"mentioned\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ id: Filter by primary key\n\n+ project: Filter by the project the notification was created in\n\n+ reason: Filter by the reason, e.g. 'mentioned' or 'assigned' the notification was created because of\n\n+ resourceId: Filter by the id of the resource the notification was created for. Ideally used together with the\n  `resourceType` filter.\n\n+ resourceType: Filter by the type of the resource the notification was created for. Ideally used together with\n  the `resourceId` filter."
              }
            ]
          },
          "docs": "Marks the whole notification collection as read. The collection contains only elements the authenticated user can\nsee, and can be further reduced with filters."
        },
        {
          "info": {
            "name": "Unread all notifications",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/notifications/unread_ian",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"reason\": { \"operator\": \"=\", \"values\": [\"mentioned\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ id: Filter by primary key\n\n+ project: Filter by the project the notification was created in\n\n+ reason: Filter by the reason, e.g. 'mentioned' or 'assigned' the notification was created because of\n\n+ resourceId: Filter by the id of the resource the notification was created for. Ideally used together with the\n  `resourceType` filter.\n\n+ resourceType: Filter by the type of the resource the notification was created for. Ideally used together with\n  the `resourceId` filter."
              }
            ]
          },
          "docs": "Marks the whole notification collection as unread. The collection contains only elements the authenticated user can\nsee, and can be further reduced with filters."
        },
        {
          "info": {
            "name": "Get the notification",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/notifications/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "notification id"
              }
            ]
          },
          "docs": "Returns the notification identified by the notification id."
        },
        {
          "info": {
            "name": "Get a notification detail",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/notifications/:notification_id/details/:id",
            "params": [
              {
                "name": "notification_id",
                "value": "1",
                "type": "path",
                "description": "notification id"
              },
              {
                "name": "id",
                "value": "0",
                "type": "path",
                "description": "detail id"
              }
            ]
          },
          "docs": "Returns an individual detail of a notification identified by the notification id and the id of the detail."
        },
        {
          "info": {
            "name": "Read notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/notifications/:id/read_ian",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "notification id"
              }
            ]
          },
          "docs": "Marks the given notification as read."
        },
        {
          "info": {
            "name": "Unread notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/notifications/:id/unread_ian",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "notification id"
              }
            ]
          },
          "docs": "Marks the given notification as unread."
        }
      ]
    },
    {
      "info": {
        "name": "OAuth 2",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the oauth application.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/oauth_applications/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "OAuth application id"
              }
            ]
          },
          "docs": "Retrieves the OAuth 2 provider application for the given identifier. The secret will not be part of the response,\ninstead a `confidential` flag is indicating, whether there is a secret or not."
        },
        {
          "info": {
            "name": "Get the oauth client credentials object.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/oauth_client_credentials/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "OAuth Client Credentials id"
              }
            ]
          },
          "docs": "Retrieves the OAuth 2 client credentials for the given identifier. The secret will not be part of the response,\ninstead a `confidential` flag is indicating, whether there is a secret or not."
        }
      ]
    },
    {
      "info": {
        "name": "Principals",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List placehoder users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/placeholder_users",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"name\": { \"operator\": \"~\", \"values\": [\"Darth\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n- name: filters placeholder users by the name.\n- group: filters placeholder by the group it is contained in.\n- status: filters placeholder by the status it has."
              },
              {
                "name": "select",
                "value": "total,elements/name,elements/self,self",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "List all placeholder users. This can only be accessed if the requesting user has the global permission\n`manage_placeholder_user` or `manage_members` in any project."
        },
        {
          "info": {
            "name": "Create placeholder user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/placeholder_users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new placeholder user. Only administrators and users with `manage_placeholder_user` global permission are\nallowed to do so. When calling this endpoint the client provides a single object, containing at least the\nproperties and links that are required, in the body."
        },
        {
          "info": {
            "name": "View placeholder user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/placeholder_users/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "The placeholder user id"
              }
            ]
          },
          "docs": "Return the placeholder user resource."
        },
        {
          "info": {
            "name": "Update placeholder user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/placeholder_users/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Placeholder user id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the placeholder user's writable attributes.\nWhen calling this endpoint the client provides a single object, containing at least the properties and links\nthat are required, in the body."
        },
        {
          "info": {
            "name": "Delete placeholder user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/placeholder_users/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Placeholder user id"
              }
            ]
          },
          "docs": "Set the specified placeholder user to deleted status."
        },
        {
          "info": {
            "name": "List principals",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/principals",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"type\": { \"operator\": \"=\", \"values\": [\"User\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n- type: filters principals by their type (*User*, *Group*, *PlaceholderUser*).\n- member: filters principals by the projects they are members in.\n- name: filters principals by the user or group name.\n- any_name_attribute: filters principals by the user or group first- and last name, email or login.\n- status: filters principals by their status number (active = *1*, registered = *2*, locked = *3*, invited = *4*)"
              },
              {
                "name": "select",
                "value": "total,elements/name,elements/self,self",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "List all principals. The client can choose to filter the principals similar to how work packages are filtered. In\naddition to the provided filters, the server will reduce the result set to only contain principals who are members\nin projects the client is allowed to see."
        }
      ]
    },
    {
      "info": {
        "name": "Portfolios",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List portfolios",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/portfolios",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"ancestor\": { \"operator\": \"=\", \"values\": [\"1\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openportfolio.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n+ active: based on the active property of the portfolio\n+ ancestor: filters portfolios by their ancestor. A portfolio is not considered to be its own ancestor.\n+ available_project_attributes: filters portfolios based on the activated project attributes.\n+ created_at: based on the time the portfolio was created\n+ favorited: based on the favorited property of the portfolio\n+ id: based on portfolios' id.\n+ latest_activity_at: based on the time the last activity was registered on a portfolio.\n+ name_and_identifier: based on both the name and the identifier.\n+ parent_id: filters portfolios by their parent.\n+ principal: based on members of the portfolio.\n+ project_phase_any: based on the project phases active in a portfolio.\n+ project_status_code: based on status code of the portfolio\n+ storage_id: filters portfolios by linked storages\n+ storage_url: filters portfolios by linked storages identified by the host url\n+ type_id: based on the types active in a portfolio.\n+ user_action: based on the actions the current user has in the portfolio.\n+ visible: based on the visibility for the user (id) provided as the filter value. This filter is useful for admins to identify the portfolios visible to a user.\n\nThere might also be additional filters based on the custom fields that have been configured.\n\nEach defined lifecycle step will also define a filter in this list endpoint. Given that the elements are not\nstatic but rather dynamically created on each OpenProject instance, a list cannot be provided. Those filters follow the schema:\n+ project_start_gate_[id]: a filter on a project phase's start gate active in a portfolio. The id is the id of the phase the gate belongs to.\n+ project_finish_gate_[id]: a filter on a project phase's finish gate active in a portfolio. The id is the id of the phase the gate belongs to.\n+ project_phase_[id]: a filter on a project phase active in a portfolio. The id is the id of the phase queried for."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nCurrently supported orders are:\n\n+ id\n+ name\n+ typeahead (sorting by hierarchy and name)\n+ created_at\n+ public\n+ latest_activity_at\n+ required_disk_space\n\nThere might also be additional orders based on the custom fields that have been configured."
              },
              {
                "name": "select",
                "value": "total,elements/identifier,elements/name",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Returns a collection of portfolios. The collection can be filtered via query parameters similar to how work packages are filtered. In addition to the provided filter, the result set is always limited to only contain portfolios the client is allowed to see."
        },
        {
          "info": {
            "name": "View portfolio",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/portfolios/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Portfolio id"
              }
            ]
          },
          "docs": "View portfolio"
        },
        {
          "info": {
            "name": "Update Portfolio",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/portfolios/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Portfolio id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given portfolio by applying the attributes provided in the body."
        },
        {
          "info": {
            "name": "Delete Portfolio",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/portfolios/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Portfolio id"
              }
            ]
          },
          "docs": "Deletes the portfolio permanently. As this is a lengthy process, the actual deletion is carried out asynchronously.\nSo the portfolio might exist well after the request has returned successfully. To prevent unwanted changes to\nthe portfolio scheduled for deletion, it is archived at once."
        },
        {
          "info": {
            "name": "Portfolio update form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/portfolios/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Portfolio id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Portfolio update form"
        }
      ]
    },
    {
      "info": {
        "name": "Posts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Post",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/posts/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Post's identifier"
              }
            ]
          },
          "docs": "Retrieve an individual post as identified by the id parameter"
        }
      ]
    },
    {
      "info": {
        "name": "Priorities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all Priorities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/priorities"
          },
          "docs": "List all Priorities"
        },
        {
          "info": {
            "name": "View Priority",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/priorities/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Priority id"
              }
            ]
          },
          "docs": "View Priority"
        }
      ]
    },
    {
      "info": {
        "name": "Programs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List programs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/programs",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"ancestor\": { \"operator\": \"=\", \"values\": [\"1\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n+ active: based on the active property of the program\n+ ancestor: filters programs by their ancestor. A program is not considered to be its own ancestor.\n+ available_project_attributes: filters programs based on the activated project attributes.\n+ created_at: based on the time the program was created\n+ favorited: based on the favorited property of the program\n+ id: based on programs' id.\n+ latest_activity_at: based on the time the last activity was registered on a program.\n+ name_and_identifier: based on both the name and the identifier.\n+ parent_id: filters programs by their parent.\n+ principal: based on members of the program.\n+ project_phase_any: based on the project phases active in a program.\n+ project_status_code: based on status code of the program\n+ storage_id: filters programs by linked storages\n+ storage_url: filters programs by linked storages identified by the host url\n+ type_id: based on the types active in a program.\n+ user_action: based on the actions the current user has in the program.\n+ visible: based on the visibility for the user (id) provided as the filter value. This filter is useful for admins to identify the programs visible to a user.\n\nThere might also be additional filters based on the custom fields that have been configured.\n\nEach defined lifecycle step will also define a filter in this list endpoint. Given that the elements are not\nstatic but rather dynamically created on each OpenProject instance, a list cannot be provided. Those filters follow the schema:\n+ project_start_gate_[id]: a filter on a project phase's start gate active in a program. The id is the id of the phase the gate belongs to.\n+ project_finish_gate_[id]: a filter on a project phase's finish gate active in a program. The id is the id of the phase the gate belongs to.\n+ project_phase_[id]: a filter on a project phase active in a program. The id is the id of the phase queried for."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nCurrently supported orders are:\n\n+ id\n+ name\n+ typeahead (sorting by hierarchy and name)\n+ created_at\n+ public\n+ latest_activity_at\n+ required_disk_space\n\nThere might also be additional orders based on the custom fields that have been configured."
              },
              {
                "name": "select",
                "value": "total,elements/identifier,elements/name",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Returns a collection of programs. The collection can be filtered via query parameters similar to how work packages are filtered. In addition to the provided filter, the result set is always limited to only contain programs the client is allowed to see."
        },
        {
          "info": {
            "name": "View program",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/programs/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Program id"
              }
            ]
          },
          "docs": "View program"
        },
        {
          "info": {
            "name": "Update Program",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/programs/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Program id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given program by applying the attributes provided in the body."
        },
        {
          "info": {
            "name": "Delete Program",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/programs/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Program id"
              }
            ]
          },
          "docs": "Deletes the program permanently. As this is a lengthy process, the actual deletion is carried out asynchronously.\nSo the program might exist well after the request has returned successfully. To prevent unwanted changes to\nthe program scheduled for deletion, it is archived at once."
        },
        {
          "info": {
            "name": "Program update form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/programs/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Program id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Program update form"
        }
      ]
    },
    {
      "info": {
        "name": "Project Phases",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a project phase",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/project_phases/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Project phase id"
              }
            ]
          },
          "docs": "Gets a project phase resource. This resource contains an instance of a ProjectPhaseDefinition within a project which can\nthen have project specific dates."
        }
      ]
    },
    {
      "info": {
        "name": "Project Phase Definitions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List project phase definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/project_phase_definitions"
          },
          "docs": "Returns a collection of all project phase definitions.\nThe result set is always limited to only contain project phase definitions the client is allowed to see."
        },
        {
          "info": {
            "name": "Get a project phase definition",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/project_phase_definitions/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Project phase definition id"
              }
            ]
          },
          "docs": "Gets a project phase definition resource. This resource is part of the abstract definition of a project life\ncycle shaping the phases of a project. "
        }
      ]
    },
    {
      "info": {
        "name": "File Links",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a list of project storages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/project_storages",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"project_id\": { \"operator\": \"=\", \"values\": [\"42\"] }}, { \"storage_id\": { \"operator\": \"=\", \"values\": [\"1337\"] }}]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n- project_id\n- storage_id\n- storage_url"
              }
            ]
          },
          "docs": "Gets a collection of all project storages that meet the provided filters and the user has permission to see them."
        },
        {
          "info": {
            "name": "Gets a project storage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/project_storages/:id",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Project storage id"
              }
            ]
          },
          "docs": "Gets a project storage resource. This resource contains all data that is applicable on the relation between a\nstorage and a project."
        },
        {
          "info": {
            "name": "Open the project storage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/project_storages/:id/open",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Project storage id"
              }
            ]
          },
          "docs": "Gets a redirect to the location of the project storage's remote origin. If the project storage has a project\nfolder, it is opened at this location. If not, the storage root is opened."
        },
        {
          "info": {
            "name": "Open the storage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/storages/:id/open",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Storage id"
              }
            ]
          },
          "docs": "Gets a redirect to the location of the storage's remote origin. The storage's files root should be the target\nlocation."
        }
      ]
    },
    {
      "info": {
        "name": "Projects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"ancestor\": { \"operator\": \"=\", \"values\": [\"1\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n+ active: based on the active property of the project\n+ ancestor: filters projects by their ancestor. A project is not considered to be its own ancestor.\n+ available_project_attributes: filters projects based on the activated project project attributes.\n+ created_at: based on the time the project was created\n+ favorited: based on the favorited property of the project\n+ id: based on projects' id.\n+ latest_activity_at: based on the time the last activity was registered on a project.\n+ name_and_identifier: based on both the name and the identifier.\n+ parent_id: filters projects by their parent.\n+ principal: based on members of the project.\n+ project_phase_any: based on the project phases active in a project.\n+ project_status_code: based on status code of the project\n+ storage_id: filters projects by linked storages\n+ storage_url: filters projects by linked storages identified by the host url\n+ type_id: based on the types active in a project.\n+ user_action: based on the actions the current user has in the project.\n+ visible: based on the visibility for the user (id) provided as the filter value. This filter is useful for admins to identify the projects visible to a user.\n\nThere might also be additional filters based on the custom fields that have been configured.\n\nEach defined lifecycle step will also define a filter in this list endpoint. Given that the elements are not\nstatic but rather dynamically created on each OpenProject instance, a list cannot be provided. Those filters follow the schema:\n+ project_start_gate_[id]: a filter on a project phase's start gate active in a project. The id is the id of the phase the gate belongs to.\n+ project_finish_gate_[id]: a filter on a project phase's finish gate active in a project. The id is the id of the phase the gate belongs to.\n+ project_phase_[id]: a filter on a project phase active in a project. The id is the id of the phase queried for."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nCurrently supported orders are:\n\n+ id\n+ name\n+ typeahead (sorting by hierarchy and name)\n+ created_at\n+ public\n+ latest_activity_at\n+ required_disk_space\n\nThere might also be additional orders based on the custom fields that have been configured."
              },
              {
                "name": "select",
                "value": "total,elements/identifier,elements/name",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Returns a collection of projects. The collection can be filtered via query parameters similar to how work packages are filtered. In addition to the provided filter, the result set is always limited to only contain projects the client is allowed to see.\nPrior to OpenProject 17.0, only projects existed and the concept of workspaces wasn't implemented in the API. With 17.0 the other workspace types (program and portfolio) exist and will be returned alongside projects by this endpoint. This might su"
        },
        {
          "info": {
            "name": "Create project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new project, applying the attributes provided in the body.\n\nYou can use the form and schema to be retrieve the valid attribute values and by that be guided towards successful creation."
        },
        {
          "info": {
            "name": "Project create form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects/form",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Project create form"
        },
        {
          "info": {
            "name": "View project schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/schema"
          },
          "docs": "Provides the schema describing a project resource.\nThis endpoint is deprecated. As projects are workspaces, an equivalent schema can be found fetching `/api/v3/workspaces/schema`."
        },
        {
          "info": {
            "name": "View project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "View project"
        },
        {
          "info": {
            "name": "Update Project",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given project by applying the attributes provided in the body."
        },
        {
          "info": {
            "name": "Delete Project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Deletes the project permanently. As this is a lengthy process, the actual deletion is carried out asynchronously.\nSo the project might exist well after the request has returned successfully. To prevent unwanted changes to\nthe project scheduled for deletion, it is archived at once."
        },
        {
          "info": {
            "name": "Project update form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Project update form"
        },
        {
          "info": {
            "name": "Create project copy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/copy",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Create project copy"
        },
        {
          "info": {
            "name": "Project copy form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/copy/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Project copy form"
        },
        {
          "info": {
            "name": "View project status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/project_statuses/:id",
            "params": [
              {
                "name": "id",
                "value": "on_track",
                "type": "path",
                "description": "Project status id"
              }
            ]
          },
          "docs": "View project status"
        },
        {
          "info": {
            "name": "List available parent project candidates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/available_parent_projects",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"ancestor\": { \"operator\": \"=\", \"values\": ['1'] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions."
              },
              {
                "name": "of",
                "value": "123",
                "type": "query",
                "description": "The id or identifier of the project the parent candidate is determined for"
              },
              {
                "name": "workspace_type",
                "value": "program",
                "type": "query",
                "description": "The workspace type of the new project the parent candidate is determined for. Ignored when `of` parameter is provided.\nNote that while 'portfolio' is supported as a type (since it is a type of Workspace), the endpoint will currently always return an empty resultset as portfolios cannot have parents."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint and allows all the filters and sortBy supported by the project list endpoint."
              }
            ]
          },
          "docs": "Lists projects which can become parent to another project. Only sound candidates are returned.\nFor instance a project cannot become parent of itself or its children.\n\nTo specify the project for which a parent is queried for, the `of` parameter can be provided. If no `of`\nparameter is provided, a new project is assumed. Then, the check for the hierarchy is omitted as a new project cannot be\npart of a hierarchy yet, instead `workspace_type` parameter can be passed defining it for new project.\n\nCan"
        },
        {
          "info": {
            "name": "Favorite Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/favorite",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Adds the project to the current user's favorites.\n\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/favorite`](https://www.openproject.org/docs/api/endpoints/workspaces/#favorite-workspace)"
        },
        {
          "info": {
            "name": "Unfavorite Project",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/favorite",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Removes the project from the current user's favorites.\n\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/favorite`](https://www.openproject.org/docs/api/endpoints/workspaces/#unfavorite-workspace)"
        },
        {
          "info": {
            "name": "List projects having version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/versions/:id/projects",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Version id"
              }
            ]
          },
          "docs": "This endpoint lists the projects where the given version is available.\n\nThe projects returned depend on the sharing settings of the given version,\nbut are also limited to the projects that the current user is allowed to see.\n\nThis endpoint is deprecated and replaced by [`/api/v3/versions/{id}/workspaces`](https://www.openproject.org/docs/api/endpoints/projects/#list-workspaces-having-version)"
        },
        {
          "info": {
            "name": "List workspaces having version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/versions/:id/workspaces",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Version id"
              }
            ]
          },
          "docs": "This endpoint lists the workspaces where the given version is available.\n\nThe workspaces returned depend on the sharing settings of the given version,\nbut are also limited to the workspaces that the current user is allowed to see."
        }
      ]
    },
    {
      "info": {
        "name": "Queries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View default query for project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/queries/default",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Id of the project the default query is requested for"
              },
              {
                "name": "filters",
                "value": "[{ \"assignee\": { \"operator\": \"=\", \"values\": [\"1\", \"5\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nThe filters provided as parameters are not applied to the query but are instead used to override the query's persisted filters.\nAll filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`)."
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the queries' result collection of work packages."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page for the queries' result collection of work packages."
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria."
              },
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query",
                "description": "Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property."
              },
              {
                "name": "timestamps",
                "value": "2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00",
                "type": "query",
                "description": "Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: \"oneDayAgo@HH:MM+HH:MM\", \"lastWorkingDay@HH:MM+HH:MM\", \"oneWeekAgo@HH:MM+HH:MM\", \"oneMonthAgo@HH:MM+HH:MM\". The first \"HH:MM\" part represents the zero paded hours and minutes. The last \"+HH:MM\" part represents the timezone offset from UTC associated with the time. Values older than 1 day are accepted only with valid Enterprise Token available.\n"
              },
              {
                "name": "timelineVisible",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the timeline should be shown."
              },
              {
                "name": "showHierarchies",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the hierarchy mode should be enabled."
              }
            ]
          },
          "docs": "Same as [viewing an existing, persisted Query](https://www.openproject.org/docs/api/endpoints/queries/#list-queries)\nin its response, this resource returns an unpersisted query and by that allows\nto get the default query configuration. The client may also provide additional\nparameters which will modify the default query. The query will already be scoped\nto the project.\n\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/queries/default`](https://www.openproject.org/docs/api/en"
        },
        {
          "info": {
            "name": "View schema for project queries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/queries/schema",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Retrieve the schema for project queries.\n\nThis endpoint is deprecated and replaced by ['/api/v3/workspaces/{id}/queries/schema`](https://www.openproject.org/docs/api/endpoints/queries/#view-schema-for-workspace-queries)"
        },
        {
          "info": {
            "name": "List queries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"project_id\": { \"operator\": \"!*\", \"values\": null }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nCurrently supported filters are:\n\n+ project: filters queries by the project they are assigned to. If the project filter is passed with the `!*` (not any) operator, global queries are returned.\n\n+ id: filters queries based on their id\n\n+ updated_at: filters queries based on the last time they where updated"
              }
            ]
          },
          "docs": "Returns a collection of queries. The collection can be filtered via query parameters similar to how work packages are filtered. Please note however, that the filters are applied to the queries and not to the work packages the queries in turn might return."
        },
        {
          "info": {
            "name": "Create query",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/queries",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.\nThe required fields of a Query can be found in its schema, which is embedded in the respective form.\nNote that it is only allowed to provide properties or links supporting the write operation."
        },
        {
          "info": {
            "name": "Available projects for query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/available_projects"
          },
          "docs": "Gets a list of projects that are available as projects a query can be assigned to."
        },
        {
          "info": {
            "name": "View default query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/default",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"assignee\": { \"operator\": \"=\", \"values\": [\"1\", \"5\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nThe filters provided as parameters are not applied to the query but are instead used to override the query's persisted filters.\nAll filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`)."
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the queries' result collection of work packages."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page for the queries' result collection of work packages."
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria."
              },
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query",
                "description": "Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property."
              },
              {
                "name": "timestamps",
                "value": "2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00",
                "type": "query",
                "description": "Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: \"oneDayAgo@HH:MM+HH:MM\", \"lastWorkingDay@HH:MM+HH:MM\", \"oneWeekAgo@HH:MM+HH:MM\", \"oneMonthAgo@HH:MM+HH:MM\". The first \"HH:MM\" part represents the zero paded hours and minutes. The last \"+HH:MM\" part represents the timezone offset from UTC associated with the time, the offset can be positive or negative e.g.\"oneDayAgo@01:00+01:00\", \"oneDayAgo@01:00-01:00\". Values older than 1 day are accepted only with valid Enterprise Token available.\n"
              },
              {
                "name": "timelineVisible",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the timeline should be shown."
              },
              {
                "name": "timelineZoomLevel",
                "value": "days",
                "type": "query",
                "description": "Indicates in what zoom level the timeline should be shown. Valid values are  `days`, `weeks`, `months`, `quarters`, and `years`."
              },
              {
                "name": "showHierarchies",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the hierarchy mode should be enabled."
              }
            ]
          },
          "docs": "Same as [viewing an existing, persisted Query](https://www.openproject.org/docs/api/endpoints/queries/#list-queries) in its response, this resource returns an unpersisted query and by that allows to get the default query configuration. The client may also provide additional parameters which will modify the default query."
        },
        {
          "info": {
            "name": "Query Create Form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/queries/form",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query Create Form"
        },
        {
          "info": {
            "name": "View schema for global queries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/schema"
          },
          "docs": "Retrieve the schema for global queries, those, that are not assigned to a project."
        },
        {
          "info": {
            "name": "View query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Query id"
              },
              {
                "name": "filters",
                "value": "[{ \"assignee\": { \"operator\": \"=\", \"values\": [\"1\", \"5\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nThe filters provided as parameters are not applied to the query but are instead used to override the query's persisted filters.\nAll filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`)."
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the queries' result collection of work packages."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page for the queries' result collection of work packages."
              },
              {
                "name": "columns",
                "value": "[]",
                "type": "query",
                "description": "Selected columns for the table view."
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria."
              },
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query",
                "description": "Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property."
              },
              {
                "name": "timestamps",
                "value": "2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00",
                "type": "query",
                "description": "Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: \"oneDayAgo@HH:MM+HH:MM\", \"lastWorkingDay@HH:MM+HH:MM\", \"oneWeekAgo@HH:MM+HH:MM\", \"oneMonthAgo@HH:MM+HH:MM\". The first \"HH:MM\" part represents the zero paded hours and minutes. The last \"+HH:MM\" part represents the timezone offset from UTC associated with the time, the offset can be positive or negative e.g.\"oneDayAgo@01:00+01:00\", \"oneDayAgo@01:00-01:00\". Values older than 1 day are accepted only with valid Enterprise Token available.\n"
              },
              {
                "name": "timelineVisible",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the timeline should be shown."
              },
              {
                "name": "timelineLabels",
                "value": "{}",
                "type": "query",
                "description": "Overridden labels in the timeline view"
              },
              {
                "name": "highlightingMode",
                "value": "inline",
                "type": "query",
                "description": "Highlighting mode for the table view."
              },
              {
                "name": "highlightedAttributes",
                "value": "[]",
                "type": "query",
                "description": "Highlighted attributes mode for the table view when `highlightingMode` is `inline`. When set to `[]` all highlightable attributes will be returned as `highlightedAttributes`."
              },
              {
                "name": "showHierarchies",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the hierarchy mode should be enabled."
              }
            ]
          },
          "docs": "Retrieve an individual query as identified by the id parameter. Then endpoint accepts a number of parameters that can be used to override the resources' persisted parameters."
        },
        {
          "info": {
            "name": "Edit Query",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/queries/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Query id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing the properties and links that it wants to change, in the body.\nNote that it is only allowed to provide properties or links supporting the **write** operation."
        },
        {
          "info": {
            "name": "Delete query",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/queries/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Query id"
              }
            ]
          },
          "docs": "Delete the query identified by the id parameter"
        },
        {
          "info": {
            "name": "Query Update Form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/queries/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Query id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query Update Form"
        },
        {
          "info": {
            "name": "Star query",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/queries/:id/star",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Query id"
              }
            ]
          },
          "docs": "Star query"
        },
        {
          "info": {
            "name": "Unstar query",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/queries/:id/unstar",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Query id"
              }
            ]
          },
          "docs": "Unstar query"
        },
        {
          "info": {
            "name": "View default query for workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/queries/default",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Id of the workspace the default query is requested for"
              },
              {
                "name": "filters",
                "value": "[{ \"assignee\": { \"operator\": \"=\", \"values\": [\"1\", \"5\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nThe filters provided as parameters are not applied to the query but are instead used to override the query's persisted filters.\nAll filters also accepted by the work packages endpoint are accepted. If no filter is to be applied, the client should send an empty array (`[]`)."
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the queries' result collection of work packages."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page for the queries' result collection of work packages."
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria. The sort criteria is applied to the query's result collection of work packages overriding the query's persisted sort criteria."
              },
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by. The grouping criteria is applied to the to the query's result collection of work packages overriding the query's persisted group criteria."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query",
                "description": "Indicates whether properties should be summed up if they support it. The showSums parameter is applied to the to the query's result collection of work packages overriding the query's persisted sums property."
              },
              {
                "name": "timestamps",
                "value": "2023-01-01,P-1Y,PT0S,lastWorkingDay@12:00",
                "type": "query",
                "description": "Indicates the timestamps to filter by when showing changed attributes on work packages. Values can be either ISO8601 dates, ISO8601 durations and the following relative date keywords: \"oneDayAgo@HH:MM+HH:MM\", \"lastWorkingDay@HH:MM+HH:MM\", \"oneWeekAgo@HH:MM+HH:MM\", \"oneMonthAgo@HH:MM+HH:MM\". The first \"HH:MM\" part represents the zero paded hours and minutes. The last \"+HH:MM\" part represents the timezone offset from UTC associated with the time. Values older than 1 day are accepted only with valid Enterprise Token available.\n"
              },
              {
                "name": "timelineVisible",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the timeline should be shown."
              },
              {
                "name": "showHierarchies",
                "value": "true",
                "type": "query",
                "description": "Indicates whether the hierarchy mode should be enabled."
              }
            ]
          },
          "docs": "Same as [viewing an existing, persisted Query](https://www.openproject.org/docs/api/endpoints/queries/#list-queries) in its response, this resource returns an unpersisted query and by that allows to get the default query configuration. The client may also provide additional parameters which will modify the default query. The query will already be scoped to the workspace."
        },
        {
          "info": {
            "name": "View schema for workspace queries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspace/:id/queries/schema",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Retrieve the schema for workspace queries."
        }
      ]
    },
    {
      "info": {
        "name": "Query Filter Instance Schema",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Query Filter Instance Schemas for Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/queries/filter_instance_schemas",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Returns the list of QueryFilterInstanceSchemas defined for a query\nof the specified project.\n\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/queries/filter_instance_schemas`](https://www.openproject.org/docs/api/endpoints/query-filter-instance-schema/#list-query-filter-instance-schemas-for-workspace)"
        },
        {
          "info": {
            "name": "List Query Filter Instance Schemas",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/filter_instance_schemas"
          },
          "docs": "Returns the list of QueryFilterInstanceSchemas defined for a global query. That is a query not assigned to a project."
        },
        {
          "info": {
            "name": "View Query Filter Instance Schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/filter_instance_schemas/:id",
            "params": [
              {
                "name": "id",
                "value": "author",
                "type": "path",
                "description": "QueryFilterInstanceSchema identifier. The identifier is the filter identifier."
              }
            ]
          },
          "docs": "Retrieve an individual QueryFilterInstanceSchema as identified by the id parameter."
        },
        {
          "info": {
            "name": "List Query Filter Instance Schemas for Workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspace/:id/queries/filter_instance_schemas",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Workspace id"
              }
            ]
          },
          "docs": "Returns the list of QueryFilterInstanceSchemas defined for a query of the specified workspace."
        }
      ]
    },
    {
      "info": {
        "name": "Work Packages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get work packages of project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/work_packages",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "filters",
                "value": "[{ \"type_id\": { \"operator\": \"=\", \"values\": ['1', '2'] }}]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. If no filter is to be applied, the client should send an empty array (`[]`)."
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint."
              },
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query",
                "description": "Indicates whether properties should be summed up if they support it."
              },
              {
                "name": "select",
                "value": "total,elements/subject,elements/id,self",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Returns the collection of work packages that are related to the given project.\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/work_packages`](https://www.openproject.org/docs/api/endpoints/work-packages/#get-work-packages-of-workspace)"
        },
        {
          "info": {
            "name": "Create work package in project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/work_packages",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              },
              {
                "name": "notify",
                "value": "false",
                "type": "query",
                "description": "Indicates whether change notifications (e.g. via E-Mail) should be sent.\nNote that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),\nnot just the current user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing at least the properties and links that\nare required, in the body. The required fields of a WorkPackage can be found in its schema, which is embedded in\nthe respective form. Note that it is only allowed to provide properties or links supporting the write operation.\n\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/work_packages`](https://www.openproject.org/docs/api/endpoints/work-packages/#create-work"
        },
        {
          "info": {
            "name": "Form for creating Work Packages in a Project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/work_packages/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the project in which the work package will be created"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to validation a new work package creation body in a specific project. It works similarly\nto the `/api/v3/work_packages/form` endpoint, but already specifies the work package's project in the path, so that\nit does not have to be defined in the request body.\n\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/work_packages/form`](https://www.openproject.org/docs/api/endpoints/work-packages/#form-for-creating-work-packages-in-a-workspace)"
        },
        {
          "info": {
            "name": "Project Available assignees",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/available_assignees",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Gets a list of users that can be assigned to work packages in the given project.\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/available_assignees`](https://www.openproject.org/docs/api/endpoints/work-packages/#workspace-available-assignees)"
        },
        {
          "info": {
            "name": "List work packages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages",
            "params": [
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "filters",
                "value": "[{ \"type_id\": { \"operator\": \"=\", \"values\": [\"1\", \"2\"] }}]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. If no filter is to be applied, the client should send an empty array (`[]`), otherwise a default\nfilter is applied. A Currently supported filters are (there are additional filters added by modules):\n\n- assigned_to\n- assignee_or_group\n- attachment_base\n- attachment_content\n- attachment_file_name\n- author\n- blocked\n- blocks\n- category\n- comment\n- created_at\n- custom_field\n- dates_interval\n- description\n- done_ratio\n- due_date\n- duplicated\n- duplicates\n- duration\n- estimated_hours\n- file_link_origin_id\n- follows\n- group\n- id\n- includes\n- linkable_to_storage_id\n- linkable_to_storage_url\n- manual_sort\n- milestone\n- only_subproject\n- parent\n- partof\n- precedes\n- principal_base\n- priority\n- project\n- relatable\n- relates\n- required\n- requires\n- responsible\n- role\n- search\n- start_date\n- status\n- storage_id\n- storage_url\n- subject\n- subject_or_id\n- subproject\n- type\n- typeahead\n- updated_at\n- version\n- watcher\n- work_package"
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint."
              },
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query",
                "description": "Indicates whether properties should be summed up if they support it."
              },
              {
                "name": "select",
                "value": "total,elements/subject,elements/id,self",
                "type": "query",
                "description": "Comma separated list of properties to include."
              },
              {
                "name": "timestamps",
                "value": "2022-01-01T00:00:00Z,PT0S",
                "type": "query",
                "description": "In order to perform a [baseline comparison](/docs/api/baseline-comparisons), you may provide one or several timestamps\nin ISO-8601 format as comma-separated list. The timestamps may be absolute or relative,\nsuch as ISO8601 dates, ISO8601 durations and the following relative date keywords: \"oneDayAgo@HH:MM+HH:MM\",\n\"lastWorkingDay@HH:MM+HH:MM\", \"oneWeekAgo@HH:MM+HH:MM\", \"oneMonthAgo@HH:MM+HH:MM\".\nThe first \"HH:MM\" part represents the zero paded hours and minutes.\nThe last \"+HH:MM\" part represents the timezone offset from UTC associated with the time,\nthe offset can be positive or negative e.g.\"oneDayAgo@01:00+01:00\", \"oneDayAgo@01:00-01:00\".\n\nUsually, the first timestamp is the baseline date, the last timestamp is the current date.\nValues older than 1 day are accepted only with valid Enterprise Token available."
              }
            ]
          },
          "docs": "Returns a collection of work packages."
        },
        {
          "info": {
            "name": "Create Work Package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages",
            "params": [
              {
                "name": "notify",
                "value": "false",
                "type": "query",
                "description": "Indicates whether change notifications (e.g. via E-Mail) should be sent.\nNote that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),\nnot just the current user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.\nThe required fields of a WorkPackage can be found in its schema, which is embedded in the respective form.\nNote that it is only allowed to provide properties or links supporting the write operation.\n\nA project link must be set when creating work packages through this route.\n\nWhen setting start date, finish date, and duration together, their correctness will"
        },
        {
          "info": {
            "name": "Form for creating a Work Package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/form",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint, the client provides a single object containing the properties and links to be\ncreated, in the body. The input is validated and a schema response is returned. If the validation errors of the\nresponse is empty, the same payload can be used to create a work package.\n\nOnly the properties of the work package write model are allowed to set on a work package on creation.\n\nWhen setting start date, finish date, and duration together, their correctness will be checked and a val"
        },
        {
          "info": {
            "name": "List Work Package Schemas",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/schemas",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"id\": { \"operator\": \"=\", \"values\": [\"12-1\", \"14-2\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ id: The schema's id\n\nSchema id has the form `project_id-work_package_type_id`."
              }
            ]
          },
          "docs": "List all work package schemas that match the given filters. This endpoint does not return a successful response,\nif no filter is given."
        },
        {
          "info": {
            "name": "View Work Package Schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/schemas/:identifier",
            "params": [
              {
                "name": "identifier",
                "value": "12-13",
                "type": "path",
                "description": "Identifier of the schema"
              }
            ]
          },
          "docs": "View Work Package Schema"
        },
        {
          "info": {
            "name": "View Work Package",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              },
              {
                "name": "timestamps",
                "value": "2022-01-01T00:00:00Z,PT0S",
                "type": "query",
                "description": "In order to perform a [baseline comparison](/docs/api/baseline-comparisons) of the work-package attributes, you may\nprovide one or several timestamps in ISO-8601 format as comma-separated list. The timestamps may be absolute or relative,\nsuch as ISO8601 dates, ISO8601 durations and the following relative date keywords: \"oneDayAgo@HH:MM+HH:MM\",\n\"lastWorkingDay@HH:MM+HH:MM\", \"oneWeekAgo@HH:MM+HH:MM\", \"oneMonthAgo@HH:MM+HH:MM\".\nThe first \"HH:MM\" part represents the zero paded hours and minutes.\nThe last \"+HH:MM\" part represents the timezone offset from UTC associated with the time,\nthe offset can be positive or negative e.g.\"oneDayAgo@01:00+01:00\", \"oneDayAgo@01:00-01:00\".\n\nUsually, the first timestamp is the baseline date, the last timestamp is the current date.\nValues older than 1 day are accepted only with valid Enterprise Token available."
              }
            ]
          },
          "docs": "Returns the specified work package."
        },
        {
          "info": {
            "name": "Update a Work Package",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "Work package id"
              },
              {
                "name": "notify",
                "value": "false",
                "type": "query",
                "description": "Indicates whether change notifications should be sent. Note that this controls notifications for all users\ninterested in changes to the work package (e.g. watchers, author and assignee), not just the current user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing the properties and links that it wants\nto change, in the body. Note that it is only allowed to provide properties or links supporting the **write**\noperation.\n\nAdditionally to the fields the client wants to change, it is mandatory to provide the value of `lockVersion` which\nwas received by the `GET` request this change originates from.\n\nThe value of `lockVersion` is used to implement\n[optimistic locking](https://en.wikipe"
        },
        {
          "info": {
            "name": "Delete Work Package",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ]
          },
          "docs": "Deletes the work package, as well as:\n\n- all associated time entries\n- its hierarchy of child work packages"
        },
        {
          "info": {
            "name": "List work package activities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/activities",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ]
          },
          "docs": "List work package activities"
        },
        {
          "info": {
            "name": "Comment work package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/activities",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              },
              {
                "name": "notify",
                "value": "false",
                "type": "query",
                "description": "Indicates whether change notifications (e.g. via E-Mail) should be sent.\nNote that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),\nnot just the current user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an activity for the selected work package and, on success, returns the\nupdated activity."
        },
        {
          "info": {
            "name": "Work Package Available assignees",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/available_assignees",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ]
          },
          "docs": "Gets a list of users that can be assigned to the given work package."
        },
        {
          "info": {
            "name": "Available projects for work package",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/available_projects",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "work package id"
              }
            ]
          },
          "docs": "Gets a list of projects that are available as projects to which the work package can be moved."
        },
        {
          "info": {
            "name": "Available relation candidates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/available_relation_candidates",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Maximum number of candidates to list (default 10)"
              },
              {
                "name": "filters",
                "value": "[{ \"status_id\": { \"operator\": \"o\", \"values\": null } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same filters as the [work packages](https://www.openproject.org/docs/api/endpoints/work-packages/) endpoint."
              },
              {
                "name": "query",
                "value": "\"rollout\"",
                "type": "query",
                "description": "Shortcut for filtering by ID or subject"
              },
              {
                "name": "type",
                "value": "\"follows\"",
                "type": "query",
                "description": "Type of relation to find candidates for (default \"relates\")"
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same sort criteria as the [work packages](https://www.openproject.org/docs/api/endpoints/work-packages/) endpoint."
              }
            ]
          },
          "docs": "Available relation candidates"
        },
        {
          "info": {
            "name": "Available watchers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/available_watchers",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "work package id"
              }
            ]
          },
          "docs": "Gets a list of users that are able to be watchers of the specified work package."
        },
        {
          "info": {
            "name": "Gets all file links of a work package",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/file_links",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Work package id"
              },
              {
                "name": "filters",
                "value": "[{\"storage\":{\"operator\":\"=\",\"values\":[\"42\"]}}]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. The following filters are supported:\n\n- storage"
              }
            ]
          },
          "docs": "Gets all file links of a work package.\n\nAs a side effect, for every file link a request is sent to the storage's origin to fetch live data and patch\nthe file link's data before returning, as well as retrieving permissions of the user on this origin file. "
        },
        {
          "info": {
            "name": "Creates file links.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/file_links",
            "params": [
              {
                "name": "id",
                "value": "1337",
                "type": "path",
                "description": "Work package id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates file links on a work package.\n\nThe request is interpreted as a bulk insert, where every element of the collection is validated separately. Each\nelement contains the origin meta data and a link to the storage, the file link is about to point to. The storage\nlink can be provided as a resource link with id or as the host url.\n\nThe file's id and name are considered mandatory information. The rest of the origin meta data SHOULD be provided\nby the client. The _mimeType_ SHOULD be a standard mi"
        },
        {
          "info": {
            "name": "Form for editing a Work Package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the work package being modified"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint, the client provides a single object containing the properties and links to be\nedited, in the body. The input is validated and a schema response is returned. If the validation errors of the\nresponse is empty, the same payload can be used to edit the work package.\n\nOnly the properties of the work package write model are allowed to set on a work package on editing.\n\nWhen setting start date, finish date, and duration together, their correctness will be checked and a valid"
        },
        {
          "info": {
            "name": "Revisions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/revisions",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ]
          },
          "docs": "Gets a list of revisions that are linked to this work package, e.g., because it is referenced in the commit message of the revision.\nOnly linked revisions from repositories are shown if the user has the view changesets permission in the defining project."
        },
        {
          "info": {
            "name": "List work package reminders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:work_package_id/reminders",
            "params": [
              {
                "name": "work_package_id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ]
          },
          "docs": "Gets a list of your upcoming reminders for this work package.\n\nOnly active reminders that belong to the current user are returned."
        },
        {
          "info": {
            "name": "Create a work package reminder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:work_package_id/reminders",
            "params": [
              {
                "name": "work_package_id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new reminder for the specified work package.\n\n**Note:** A user can only have one **active** reminder at a time for a given work package."
        },
        {
          "info": {
            "name": "List watchers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/watchers",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ]
          },
          "docs": "List watchers"
        },
        {
          "info": {
            "name": "Add watcher",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/watchers",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a watcher to the specified work package.\n\nThe request is expected to contain a single JSON object, that contains a link object under the `user` key.\n\nThe response will be user added as watcher.\nIn case the user was already watching the work package an `HTTP 200` is returned, an\n`HTTP 201` if the user was added as a new watcher."
        },
        {
          "info": {
            "name": "Remove watcher",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/watchers/:user_id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              },
              {
                "name": "user_id",
                "value": "1",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Removes the specified user from the list of watchers for the given work package.\n\nIf the request succeeds, the specified user is not watching the work package anymore.\n\n*Note: This might also be the case, if the specified user did not watch the work package prior to the request.*"
        },
        {
          "info": {
            "name": "Workspace Available assignees",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/available_assignees",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Workspace id"
              }
            ]
          },
          "docs": "Gets a list of users that can be assigned to work packages in the given workspace."
        },
        {
          "info": {
            "name": "Get work packages of workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/work_packages",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Workspace id"
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "filters",
                "value": "[{ \"type_id\": { \"operator\": \"=\", \"values\": ['1', '2'] }}]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. If no filter is to be applied, the client should send an empty array (`[]`)."
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint."
              },
              {
                "name": "groupBy",
                "value": "status",
                "type": "query",
                "description": "The column to group by."
              },
              {
                "name": "showSums",
                "value": "true",
                "type": "query",
                "description": "Indicates whether properties should be summed up if they support it."
              },
              {
                "name": "select",
                "value": "total,elements/subject,elements/id,self",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Returns the collection of work packages that are related to the given workspace."
        },
        {
          "info": {
            "name": "Create work package in workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/work_packages",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              },
              {
                "name": "notify",
                "value": "false",
                "type": "query",
                "description": "Indicates whether change notifications (e.g. via E-Mail) should be sent.\nNote that this controls notifications for all users interested in changes to the work package (e.g. watchers, author and assignee),\nnot just the current user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing at least the properties and links that\nare required, in the body. The required fields of a WorkPackage can be found in its schema, which is embedded in\nthe respective form. Note that it is only allowed to provide properties or links supporting the write operation."
        },
        {
          "info": {
            "name": "Form for creating Work Packages in a Workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/work_packages/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the workspace in which the work package will be created"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to validation a new work package creation body in a specific workspace. It works similarly\nto the `/api/v3/work_packages/form` endpoint, but already specifies the work package's workspace in the path, so that\nit does not have to be defined in the request body."
        }
      ]
    },
    {
      "info": {
        "name": "Sprints",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List sprints in project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/sprints",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the project whose sprints will be listed"
              },
              {
                "name": "filters",
                "value": "[{ \"definingWorkspace\": { \"operator\": \"=\", \"values\": [\"1\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\n\nAccepts the same format and filters as returned by the [sprints](https://www.openproject.org/docs/api/endpoints/sprints/) endpoint."
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              }
            ]
          },
          "docs": "List sprints in the project. The sprints might be ones native to the project or shared with it. This endpoint supports pagination and filtering."
        },
        {
          "info": {
            "name": "List sprints",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/sprints",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"definingWorkspace\": { \"operator\": \"=\", \"values\": [\"1\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n+ definingWorkspace: filters sprints based on the project they are defined in. This is opposed to the projects they are shared with."
              },
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              }
            ]
          },
          "docs": "List sprints visible to the user. This endpoint supports pagination and filtering."
        },
        {
          "info": {
            "name": "Get sprint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/sprints/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Sprint id"
              }
            ]
          },
          "docs": "Retrieves a sprint defined by its unique identifier."
        }
      ]
    },
    {
      "info": {
        "name": "Types",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List types available in a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/types",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the project whose types will be listed"
              }
            ]
          },
          "docs": "This endpoint lists the types that are *available* in a given project.\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/types`](https://www.openproject.org/docs/api/endpoints/types/#list-types-available-in-a-workspace)"
        },
        {
          "info": {
            "name": "List all Types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/types"
          },
          "docs": "List all Types"
        },
        {
          "info": {
            "name": "View Type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/types/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Type id"
              }
            ]
          },
          "docs": "View Type"
        },
        {
          "info": {
            "name": "List types available in a workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/types",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the workspace whose types will be listed"
              }
            ]
          },
          "docs": "This endpoint lists the types that are *available* in a given workspace."
        }
      ]
    },
    {
      "info": {
        "name": "Versions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List versions available in a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/projects/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the project whose versions will be listed"
              }
            ]
          },
          "docs": "This endpoint lists the versions that are *available* in a given project.\nNote that due to sharing this might be more than the versions *defined* by that project.\n\nThis endpoint is deprecated and replaced by [`/api/v3/workspaces/{id}/versions`](https://www.openproject.org/docs/api/endpoints/versions/#list-versions-available-in-a-workspace)"
        },
        {
          "info": {
            "name": "List versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/versions",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"sharing\": { \"operator\": \"=\", \"values\": [\"system\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions. Accepts the same format as returned by\nthe [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported\nfilters are:\n\n- sharing: filters versions by how they are shared within the server (*none*, *descendants*, *hierarchy*, *tree*, *system*).\n- name: filters versions by their name."
              },
              {
                "name": "sortBy",
                "value": "[[\"name\", \"desc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria. Accepts the same format as returned by\nthe [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported\nattributes are:\n\n- id: Sort by the version id\n- name: Sort by the version name using numeric collation, comparing sequences of decimal digits by their numeric value"
              }
            ]
          },
          "docs": "Returns a collection of versions. The client can choose to filter the versions similar to how work packages are\nfiltered. In addition to the provided filters, the server will reduce the result set to only contain versions,\nfor which the requesting client has sufficient permissions (*view_work_packages*)."
        },
        {
          "info": {
            "name": "Create version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/versions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new version applying the attributes provided in the body. Please note that while there is a fixed set\nof attributes, custom fields can extend a version's attributes and are accepted by the endpoint.\n\nYou can use the form and schema to be retrieve the valid attribute values and by that be guided towards\nsuccessful creation."
        },
        {
          "info": {
            "name": "Available projects for versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/versions/available_projects"
          },
          "docs": "Gets a list of projects in which a version can be created in. The list contains all projects in which the user issuing the request has the manage versions permissions."
        },
        {
          "info": {
            "name": "Version create form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/versions/form"
          },
          "docs": "Version create form"
        },
        {
          "info": {
            "name": "View version schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/versions/schema"
          },
          "docs": "View version schema"
        },
        {
          "info": {
            "name": "Get version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/versions/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Version id"
              }
            ]
          },
          "docs": "Retrieves a version defined by its unique identifier."
        },
        {
          "info": {
            "name": "Update Version",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/versions/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Version id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given version by applying the attributes provided in the body. Please note that while there is a fixed\nset of attributes, custom fields can extend a version's attributes and are accepted by the endpoint."
        },
        {
          "info": {
            "name": "Delete version",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/versions/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Version id"
              }
            ]
          },
          "docs": "Deletes the version. Entities associated to the version will no longer be assigned to it."
        },
        {
          "info": {
            "name": "Version update form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/versions/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Project id"
              }
            ]
          },
          "docs": "Version update form"
        },
        {
          "info": {
            "name": "List versions available in a workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the workspace whose versions will be listed"
              }
            ]
          },
          "docs": "This endpoint lists the versions that are *available* in a given workspace.\nNote that due to sharing this might be more than the versions *defined* by that workspace."
        }
      ]
    },
    {
      "info": {
        "name": "Query Columns",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Query Column",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/columns/:id",
            "params": [
              {
                "name": "id",
                "value": "priority",
                "type": "path",
                "description": "QueryColumn id"
              }
            ]
          },
          "docs": "Retrieve an individual QueryColumn as identified by the `id` parameter."
        }
      ]
    },
    {
      "info": {
        "name": "Query Filters",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Query Filter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/filters/:id",
            "params": [
              {
                "name": "id",
                "value": "status",
                "type": "path",
                "description": "QueryFilter identifier"
              }
            ]
          },
          "docs": "Retrieve an individual QueryFilter as identified by the id parameter."
        }
      ]
    },
    {
      "info": {
        "name": "Query Operators",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Query Operator",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/operators/:id",
            "params": [
              {
                "name": "id",
                "value": "!",
                "type": "path",
                "description": "QueryOperator id"
              }
            ]
          },
          "docs": "Retrieve an individual QueryOperator as identified by the `id` parameter."
        }
      ]
    },
    {
      "info": {
        "name": "Query Sort Bys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Query Sort By",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/queries/sort_bys/:id",
            "params": [
              {
                "name": "id",
                "value": "status-asc",
                "type": "path",
                "description": "QuerySortBy identifier. The identifier is a combination of the column identifier and the direction."
              }
            ]
          },
          "docs": "Retrieve an individual QuerySortBy as identified by the id parameter."
        }
      ]
    },
    {
      "info": {
        "name": "Relations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Relations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/relations",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"from\": { \"operator\": \"=\", \"values\": 42 }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions. Accepts the same format as returned by\nthe [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Valid fields to filter by are:\n\n- id - ID of relation\n- from - ID of work package from which the filtered relations emanates.\n- to - ID of work package to which this related points.\n- involved - ID of either the `from` or the `to` work package.\n- type - The type of relation to filter by, e.g. \"follows\"."
              },
              {
                "name": "sortBy",
                "value": "[[\"type\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint."
              }
            ]
          },
          "docs": "Lists all relations according to the given (optional, logically conjunctive) filters and ordered by ID.\nThe response only includes relations between work packages which the user is allowed to see."
        },
        {
          "info": {
            "name": "Get Relation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/relations/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Relation id"
              }
            ]
          },
          "docs": "Get a single relation specified by its unique identifier."
        },
        {
          "info": {
            "name": "Update Relation",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/relations/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Relation ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing the properties and links that it wants\nto change, in the body. It is only allowed to provide properties or links supporting the **write** operation.\n\nNote that changing the `type` of a relation invariably also changes the respective `reverseType` as well as the\n\"name\" of it. The returned Relation object will reflect that change. For instance if you change a Relation's\n`type` to \"follows\" then the `reverseType` will be cha"
        },
        {
          "info": {
            "name": "Delete Relation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/relations/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "The unique identifier of the relation resource"
              }
            ]
          },
          "docs": "Deletes the relation."
        },
        {
          "info": {
            "name": "Create relation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/relations",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Work package id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a work package relation on the given work package. A successful creation will result in a relation between\ntwo work packages, thus appearing on both involved work package resources."
        }
      ]
    },
    {
      "info": {
        "name": "Previewing",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Preview Markdown document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/render/markdown",
            "params": [
              {
                "name": "context",
                "value": "/api/v3/work_packages/42",
                "type": "query",
                "description": "API-Link to the context in which the rendering occurs, for example a specific work package.\n\nIf left out only context-agnostic rendering takes place.\nPlease note that OpenProject features markdown-extensions on top of the extensions GitHub Flavored Markdown (gfm) already\nprovides that can only work given a context (e.g. display attached images).\n\n**Supported contexts:**\n\n* `/api/v3/work_packages/{id}` - an existing work package"
              }
            ]
          },
          "docs": "Preview Markdown document"
        },
        {
          "info": {
            "name": "Preview plain document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/render/plain"
          },
          "docs": "Preview plain document"
        }
      ]
    },
    {
      "info": {
        "name": "Revisions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View revision",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/revisions/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Revision id"
              }
            ]
          },
          "docs": "View revision"
        }
      ]
    },
    {
      "info": {
        "name": "Reminders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all active reminders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/reminders"
          },
          "docs": "Gets a list of all active reminders for the user."
        },
        {
          "info": {
            "name": "Update a reminder",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/reminders/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Reminder ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing reminder.\n\nA user can only update their own active reminder.\n\n**Required permission:** view work packages for the project the reminder is contained in."
        },
        {
          "info": {
            "name": "Delete a reminder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/reminders/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Reminder ID"
              }
            ]
          },
          "docs": "Deletes an existing reminder.\n\nA user can only delete their own active reminder.\n\n**Required permission:** view work packages for the project the reminder is contained in."
        }
      ]
    },
    {
      "info": {
        "name": "Roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/roles",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"unit\": { \"operator\": \"=\", \"values\": [\"system\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n+ grantable: filters roles based on whether they are selectable for a membership\n\n+ unit: filters roles based on the unit ('project' or 'system') for which they are selectable for a membership"
              }
            ]
          },
          "docs": "List all defined roles. This includes built in roles like 'Anonymous' and 'Non member'."
        },
        {
          "info": {
            "name": "View role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/roles/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Role id"
              }
            ]
          },
          "docs": "Fetch an individual role."
        }
      ]
    },
    {
      "info": {
        "name": "Statuses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List the collection of all statuses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/statuses"
          },
          "docs": "Returns a collection of all work package statuses."
        },
        {
          "info": {
            "name": "Get a work package status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/statuses/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Status id"
              }
            ]
          },
          "docs": "Returns a work package status by its unique identifier."
        }
      ]
    },
    {
      "info": {
        "name": "Time entries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List time entries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries",
            "params": [
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "sortBy",
                "value": "[[\"spent_on\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:\n\n+ id: Sort by primary key\n\n+ hours: Sort by logged hours\n\n+ spent_on: Sort by spent on date\n\n+ created_at: Sort by time entry creation datetime\n\n+ updated_at: Sort by the time the time entry was updated last"
              },
              {
                "name": "filters",
                "value": "[{ \"entity_type\": { \"operator\": \"=\", \"values\": [\"WorkPackage\"] }}, { \"entity_id\": { \"operator\": \"=\", \"values\": [\"1\", \"2\"] } }, { \"project\": { \"operator\": \"=\", \"values\": [\"1\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are:\n\n+ entity_type: Filter time entries depending on the entity they are logged on. Can either be `WorkPackage` or `Meeting`.\n\n+ entity_id: Filter time entries for the specified entity IDs.\n\n+ project_id: Filter time entries by project\n\n+ user_id: Filter time entries by users\n\n+ ongoing: Filter to only recevie ongoing timers\n\n+ spent_on: Filter time entries by spent on date\n\n+ created_at: Filter time entries by creation datetime\n\n+ updated_at: Filter time entries by the last time they where updated\n\n+ activity_id: Filter time entries by time entry activity"
              }
            ]
          },
          "docs": "Lists time entries. The time entries returned depend on the filters\nprovided and also on the permission of the requesting user."
        },
        {
          "info": {
            "name": "Create time entry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new time entry applying the attributes provided in the body.\nPlease note that while there is a fixed set of attributes, custom fields can extend\na time entries' attributes and are accepted by the endpoint."
        },
        {
          "info": {
            "name": "Get time entry",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "time entry id"
              }
            ]
          },
          "docs": "Retrieves a single time entry identified by the given id."
        },
        {
          "info": {
            "name": "Delete time entry",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Time entry id"
              }
            ]
          },
          "docs": "Permanently deletes the specified time entry."
        }
      ]
    },
    {
      "info": {
        "name": "Time Entries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Time entry update form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Time entries activity id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Time entry update form"
        },
        {
          "info": {
            "name": "Available projects for time entries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/available_projects"
          },
          "docs": "Gets a list of projects in which a time entry can be created in or be assigned to on update. The list contains all projects in which the user issuing the request has the necessary permissions."
        },
        {
          "info": {
            "name": "Time entry create form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/form"
          },
          "docs": "Time entry create form"
        },
        {
          "info": {
            "name": "View time entry schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/schema"
          },
          "docs": "View time entry schema"
        },
        {
          "info": {
            "name": "update time entry",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Time entry id"
              }
            ]
          },
          "docs": "Updates the given time entry by applying the attributes provided in\nthe body. Please note that while there is a fixed set of attributes, custom fields\ncan extend a time entries' attributes and are accepted by the endpoint."
        }
      ]
    },
    {
      "info": {
        "name": "Time entry activities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View time entries activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/time_entries/activity/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Time entries activity id"
              }
            ]
          },
          "docs": "Fetches the time entry activity resource by the given id."
        }
      ]
    },
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/users",
            "params": [
              {
                "name": "offset",
                "value": "25",
                "type": "query",
                "description": "Page number inside the requested collection."
              },
              {
                "name": "pageSize",
                "value": "25",
                "type": "query",
                "description": "Number of elements to display per page."
              },
              {
                "name": "filters",
                "value": "[{ \"status\": { \"operator\": \"=\", \"values\": [\"invited\"] } }, { \"group\": { \"operator\": \"=\", \"values\": [\"1\"] } }, { \"name\": { \"operator\": \"=\", \"values\": [\"h.wurst@openproject.com\"] } }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ status: Status the user has\n\n+ group: Name of the group in which to-be-listed users are members.\n\n+ name: Filter users in whose first or last names, or email addresses the given string occurs.\n\n+ login: User's login"
              },
              {
                "name": "sortBy",
                "value": "[[\"status\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint."
              },
              {
                "name": "select",
                "value": "total,elements/name,elements/self,self",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Lists users. Only administrators or users with the following global permission can access this resource:\n- `manage_user`"
        },
        {
          "info": {
            "name": "Create User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new user. Only administrators and users with manage_user global permission are allowed to do so.\nWhen calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.\n\nValid values for `status`:\n\n1) \"active\" - In this case a password has to be provided in addition to the other attributes.\n\n2) \"invited\" - In this case nothing but the email address is required. The rest is optional. An invitation will be sent to the u"
        },
        {
          "info": {
            "name": "View user schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/users/schema"
          },
          "docs": "The schema response use two exemplary custom fields that extend the schema response. Depending on your instance and custom field configuration, the response will look somewhat different."
        },
        {
          "info": {
            "name": "View user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "User id. Use `me` to reference current user, if any."
              }
            ]
          },
          "docs": "View user"
        },
        {
          "info": {
            "name": "Update user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "User id. Use `me` to reference current user, if any."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the user's writable attributes.\nWhen calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.\n\nPassword updates for self-service account changes require both `password` and `currentPassword`."
        },
        {
          "info": {
            "name": "Delete user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "User id. Use `me` to reference current user, if any."
              }
            ]
          },
          "docs": "Permanently deletes the specified user account."
        },
        {
          "info": {
            "name": "User update form",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/form",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "User id. Use `me` to reference current user, if any."
              }
            ]
          },
          "docs": "Validates a user update payload.\n\nFor self password changes, provide both `password` and `currentPassword`."
        },
        {
          "info": {
            "name": "Lock user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/lock",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Lock user"
        },
        {
          "info": {
            "name": "Unlock user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/lock",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Unlock user"
        }
      ]
    },
    {
      "info": {
        "name": "User Working Times",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List personal non-working times for a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/non_working_times",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id. Use `me` to reference the current user."
              },
              {
                "name": "year",
                "value": "2025",
                "type": "query",
                "description": "Filter results to the given year. Defaults to the current year if not provided."
              }
            ]
          },
          "docs": "Returns all personal non-working times for the given user, ordered by start date ascending.\n\nPersonal non-working times mark date ranges as non-working for a user\n(e.g., a local holiday or personal day off not covered by the system-wide non-working days).\n\n**Required permissions:**\n- Administrators can view non-working days for any user.\n- Users with the global `manage_own_working_times` permission can view their own records.\n- Users with the global `manage_working_times` permission can view non"
        },
        {
          "info": {
            "name": "Create a personal non-working day for a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/non_working_times",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id. Use `me` to reference the current user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a personal non-working time range for the given user.\n\nThe date range must not overlap with an existing non-working time record for the same user.\n\n**Required permissions:**\n- Administrators can create non-working days for any user.\n- Users with the global `manage_own_working_times` permission can create records for themselves.\n- Users with the global `manage_working_times` permission can create non-working days for any user.\n\nUse `me` as the `id` to reference the current user."
        },
        {
          "info": {
            "name": "View a personal non-working time record",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/non_working_times/:non_working_time_id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id. Use `me` to reference the current user."
              },
              {
                "name": "non_working_time_id",
                "value": "7",
                "type": "path",
                "description": "The id of the personal non-working time record."
              }
            ]
          },
          "docs": "Returns a single personal non-working time record for the given user.\n\n**Required permissions:**\n- Administrators can view non-working time records for any user.\n- Users with the global `manage_own_working_times` permission can view their own records.\n- Users with the global `manage_working_times` permission can view non-working time records for any user.\n\nUse `me` as the `id` to reference the current user."
        },
        {
          "info": {
            "name": "Update a personal non-working time record",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/non_working_times/:non_working_time_id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id. Use `me` to reference the current user."
              },
              {
                "name": "non_working_time_id",
                "value": "7",
                "type": "path",
                "description": "The id of the personal non-working time record."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given personal non-working time record.\n\n**Required permissions:**\n- Administrators can update non-working time records for any user.\n- Users with the global `manage_own_working_times` permission can update their own records.\n- Users with the global `manage_working_times` permission can update non-working time records for any user.\n\nUse `me` as the `id` to reference the current user."
        },
        {
          "info": {
            "name": "Delete a personal non-working time record",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/non_working_times/:non_working_time_id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id. Use `me` to reference the current user."
              },
              {
                "name": "non_working_time_id",
                "value": "7",
                "type": "path",
                "description": "The id of the personal non-working time record."
              }
            ]
          },
          "docs": "Removes the personal non-working time record for the given user.\n\n**Required permissions:**\n- Administrators can delete non-working time records for any user.\n- Users with the global `manage_own_working_times` permission can delete their own records.\n- Users with the global `manage_working_times` permission can delete non-working time records for any user.\n\nUse `me` as the `id` to reference the current user."
        },
        {
          "info": {
            "name": "List working hours for a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/working_hours",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id. Use `me` to reference the current user."
              }
            ]
          },
          "docs": "Returns all working hours records for the given user, ordered by `validFrom` descending.\n\nMultiple records may exist for a user; each represents a period of their working time\nconfiguration. The most recently effective record (the one with the latest `validFrom`\nthat is not in the future) is used for capacity calculations.\n\n**Required permissions:**\n- Administrators can view working hours for any user.\n- Users with the global `manage_working_times` permission can view working hours for any user."
        },
        {
          "info": {
            "name": "Create a working hours record for a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/working_hours",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id. Use `me` to reference the current user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new working hours record for the given user, effective from the given date.\n\n**Required permissions:**\n- Administrators can create working hours records for any user.\n- Users with the global `manage_own_working_times` permission can create records for themselves.\n- Users with the global `manage_working_times` permission can create working hours records for any user.\n\nUse `me` as the `id` to reference the current user."
        },
        {
          "info": {
            "name": "View a working hours record",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/working_hours/:working_hours_id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id."
              },
              {
                "name": "working_hours_id",
                "value": "1",
                "type": "path",
                "description": "Working hours record id."
              }
            ]
          },
          "docs": "Returns a single working hours record for the given user.\n\n**Required permissions:**\n- Administrators can view working hours records for any user.\n- Users with the global `manage_working_times` permission can view working hours for any user.\n- Any user can view their own working hours records."
        },
        {
          "info": {
            "name": "Update a working hours record",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/working_hours/:working_hours_id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id."
              },
              {
                "name": "working_hours_id",
                "value": "2",
                "type": "path",
                "description": "Working hours record id."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the given working hours record.\n\nOnly records that have not yet taken effect (i.e., `validFrom` is in the future) can be\nupdated. Attempting to update a record that is already in effect will return a `422` error.\n\n**Required permissions:**\n- Administrators can update working hours records for any user.\n- Users with the global `manage_own_working_times` permission can update their own records.\n- Users with the global `manage_working_times` permission can update working hours for any user."
        },
        {
          "info": {
            "name": "Delete a working hours record",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/users/:id/working_hours/:working_hours_id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "User id."
              },
              {
                "name": "working_hours_id",
                "value": "2",
                "type": "path",
                "description": "Working hours record id."
              }
            ]
          },
          "docs": "Deletes the given working hours record.\n\n**Required permissions:**\n- Administrators can delete working hours records for any user.\n- Users with the global `manage_own_working_times` permission can delete their own records.\n- Users with the global `manage_working_times` permission can delete working hours records for any user."
        }
      ]
    },
    {
      "info": {
        "name": "Values::Property",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Values schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/values/schema/:id",
            "params": [
              {
                "name": "id",
                "value": "startDate",
                "type": "path",
                "description": "The identifier of the value. This is typically the value of the `property` property of\nthe `Values` resource. It should be in lower camelcase format."
              }
            ]
          },
          "docs": "The schema of a `Values` resource."
        }
      ]
    },
    {
      "info": {
        "name": "Views",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List views",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/views",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"project_id\": { \"operator\": \"!*\", \"values\": null }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nCurrently supported filters are:\n\n+ project: filters views by the project their associated query is assigned to. If the project filter is passed with the `!*` (not any) operator, global views are returned.\n\n+ id: filters views based on their id\n\n+ type: filters views based on their type"
              }
            ]
          },
          "docs": "Returns a collection of Views. The collection can be filtered via query parameters similar to how work packages are filtered."
        },
        {
          "info": {
            "name": "View view",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/views/:id",
            "params": [
              {
                "name": "id",
                "value": "42",
                "type": "path",
                "description": "View id"
              }
            ]
          },
          "docs": "View view"
        },
        {
          "info": {
            "name": "Create view",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/views/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "The view identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.\nThe required fields of a View can be found in its schema, which is embedded in the respective form.\nNote that it is only allowed to provide properties or links supporting the write operation.\n\nThere are different subtypes of `Views` (e.g. `Views::WorkPackagesTable`) with each having its own\nendpoint for creating that subtype e.g.\n\n* `/api/v3/views/work_pack"
        }
      ]
    },
    {
      "info": {
        "name": "Wiki Pages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View Wiki Page",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/wiki_pages/:id",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Wiki page identifier"
              }
            ]
          },
          "docs": "Retrieve an individual wiki page as identified by the id parameter"
        }
      ]
    },
    {
      "info": {
        "name": "WorkPackages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List emoji reactions by work package activities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/work_packages/:id/activities_emoji_reactions",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "ID of the work package whose activities' emoji reactions will be listed"
              }
            ]
          },
          "docs": "List all emoji reactions of all activities of a single work package."
        }
      ]
    },
    {
      "info": {
        "name": "Workspace",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces",
            "params": [
              {
                "name": "filters",
                "value": "[{ \"ancestor\": { \"operator\": \"=\", \"values\": [\"1\"] }\" }]",
                "type": "query",
                "description": "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.\nCurrently supported filters are:\n\n+ active: based on the active property of the workspace\n+ ancestor: filters workspace by their ancestor. A workspace is not considered to be its own ancestor.\n+ available_project_attributes: filters workspace based on the activated project attributes.\n+ created_at: based on the time the workspace was created\n+ favorited: based on the favorited property of the workspace\n+ id: based on workspace' id.\n+ latest_activity_at: based on the time the last activity was registered on a workspace.\n+ name_and_identifier: based on both the name and the identifier.\n+ parent_id: filters workspace by their parent.\n+ principal: based on members of the workspace.\n+ project_phase_any: based on the project phases active in a workspace.\n+ project_status_code: based on status code of the workspace\n+ storage_id: filters workspace by linked storages\n+ storage_url: filters workspace by linked storages identified by the host url\n+ type_id: based on the types active in a workspace.\n+ user_action: based on the actions the current user has in the workspace.\n+ visible: based on the visibility for the user (id) provided as the filter value. This filter is useful for admins to identify the workspace visible to a user.\n\nThere might also be additional filters based on the custom fields that have been configured.\n\nEach defined lifecycle step will also define a filter in this list endpoint. Given that the elements are not\nstatic but rather dynamically created on each OpenProject instance, a list cannot be provided. Those filters follow the schema:\n+ project_start_gate_[id]: a filter on a project phase's start gate active in a workspace. The id is the id of the phase the gate belongs to.\n+ project_finish_gate_[id]: a filter on a project phase's finish gate active in a workspace. The id is the id of the phase the gate belongs to.\n+ project_phase_[id]: a filter on a project phase active in a workspace. The id is the id of the phase queried for."
              },
              {
                "name": "sortBy",
                "value": "[[\"id\", \"asc\"]]",
                "type": "query",
                "description": "JSON specifying sort criteria.\nCurrently supported orders are:\n\n+ id\n+ name\n+ typeahead (sorting by hierarchy and name)\n+ created_at\n+ public\n+ latest_activity_at\n+ required_disk_space\n\nThere might also be additional orders based on the custom fields that have been configured."
              },
              {
                "name": "select",
                "value": "total,elements/identifier,elements/name",
                "type": "query",
                "description": "Comma separated list of properties to include."
              }
            ]
          },
          "docs": "Returns a collection of workspaces. The collection can be filtered via query parameters similar to how work packages are filtered. In addition to the provided filter, the result set is always limited to only contain workspaces the client is allowed to see.\nSince workspaces are the generic term for a number of resources like projects and portfolios, the returned collection will contain a mix of those resources."
        }
      ]
    },
    {
      "info": {
        "name": "Workspaces",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Favorite Workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/favorite",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Workspace id"
              }
            ]
          },
          "docs": "Adds the workspace to the current user's favorites."
        },
        {
          "info": {
            "name": "Unfavorite Workspace",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/:id/favorite",
            "params": [
              {
                "name": "id",
                "value": "1",
                "type": "path",
                "description": "Workspace id"
              }
            ]
          },
          "docs": "Removes the workspace from the current user's favorites."
        },
        {
          "info": {
            "name": "View workspace schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://qa.openproject-edge.com/api/v3/workspaces/schema"
          },
          "docs": "View workspace schema"
        }
      ]
    }
  ],
  "bundled": true
}