From a78cd7ca013f220abf0b050d997e468a3ac8295c Mon Sep 17 00:00:00 2001 From: "rafael.barrelo" Date: Thu, 26 Feb 2026 17:35:07 +0000 Subject: [PATCH 1/3] Add closetaskparameters type and close task operation to API documentation Add new operation for closing tasks to changelog --- connector-api/_generator/types.yaml | 3 +++ connector-api/changelog/README.md | 8 ++++++++ connector-api/operations/services.md | 1 - connector-api/operations/tasks.md | 28 ++++++++++++++++++++++++++++ 4 files changed, 39 insertions(+), 1 deletion(-) diff --git a/connector-api/_generator/types.yaml b/connector-api/_generator/types.yaml index 525e693e..4975bde7 100644 --- a/connector-api/_generator/types.yaml +++ b/connector-api/_generator/types.yaml @@ -2616,3 +2616,6 @@ types: paymentmethodrequestemailtypesenum: file: paymentmethodrequests.md anchor: supported-email-types + closetaskparameters: + file: tasks.md + anchor: closetaskparameters diff --git a/connector-api/changelog/README.md b/connector-api/changelog/README.md index 5d3a8a67..d35aec0f 100644 --- a/connector-api/changelog/README.md +++ b/connector-api/changelog/README.md @@ -1,6 +1,14 @@ # Changelog {% updates format="full" %} +{% update date="2026-02-27" %} + +## New operation: Close tasks + +- [Close tasks](../operations/tasks.md#close-task): + - New operation to close tasks. + +{% endupdate %} {% update date="2026-02-25" %} ## 25th February 2026 diff --git a/connector-api/operations/services.md b/connector-api/operations/services.md index 89906b8d..e49e3be9 100644 --- a/connector-api/operations/services.md +++ b/connector-api/operations/services.md @@ -241,7 +241,6 @@ Returns selected availability and occupancy metrics of a bookable service for a * `AllocatedBlockAvailability` - Number of blocked resources that are in a deducting state (from an availability block / allotment). * `UsableResources` - Number of usable resources (i.e. which are not out of order). * `ActiveResources` - Number of active resources. -* `HouseUse` - Number of resources marked as house use (internal use). ### Response diff --git a/connector-api/operations/tasks.md b/connector-api/operations/tasks.md index b60c700d..8e5a51ec 100644 --- a/connector-api/operations/tasks.md +++ b/connector-api/operations/tasks.md @@ -135,3 +135,31 @@ Adds a new task to the enterprise, optionally to a specified department. | Property | Type | Contract | Description | | :-- | :-- | :-- | :-- | | `TaskId` | string | required | Unique identifier of added task. | + +## Close task + +> ### Restricted! +> This operation is currently in beta-test and as such it is subject to change. + +Closes one or more tasks. Closed tasks are considered completed and not shown in active task lists. + +### Request + +`[PlatformAddress]/api/connector/v1/tasks/close` + +```javascript +{} +``` + +| Property | Type | Contract | Description | +| :-- | :-- | :-- | :-- | +| `ClientToken` | string | required | Token identifying the client application. | +| `AccessToken` | string | required | Access token of the client application. | +| `Client` | string | required | Name and version of the client application. | +| `TaskIds` | array of string | required, max 100 items | Unique identifiers of the Tasks to be closed. | + +### Response + +```javascript +{} +``` From 4f1e26002af765c335b73248bc2f7e7550ff6b13 Mon Sep 17 00:00:00 2001 From: "rafael.barrelo" Date: Fri, 27 Feb 2026 16:27:39 +0000 Subject: [PATCH 2/3] update close task request parameters --- connector-api/operations/services.md | 1 + connector-api/operations/tasks.md | 10 +++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/connector-api/operations/services.md b/connector-api/operations/services.md index e49e3be9..89906b8d 100644 --- a/connector-api/operations/services.md +++ b/connector-api/operations/services.md @@ -241,6 +241,7 @@ Returns selected availability and occupancy metrics of a bookable service for a * `AllocatedBlockAvailability` - Number of blocked resources that are in a deducting state (from an availability block / allotment). * `UsableResources` - Number of usable resources (i.e. which are not out of order). * `ActiveResources` - Number of active resources. +* `HouseUse` - Number of resources marked as house use (internal use). ### Response diff --git a/connector-api/operations/tasks.md b/connector-api/operations/tasks.md index 8e5a51ec..a027bb97 100644 --- a/connector-api/operations/tasks.md +++ b/connector-api/operations/tasks.md @@ -148,7 +148,15 @@ Closes one or more tasks. Closed tasks are considered completed and not shown in `[PlatformAddress]/api/connector/v1/tasks/close` ```javascript -{} +{ + "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", + "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", + "Client": "Sample Client 1.0.0", + "TaskIds": [ + "a7f6f8a1-6a2c-4c4d-8b9f-3c8a6d2f1b7e", + "b4c2d9fe-12a1-4c2b-9f6a-5b0c2f1d3e4a" + ] +} ``` | Property | Type | Contract | Description | From 5734fec5e79f1c641c2b3013c50e464cbe528425 Mon Sep 17 00:00:00 2001 From: "rafael.barrelo" Date: Fri, 27 Feb 2026 16:54:09 +0000 Subject: [PATCH 3/3] Add close task operation to API documentation --- connector-api/operations/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/connector-api/operations/README.md b/connector-api/operations/README.md index 24a59b21..c0a6b078 100644 --- a/connector-api/operations/README.md +++ b/connector-api/operations/README.md @@ -94,6 +94,7 @@ This section describes all operations supported by the API, organised here by th | [Add resource block](resourceblocks.md#add-resource-block) | Adds a new resource block to the specified resource for a defined period of time | | [Delete resource blocks](resourceblocks.md#delete-resource-blocks) | Removes specified resource blocks from the resources | | [Add task](tasks.md#add-task) | Adds a new task to the enterprise, optionally to a specified department | +| [Close task](tasks.md#close-tasks) | Closes one or more tasks. | | [Get all tasks](tasks.md#get-all-tasks) | Returns all tasks of the enterprise, filtered by identifiers or other filters | | [Get all resource categories](resourcecategories.md#get-all-resource-categories) | Returns all resource categories of an enterprise associated with the connector integration | | [Get all resource category assignments](resourcecategories.md#get-all-resource-category-assignments) | Returns all resource category assignments of an enterprise associated with the connector integration |