Microsoft Planner

Microsoft Planner API

RESTful API for accessing and managing tasks, plans, and buckets in Microsoft Planner through Microsoft Graph.

GitHub OpenAPI

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/planner-overview
📖
Authentication
https://learn.microsoft.com/en-us/graph/auth/
📖
RateLimits
https://learn.microsoft.com/en-us/graph/throttling
📖
GettingStarted
https://learn.microsoft.com/en-us/graph/planner-concept-overview
📖
APIReference
https://learn.microsoft.com/en-us/graph/api/resources/planner-overview?view=graph-rest-1.0
📖
GettingStarted
https://developer.microsoft.com/en-us/graph/quick-start

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/openapi/microsoft-planner-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/json-schema/microsoft-planner-task-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/json-ld/microsoft-planner-context.jsonld
🔗
Pricing
https://www.microsoft.com/en-us/microsoft-365/enterprise/microsoft365-plans-and-pricing
🔗
SDKs
.NET SDK
🔗
SDKs
JavaScript SDK
🔗
SDKs
Python SDK
🔗
SDKs
Java SDK
🔗
SDKs
Go SDK
🔗
SDKs
PHP SDK
🔗
Support
https://developer.microsoft.com/en-us/graph/support
🔗
ChangeLog
https://developer.microsoft.com/en-us/graph/changelog
🔗
Sandbox
https://developer.microsoft.com/en-us/graph/graph-explorer
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-add-bucket-task-to-plan-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-complete-my-first-task-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-complete-task-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-create-plan-bucket-task-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-create-task-with-details-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-list-group-plan-tasks-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-move-task-to-bucket-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/arazzo/microsoft-planner-rename-plan-workflow.yml

OpenAPI Specification

microsoft-planner-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Microsoft Planner Microsoft Graph Planner API
  description: >-
    The Microsoft Graph Planner API enables programmatic access to Planner
    resources in Microsoft 365. You can create and manage plans, tasks, and
    buckets to organize work, assign tasks to users, and track progress within
    groups. Plans are contained by Microsoft 365 groups, and tasks are organized
    into buckets within plans. This API covers the v1.0 stable endpoint for
    basic (non-premium) Planner operations.
  version: 1.0.0
  contact:
    name: Microsoft Graph Support
    url: https://developer.microsoft.com/en-us/graph/support
    email: graphsdksupport@microsoft.com
  license:
    name: Microsoft APIs Terms of Use
    url: https://docs.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
  termsOfService: https://docs.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
  x-apisguru-categories:
  - collaboration
  - project-management
  x-logo:
    url: https://docs.microsoft.com/en-us/media/logos/logo-ms-social.png

externalDocs:
  description: Microsoft Graph Planner API documentation
  url: https://learn.microsoft.com/en-us/graph/api/resources/planner-overview?view=graph-rest-1.0

servers:
- url: https://graph.microsoft.com/v1.0
  description: Microsoft Graph v1.0 production endpoint

security:
- oauth2:
  - Tasks.Read
  - Tasks.ReadWrite
  - Group.Read.All
  - Group.ReadWrite.All

tags:
- name: Buckets
  description: Operations for managing Planner buckets
  externalDocs:
    url: https://learn.microsoft.com/en-us/graph/api/resources/plannerbucket?view=graph-rest-1.0
- name: Plan Details
  description: Operations for managing additional plan details
  externalDocs:
    url: https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0
- name: Plans
  description: Operations for managing Planner plans
  externalDocs:
    url: https://learn.microsoft.com/en-us/graph/api/resources/plannerplan?view=graph-rest-1.0
- name: Task Details
  description: Operations for managing additional task details
  externalDocs:
    url: https://learn.microsoft.com/en-us/graph/api/resources/plannertaskdetails?view=graph-rest-1.0

- name: Tasks
  description: Operations for managing Planner tasks
  externalDocs:
    url: https://learn.microsoft.com/en-us/graph/api/resources/plannertask?view=graph-rest-1.0
paths:
  /planner/plans:
    post:
      operationId: createPlan
      summary: Microsoft Planner Create a Plan
      description: >-
        Create a new plannerPlan object. The plan is contained within a
        Microsoft 365 group specified by the container property.
      tags:
      - Plans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlannerPlanCreate'
            examples:
              CreateplanRequestExample:
                summary: Default createPlan request
                x-microcks-default: true
                value:
                  title: Example Title
                  container:
                    url: https://www.example.com
      responses:
        '201':
          description: The created plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerPlan'
              examples:
                Createplan201Example:
                  summary: Default createPlan 201 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    title: Example Title
                    container:
                      containerId: '500123'
                      type: group
                      url: https://www.example.com
                    owner: example_value
                    createdBy: {}
                    createdDateTime: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/plans/{plan-id}:
    parameters:
    - $ref: '#/components/parameters/PlanId'
    get:
      operationId: getPlan
      summary: Microsoft Planner Get a Plan
      description: >-
        Retrieve the properties and relationships of a plannerPlan object.
      tags:
      - Plans
      responses:
        '200':
          description: The requested plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerPlan'
              examples:
                Getplan200Example:
                  summary: Default getPlan 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    title: Example Title
                    container:
                      containerId: '500123'
                      type: group
                      url: https://www.example.com
                    owner: example_value
                    createdBy: {}
                    createdDateTime: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updatePlan
      summary: Microsoft Planner Update a Plan
      description: >-
        Update the properties of a plannerPlan object. Requires the If-Match
        header with the last known ETag value of the plan.
      tags:
      - Plans
      parameters:
      - $ref: '#/components/parameters/IfMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlannerPlanUpdate'
            examples:
              UpdateplanRequestExample:
                summary: Default updatePlan request
                x-microcks-default: true
                value:
                  title: Example Title
      responses:
        '200':
          description: The updated plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerPlan'
              examples:
                Updateplan200Example:
                  summary: Default updatePlan 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    title: Example Title
                    container:
                      containerId: '500123'
                      type: group
                      url: https://www.example.com
                    owner: example_value
                    createdBy: {}
                    createdDateTime: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deletePlan
      summary: Microsoft Planner Delete a Plan
      description: >-
        Delete a plannerPlan object. Requires the If-Match header with the
        last known ETag value of the plan.
      tags:
      - Plans
      parameters:
      - $ref: '#/components/parameters/IfMatch'
      responses:
        '204':
          description: Plan deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '412':
          $ref: '#/components/responses/PreconditionFailed'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/plans/{plan-id}/tasks:
    parameters:
    - $ref: '#/components/parameters/PlanId'
    get:
      operationId: listPlanTasks
      summary: Microsoft Planner List Plan Tasks
      description: >-
        Retrieve a list of plannerTask objects associated with a plannerPlan
        object.
      tags:
      - Plans
      - Tasks
      responses:
        '200':
          description: Collection of tasks in the plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerTaskCollection'
              examples:
                Listplantasks200Example:
                  summary: Default listPlanTasks 200 response
                  x-microcks-default: true
                  value:
                    '@odata.context': example_value
                    '@odata.count': 10
                    value:
                    - '@odata.etag': example_value
                      id: abc123
                      title: Example Title
                      planId: '500123'
                      bucketId: '500123'
                      priority: 10
                      percentComplete: 10
                      startDateTime: '2026-01-15T10:30:00Z'
                      dueDateTime: '2026-01-15T10:30:00Z'
                      completedDateTime: '2026-01-15T10:30:00Z'
                      createdDateTime: '2026-01-15T10:30:00Z'
                      hasDescription: true
                      conversationThreadId: '500123'
                      orderHint: example_value
                      assigneePriority: example_value
                      previewType: automatic
                      activeChecklistItemCount: 10
                      checklistItemCount: 10
                      referenceCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/plans/{plan-id}/buckets:
    parameters:
    - $ref: '#/components/parameters/PlanId'
    get:
      operationId: listPlanBuckets
      summary: Microsoft Planner List Plan Buckets
      description: >-
        Retrieve a list of plannerBucket objects contained in a plannerPlan
        object.
      tags:
      - Buckets
      - Plans
      responses:
        '200':
          description: Collection of buckets in the plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerBucketCollection'
              examples:
                Listplanbuckets200Example:
                  summary: Default listPlanBuckets 200 response
                  x-microcks-default: true
                  value:
                    '@odata.context': example_value
                    '@odata.count': 10
                    value:
                    - '@odata.etag': example_value
                      id: abc123
                      name: Example Title
                      planId: '500123'
                      orderHint: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/plans/{plan-id}/details:
    parameters:
    - $ref: '#/components/parameters/PlanId'
    get:
      operationId: getPlanDetails
      summary: Microsoft Planner Get Plan Details
      description: >-
        Retrieve the properties and relationships of a plannerPlanDetails
        object.
      tags:
      - Plan Details
      responses:
        '200':
          description: The plan details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerPlanDetails'
              examples:
                Getplandetails200Example:
                  summary: Default getPlanDetails 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    categoryDescriptions:
                      category1: example_value
                      category2: example_value
                      category3: example_value
                      category4: example_value
                      category5: example_value
                      category6: example_value
                      category7: example_value
                      category8: example_value
                      category9: example_value
                      category10: example_value
                      category11: example_value
                      category12: example_value
                      category13: example_value
                      category14: example_value
                      category15: example_value
                      category16: example_value
                      category17: example_value
                      category18: example_value
                      category19: example_value
                      category20: example_value
                      category21: example_value
                      category22: example_value
                      category23: example_value
                      category24: example_value
                      category25: example_value
                    sharedWith: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updatePlanDetails
      summary: Microsoft Planner Update Plan Details
      description: >-
        Update the properties of a plannerPlanDetails object. Requires the
        If-Match header with the last known ETag value.
      tags:
      - Plan Details
      parameters:
      - $ref: '#/components/parameters/IfMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlannerPlanDetailsUpdate'
            examples:
              UpdateplandetailsRequestExample:
                summary: Default updatePlanDetails request
                x-microcks-default: true
                value:
                  categoryDescriptions:
                    category1: example_value
                    category2: example_value
                    category3: example_value
                    category4: example_value
                    category5: example_value
                    category6: example_value
                    category7: example_value
                    category8: example_value
                    category9: example_value
                    category10: example_value
                    category11: example_value
                    category12: example_value
                    category13: example_value
                    category14: example_value
                    category15: example_value
                    category16: example_value
                    category17: example_value
                    category18: example_value
                    category19: example_value
                    category20: example_value
                    category21: example_value
                    category22: example_value
                    category23: example_value
                    category24: example_value
                    category25: example_value
                  sharedWith: {}
      responses:
        '200':
          description: The updated plan details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerPlanDetails'
              examples:
                Updateplandetails200Example:
                  summary: Default updatePlanDetails 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    categoryDescriptions:
                      category1: example_value
                      category2: example_value
                      category3: example_value
                      category4: example_value
                      category5: example_value
                      category6: example_value
                      category7: example_value
                      category8: example_value
                      category9: example_value
                      category10: example_value
                      category11: example_value
                      category12: example_value
                      category13: example_value
                      category14: example_value
                      category15: example_value
                      category16: example_value
                      category17: example_value
                      category18: example_value
                      category19: example_value
                      category20: example_value
                      category21: example_value
                      category22: example_value
                      category23: example_value
                      category24: example_value
                      category25: example_value
                    sharedWith: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '412':
          $ref: '#/components/responses/PreconditionFailed'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/tasks:
    post:
      operationId: createTask
      summary: Microsoft Planner Create a Task
      description: >-
        Create a new plannerTask. The task must specify a planId to indicate
        which plan it belongs to. Tasks cannot be created without plans.
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlannerTaskCreate'
            examples:
              CreatetaskRequestExample:
                summary: Default createTask request
                x-microcks-default: true
                value:
                  planId: '500123'
                  title: Example Title
                  bucketId: '500123'
                  assignments: {}
                  appliedCategories: {}
                  priority: 10
                  percentComplete: 10
                  startDateTime: '2026-01-15T10:30:00Z'
                  dueDateTime: '2026-01-15T10:30:00Z'
                  conversationThreadId: '500123'
                  orderHint: example_value
                  assigneePriority: example_value
      responses:
        '201':
          description: The created task
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerTask'
              examples:
                Createtask201Example:
                  summary: Default createTask 201 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    title: Example Title
                    planId: '500123'
                    bucketId: '500123'
                    assignments: {}
                    appliedCategories: {}
                    priority: 10
                    percentComplete: 10
                    startDateTime: '2026-01-15T10:30:00Z'
                    dueDateTime: '2026-01-15T10:30:00Z'
                    completedDateTime: '2026-01-15T10:30:00Z'
                    completedBy: {}
                    createdDateTime: '2026-01-15T10:30:00Z'
                    createdBy: {}
                    hasDescription: true
                    conversationThreadId: '500123'
                    orderHint: example_value
                    assigneePriority: example_value
                    previewType: automatic
                    activeChecklistItemCount: 10
                    checklistItemCount: 10
                    referenceCount: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/tasks/{task-id}:
    parameters:
    - $ref: '#/components/parameters/TaskId'
    get:
      operationId: getTask
      summary: Microsoft Planner Get a Task
      description: >-
        Retrieve the properties and relationships of a plannerTask object.
      tags:
      - Tasks
      responses:
        '200':
          description: The requested task
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerTask'
              examples:
                Gettask200Example:
                  summary: Default getTask 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    title: Example Title
                    planId: '500123'
                    bucketId: '500123'
                    assignments: {}
                    appliedCategories: {}
                    priority: 10
                    percentComplete: 10
                    startDateTime: '2026-01-15T10:30:00Z'
                    dueDateTime: '2026-01-15T10:30:00Z'
                    completedDateTime: '2026-01-15T10:30:00Z'
                    completedBy: {}
                    createdDateTime: '2026-01-15T10:30:00Z'
                    createdBy: {}
                    hasDescription: true
                    conversationThreadId: '500123'
                    orderHint: example_value
                    assigneePriority: example_value
                    previewType: automatic
                    activeChecklistItemCount: 10
                    checklistItemCount: 10
                    referenceCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateTask
      summary: Microsoft Planner Update a Task
      description: >-
        Update the properties of a plannerTask object. Requires the If-Match
        header with the last known ETag value of the task.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/IfMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlannerTaskUpdate'
            examples:
              UpdatetaskRequestExample:
                summary: Default updateTask request
                x-microcks-default: true
                value:
                  title: Example Title
                  bucketId: '500123'
                  assignments: {}
                  appliedCategories: {}
                  priority: 10
                  percentComplete: 10
                  startDateTime: '2026-01-15T10:30:00Z'
                  dueDateTime: '2026-01-15T10:30:00Z'
                  conversationThreadId: '500123'
                  orderHint: example_value
                  assigneePriority: example_value
                  previewType: automatic
      responses:
        '200':
          description: The updated task
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerTask'
              examples:
                Updatetask200Example:
                  summary: Default updateTask 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    title: Example Title
                    planId: '500123'
                    bucketId: '500123'
                    assignments: {}
                    appliedCategories: {}
                    priority: 10
                    percentComplete: 10
                    startDateTime: '2026-01-15T10:30:00Z'
                    dueDateTime: '2026-01-15T10:30:00Z'
                    completedDateTime: '2026-01-15T10:30:00Z'
                    completedBy: {}
                    createdDateTime: '2026-01-15T10:30:00Z'
                    createdBy: {}
                    hasDescription: true
                    conversationThreadId: '500123'
                    orderHint: example_value
                    assigneePriority: example_value
                    previewType: automatic
                    activeChecklistItemCount: 10
                    checklistItemCount: 10
                    referenceCount: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteTask
      summary: Microsoft Planner Delete a Task
      description: >-
        Delete a plannerTask object. Requires the If-Match header with the
        last known ETag value of the task.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/IfMatch'
      responses:
        '204':
          description: Task deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '412':
          $ref: '#/components/responses/PreconditionFailed'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/tasks/{task-id}/details:
    parameters:
    - $ref: '#/components/parameters/TaskId'
    get:
      operationId: getTaskDetails
      summary: Microsoft Planner Get Task Details
      description: >-
        Retrieve the properties and relationships of a plannerTaskDetails
        object.
      tags:
      - Task Details
      responses:
        '200':
          description: The task details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerTaskDetails'
              examples:
                Gettaskdetails200Example:
                  summary: Default getTaskDetails 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    description: A sample description.
                    checklist: {}
                    references: {}
                    previewType: automatic
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateTaskDetails
      summary: Microsoft Planner Update Task Details
      description: >-
        Update the properties of a plannerTaskDetails object. Requires the
        If-Match header with the last known ETag value.
      tags:
      - Task Details
      parameters:
      - $ref: '#/components/parameters/IfMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlannerTaskDetailsUpdate'
            examples:
              UpdatetaskdetailsRequestExample:
                summary: Default updateTaskDetails request
                x-microcks-default: true
                value:
                  description: A sample description.
                  checklist: {}
                  references: {}
                  previewType: automatic
      responses:
        '200':
          description: The updated task details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerTaskDetails'
              examples:
                Updatetaskdetails200Example:
                  summary: Default updateTaskDetails 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    description: A sample description.
                    checklist: {}
                    references: {}
                    previewType: automatic
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '412':
          $ref: '#/components/responses/PreconditionFailed'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/buckets:
    post:
      operationId: createBucket
      summary: Microsoft Planner Create a Bucket
      description: >-
        Create a new plannerBucket object. The bucket must specify a planId
        indicating which plan it belongs to.
      tags:
      - Buckets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlannerBucketCreate'
            examples:
              CreatebucketRequestExample:
                summary: Default createBucket request
                x-microcks-default: true
                value:
                  name: Example Title
                  planId: '500123'
                  orderHint: example_value
      responses:
        '201':
          description: The created bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerBucket'
              examples:
                Createbucket201Example:
                  summary: Default createBucket 201 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
                    id: abc123
                    name: Example Title
                    planId: '500123'
                    orderHint: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'

      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /planner/buckets/{bucket-id}:
    parameters:
    - $ref: '#/components/parameters/BucketId'
    get:
      operationId: getBucket
      summary: Microsoft Planner Get a Bucket
      description: >-
        Retrieve the properties and relationships of a plannerBucket object.
      tags:
      - Buckets
      responses:
        '200':
          description: The requested bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerBucket'
              examples:
                Getbucket200Example:
                  summary: Default getBucket 200 response
                  x-microcks-default: true
                  value:
                    '@odata.etag': example_value
       

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-planner/refs/heads/main/openapi/microsoft-planner-openapi.yml