Skip to content

Latest commit

 

History

History
136 lines (104 loc) · 5.43 KB

plannerbuckettaskboardtaskformat-update.md

File metadata and controls

136 lines (104 loc) · 5.43 KB
title description ms.localizationpriority author ms.subservice doc_type
Update plannerBucketTaskBoardTaskFormat
Update the properties of a plannerBucketTaskBoardTaskFormat object.
medium
TarkanSevilmis
planner
apiPageType

Update plannerBucketTaskBoardTaskFormat

Namespace: microsoft.graph

Update the properties of a plannerBucketTaskBoardTaskFormat object.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

PATCH /planner/tasks/{id}/bucketTaskBoardFormat

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.
If-Match Last known ETag value for the plannerBucketTaskBoardTaskFormat to be updated. Required.

Request body

[!INCLUDE table-intro]

Property Type Description
orderHint String Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

Response

If successful, this method returns a 204 No Content response and empty content. If the request specifies the Prefer header with return=representation preference, then this method returns a 200 OK response code and an updated plannerBucketTaskBoardTaskFormat object in the response body.

This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 400, 403, 404, 409, and 412 responses. For more information about these errors, see Common Planner error conditions.

Example

Request

The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/planner/tasks/{task-id}/bucketTaskBoardFormat
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="

{
  "orderHint": "A6673H Ejkl!"
}

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]


Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR",
  "orderHint": "C3665D"
}