Microsoft Planner data contract | PatchOps Knowledge

Provenance

PublisherMicrosoft Planner

API basehttps://graph.microsoft.com/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (OAuth)

Methods (15)

planner_get_task

read

Retrieve a specific Planner task by task identifier.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId"
  ]
}

planner_update_task

write

Update a Planner task title with concurrency validation.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "title"
  ]
}

planner_update_task_categories

write

Update categories on a Planner task with concurrency validation.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "categories": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        }
      ]
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "categories"
  ]
}

planner_delete_task

write

Delete a Planner task using its identifier and concurrency tag.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId"
  ]
}

planner_update_task_status

write

Update a Planner task's status with concurrency validation.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "status": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "complete"
          ]
        },
        {
          "type": "string",
          "enum": [
            "incomplete"
          ]
        }
      ]
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "status"
  ]
}

planner_assign_task

unknown

Assign users to a Planner task with concurrency validation.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "assignments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string"
          },
          "orderHint": {
            "type": "string"
          }
        },
        "required": [
          "userId"
        ],
        "additionalProperties": false
      }
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "assignments"
  ]
}

planner_move_task_bucket

unknown

Move a Planner task to a specified bucket with concurrency validation.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "bucketId": {
      "type": "string"
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "bucketId"
  ]
}

planner_add_task_description

write

Update a Planner task description with concurrency validation.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "description"
  ]
}

planner_upload_task_image

write

Upload a Planner task image from provided base64 content.

Input schema

{
  "type": "object",
  "properties": {
    "groupId": {
      "type": "string"
    },
    "filename": {
      "type": "string"
    },
    "contentBase64": {
      "type": "string"
    },
    "contentType": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "groupId",
    "filename",
    "contentBase64"
  ]
}

planner_attach_task_image

unknown

Attach an image reference to a Planner task.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "referenceUrl": {
      "type": "string"
    },
    "alias": {
      "type": "string"
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "referenceUrl"
  ]
}

planner_set_task_image_preview

write

Set a Planner task's image preview using a reference URL.

Input schema

{
  "type": "object",
  "properties": {
    "taskId": {
      "type": "string"
    },
    "referenceUrl": {
      "type": "string"
    },
    "etag": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "taskId",
    "referenceUrl"
  ]
}

planner_list_plans

read

List Microsoft Planner plans available to the current user.

Input schema

{
  "type": "object",
  "properties": {
    "top": {
      "type": "number"
    }
  },
  "additionalProperties": true
}

planner_list_buckets

read

List buckets for a plan.

Required paramsplanId

Input schema

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "description": "Planner plan ID."
    }
  },
  "additionalProperties": true,
  "required": [
    "planId"
  ]
}

planner_list_tasks

read

List tasks for a plan.

Required paramsplanId

Input schema

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "description": "Planner plan ID."
    }
  },
  "additionalProperties": true,
  "required": [
    "planId"
  ]
}

planner_create_task

write

Create a Planner task in a plan.

Required paramsplanIdtitle

Input schema

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "description": "Planner plan ID."
    },
    "title": {
      "type": "string",
      "description": "Task title."
    },
    "bucketId": {
      "type": "string",
      "description": "Optional planner bucket ID."
    },
    "assignments": {
      "type": "object",
      "properties": {},
      "additionalProperties": true,
      "description": "Planner task assignments payload."
    },
    "startDateTime": {
      "type": "string"
    },
    "dueDateTime": {
      "type": "string"
    }
  },
  "additionalProperties": true,
  "required": [
    "planId",
    "title"
  ]
}