{ "opencollection": "1.0.0", "info": { "name": "OpenProject API V3 (Stable) Actions & Capabilities Work Schedule API", "version": "3" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "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." } ] } ], "bundled": true }