mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
.Net: chore/updates plugins (#9843)
this PR updates the generated descriptions for copilot agent plugins, depends on #9841 and #9840 to function properly closes #9771 --------- Signed-off-by: Vincent Biret <[email protected]>
This commit is contained in:
Vincent Biret
+2
-1
@@ -23,7 +23,8 @@ extend-exclude = [
|
||||
"PopulationByCountry.csv",
|
||||
"PopulationByAdmin1.csv",
|
||||
"WomensSuffrage.txt",
|
||||
"SK-dotnet.sln.DotSettings"
|
||||
"SK-dotnet.sln.DotSettings",
|
||||
"dotnet/samples/Concepts/Resources/Plugins/CopilotAgentPlugins/README.md"
|
||||
]
|
||||
|
||||
[default.extend-words]
|
||||
|
||||
@@ -494,3 +494,6 @@ swa-cli.config.json
|
||||
|
||||
# python devcontainer
|
||||
/python/.devcontainer/*
|
||||
|
||||
# kiota workspace files
|
||||
**/.kiota
|
||||
+1
-1
@@ -20,7 +20,7 @@
|
||||
},
|
||||
{
|
||||
"name": "me_ListMessages",
|
||||
"description": "Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance."
|
||||
"description": "Get the messages in the signed-in user\u0026apos;s mailbox (including the Deleted Items and Clutter folders). Depending on the page size and mailbox data, getting messages from a mailbox can incur multiple requests. The default page size is 10 messages. Use $top to customize the page size, within the range of 1 and 1000. To improve the operation response time, use $select to specify the exact properties you need; see example 1 below. Fine-tune the values for $select and $top, especially when you must use a larger page size, as returning a page with hundreds of messages each with a full response payload may trigger the gateway timeout (HTTP 504). To get the next page of messages, simply apply the entire URL returned in @odata.nextLink to the next get-messages request. This URL includes any query parameters you may have specified in the initial request. Do not try to extract the $skip value from the @odata.nextLink URL to manipulate responses. This API uses the $skip value to keep count of all the items it has gone through in the user\u0026apos;s mailbox to return a page of message-type items. It\u0026apos;s therefore possible that even in the initial response, the $skip value is larger than the page size. For more information, see Paging Microsoft Graph data in your app. Currently, this operation returns message bodies in only HTML format. There are two scenarios where an app can get messages in another user\u0026apos;s mail folder:"
|
||||
}
|
||||
],
|
||||
"runtimes": [
|
||||
|
||||
-2
@@ -42,8 +42,6 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items: { }
|
||||
'400':
|
||||
description: 'Date must be between Jun 16, 1995 and Mar 28, 2019.'
|
||||
security:
|
||||
- api_key: [ ]
|
||||
components:
|
||||
|
||||
+284
-456
@@ -10,11 +10,8 @@ paths:
|
||||
get:
|
||||
tags:
|
||||
- me.message
|
||||
summary: Get open extension
|
||||
description: Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance.
|
||||
externalDocs:
|
||||
description: Find more info here
|
||||
url: https://learn.microsoft.com/graph/api/opentypeextension-get?view=graph-rest-1.0
|
||||
summary: List messages
|
||||
description: 'Get the messages in the signed-in user''s mailbox (including the Deleted Items and Clutter folders). Depending on the page size and mailbox data, getting messages from a mailbox can incur multiple requests. The default page size is 10 messages. Use $top to customize the page size, within the range of 1 and 1000. To improve the operation response time, use $select to specify the exact properties you need; see example 1 below. Fine-tune the values for $select and $top, especially when you must use a larger page size, as returning a page with hundreds of messages each with a full response payload may trigger the gateway timeout (HTTP 504). To get the next page of messages, simply apply the entire URL returned in @odata.nextLink to the next get-messages request. This URL includes any query parameters you may have specified in the initial request. Do not try to extract the $skip value from the @odata.nextLink URL to manipulate responses. This API uses the $skip value to keep count of all the items it has gone through in the user''s mailbox to return a page of message-type items. It''s therefore possible that even in the initial response, the $skip value is larger than the page size. For more information, see Paging Microsoft Graph data in your app. Currently, this operation returns message bodies in only HTML format. There are two scenarios where an app can get messages in another user''s mail folder:'
|
||||
operationId: me_ListMessages
|
||||
parameters:
|
||||
- name: includeHiddenMessages
|
||||
@@ -38,69 +35,6 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- id
|
||||
- id desc
|
||||
- categories
|
||||
- categories desc
|
||||
- changeKey
|
||||
- changeKey desc
|
||||
- createdDateTime
|
||||
- createdDateTime desc
|
||||
- lastModifiedDateTime
|
||||
- lastModifiedDateTime desc
|
||||
- bccRecipients
|
||||
- bccRecipients desc
|
||||
- body
|
||||
- body desc
|
||||
- bodyPreview
|
||||
- bodyPreview desc
|
||||
- ccRecipients
|
||||
- ccRecipients desc
|
||||
- conversationId
|
||||
- conversationId desc
|
||||
- conversationIndex
|
||||
- conversationIndex desc
|
||||
- flag
|
||||
- flag desc
|
||||
- from
|
||||
- from desc
|
||||
- hasAttachments
|
||||
- hasAttachments desc
|
||||
- importance
|
||||
- importance desc
|
||||
- inferenceClassification
|
||||
- inferenceClassification desc
|
||||
- internetMessageHeaders
|
||||
- internetMessageHeaders desc
|
||||
- internetMessageId
|
||||
- internetMessageId desc
|
||||
- isDeliveryReceiptRequested
|
||||
- isDeliveryReceiptRequested desc
|
||||
- isDraft
|
||||
- isDraft desc
|
||||
- isRead
|
||||
- isRead desc
|
||||
- isReadReceiptRequested
|
||||
- isReadReceiptRequested desc
|
||||
- parentFolderId
|
||||
- parentFolderId desc
|
||||
- receivedDateTime
|
||||
- receivedDateTime desc
|
||||
- replyTo
|
||||
- replyTo desc
|
||||
- sender
|
||||
- sender desc
|
||||
- sentDateTime
|
||||
- sentDateTime desc
|
||||
- subject
|
||||
- subject desc
|
||||
- toRecipients
|
||||
- toRecipients desc
|
||||
- uniqueBody
|
||||
- uniqueBody desc
|
||||
- webLink
|
||||
- webLink desc
|
||||
type: string
|
||||
- name: $select
|
||||
in: query
|
||||
@@ -111,42 +45,6 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- id
|
||||
- categories
|
||||
- changeKey
|
||||
- createdDateTime
|
||||
- lastModifiedDateTime
|
||||
- bccRecipients
|
||||
- body
|
||||
- bodyPreview
|
||||
- ccRecipients
|
||||
- conversationId
|
||||
- conversationIndex
|
||||
- flag
|
||||
- from
|
||||
- hasAttachments
|
||||
- importance
|
||||
- inferenceClassification
|
||||
- internetMessageHeaders
|
||||
- internetMessageId
|
||||
- isDeliveryReceiptRequested
|
||||
- isDraft
|
||||
- isRead
|
||||
- isReadReceiptRequested
|
||||
- parentFolderId
|
||||
- receivedDateTime
|
||||
- replyTo
|
||||
- sender
|
||||
- sentDateTime
|
||||
- subject
|
||||
- toRecipients
|
||||
- uniqueBody
|
||||
- webLink
|
||||
- attachments
|
||||
- extensions
|
||||
- multiValueExtendedProperties
|
||||
- singleValueExtendedProperties
|
||||
type: string
|
||||
- name: $expand
|
||||
in: query
|
||||
@@ -157,18 +55,10 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- '*'
|
||||
- attachments
|
||||
- extensions
|
||||
- multiValueExtendedProperties
|
||||
- singleValueExtendedProperties
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
2XX:
|
||||
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
|
||||
default:
|
||||
$ref: '#/components/responses/error'
|
||||
x-ms-pageable:
|
||||
nextLinkName: '@odata.nextLink'
|
||||
operationName: listMore
|
||||
@@ -176,224 +66,194 @@ paths:
|
||||
post:
|
||||
tags:
|
||||
- me.message
|
||||
summary: Create open extension
|
||||
description: 'Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource. You can create an open extension in a resource instance and store custom data to it all in the same operation, except for specific resources. The table in the Permissions section lists the resources that support open extensions.'
|
||||
externalDocs:
|
||||
description: Find more info here
|
||||
url: https://learn.microsoft.com/graph/api/opentypeextension-post-opentypeextension?view=graph-rest-1.0
|
||||
summary: Create message
|
||||
description: "Create a draft of a new message in either JSON or MIME format. When using JSON format, you can:\n- Include an attachment to the message.\n- Update the draft later to add content to the body or change other message properties. When using MIME format:\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\n- /* Add any attachments and S/MIME properties to the MIME content. By default, this operation saves the draft in the Drafts folder. Send the draft message in a subsequent operation. Alternatively, send a new message in a single operation, or create a draft to forward, reply and reply-all to an existing message."
|
||||
operationId: me_CreateMessages
|
||||
requestBody:
|
||||
description: New navigation property
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.outlookItem'
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
required: true
|
||||
responses:
|
||||
'201':
|
||||
2XX:
|
||||
description: Created navigation property.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
default:
|
||||
$ref: '#/components/responses/error'
|
||||
components:
|
||||
schemas:
|
||||
microsoft.graph.message:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
|
||||
- title: message
|
||||
type: object
|
||||
properties:
|
||||
bccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Bcc: recipients for the message.'
|
||||
body:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
|
||||
bodyPreview:
|
||||
type: string
|
||||
description: The first 255 characters of the message body. It is in text format.
|
||||
nullable: true
|
||||
ccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Cc: recipients for the message.'
|
||||
conversationId:
|
||||
type: string
|
||||
description: The ID of the conversation the email belongs to.
|
||||
nullable: true
|
||||
conversationIndex:
|
||||
type: string
|
||||
description: Indicates the position of the message within the conversation.
|
||||
format: base64url
|
||||
nullable: true
|
||||
flag:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.followupFlag'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The flag value that indicates the status, start date, due date, or completion date for the message.'
|
||||
from:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.'
|
||||
hasAttachments:
|
||||
type: boolean
|
||||
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src=''cid:[email protected]''>.'
|
||||
nullable: true
|
||||
importance:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.importance'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The importance of the message. The possible values are: low, normal, and high.'
|
||||
inferenceClassification:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.'
|
||||
internetMessageHeaders:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
|
||||
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
|
||||
internetMessageId:
|
||||
type: string
|
||||
description: The message ID in the format specified by RFC2822.
|
||||
nullable: true
|
||||
isDeliveryReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
isDraft:
|
||||
type: boolean
|
||||
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
|
||||
nullable: true
|
||||
isRead:
|
||||
type: boolean
|
||||
description: Indicates whether the message has been read.
|
||||
nullable: true
|
||||
isReadReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
parentFolderId:
|
||||
type: string
|
||||
description: The unique identifier for the message's parent mailFolder.
|
||||
nullable: true
|
||||
receivedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
replyTo:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: The email addresses to use when replying.
|
||||
sender:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.'
|
||||
sentDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
subject:
|
||||
type: string
|
||||
description: The subject of the message.
|
||||
nullable: true
|
||||
toRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The To: recipients for the message.'
|
||||
uniqueBody:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format.
|
||||
webLink:
|
||||
type: string
|
||||
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.'
|
||||
nullable: true
|
||||
attachments:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.attachment'
|
||||
description: The fileAttachment and itemAttachment attachments for the message.
|
||||
extensions:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.extension'
|
||||
description: The collection of open extensions defined for the message. Nullable.
|
||||
multiValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
|
||||
description: The collection of multi-value extended properties defined for the message. Nullable.
|
||||
singleValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
|
||||
description: The collection of single-value extended properties defined for the message. Nullable.
|
||||
microsoft.graph.outlookItem:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: outlookItem
|
||||
type: object
|
||||
properties:
|
||||
categories:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The categories associated with the item
|
||||
changeKey:
|
||||
type: string
|
||||
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
|
||||
nullable: true
|
||||
createdDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
title: message
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
categories:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The categories associated with the item
|
||||
changeKey:
|
||||
type: string
|
||||
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
|
||||
nullable: true
|
||||
createdDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
bccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Bcc: recipients for the message.'
|
||||
body:
|
||||
$ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
bodyPreview:
|
||||
type: string
|
||||
description: The first 255 characters of the message body. It is in text format.
|
||||
nullable: true
|
||||
ccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Cc: recipients for the message.'
|
||||
conversationId:
|
||||
type: string
|
||||
description: The ID of the conversation the email belongs to.
|
||||
nullable: true
|
||||
conversationIndex:
|
||||
type: string
|
||||
description: Indicates the position of the message within the conversation.
|
||||
format: base64url
|
||||
nullable: true
|
||||
flag:
|
||||
$ref: '#/components/schemas/microsoft.graph.followupFlag'
|
||||
from:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
hasAttachments:
|
||||
type: boolean
|
||||
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src=''cid:[email protected]''>.'
|
||||
nullable: true
|
||||
importance:
|
||||
$ref: '#/components/schemas/microsoft.graph.importance'
|
||||
inferenceClassification:
|
||||
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
|
||||
internetMessageHeaders:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
|
||||
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
|
||||
internetMessageId:
|
||||
type: string
|
||||
description: The message ID in the format specified by RFC2822.
|
||||
nullable: true
|
||||
isDeliveryReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
isDraft:
|
||||
type: boolean
|
||||
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
|
||||
nullable: true
|
||||
isRead:
|
||||
type: boolean
|
||||
description: Indicates whether the message has been read.
|
||||
nullable: true
|
||||
isReadReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
parentFolderId:
|
||||
type: string
|
||||
description: The unique identifier for the message's parent mailFolder.
|
||||
nullable: true
|
||||
receivedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
replyTo:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: The email addresses to use when replying.
|
||||
sender:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
sentDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
subject:
|
||||
type: string
|
||||
description: The subject of the message.
|
||||
nullable: true
|
||||
toRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The To: recipients for the message.'
|
||||
uniqueBody:
|
||||
$ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
webLink:
|
||||
type: string
|
||||
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.'
|
||||
nullable: true
|
||||
attachments:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.attachment'
|
||||
description: The fileAttachment and itemAttachment attachments for the message.
|
||||
extensions:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.extension'
|
||||
description: The collection of open extensions defined for the message. Nullable.
|
||||
multiValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
|
||||
description: The collection of multi-value extended properties defined for the message. Nullable.
|
||||
singleValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
|
||||
description: The collection of single-value extended properties defined for the message. Nullable.
|
||||
microsoft.graph.recipient:
|
||||
title: recipient
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
emailAddress:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The recipient's email address.
|
||||
$ref: '#/components/schemas/microsoft.graph.emailAddress'
|
||||
'@odata.type':
|
||||
type: string
|
||||
discriminator:
|
||||
propertyName: '@odata.type'
|
||||
microsoft.graph.itemBody:
|
||||
title: itemBody
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
content:
|
||||
@@ -401,39 +261,27 @@ components:
|
||||
description: The content of the item.
|
||||
nullable: true
|
||||
contentType:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.bodyType'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The type of the content. Possible values are text and html.
|
||||
$ref: '#/components/schemas/microsoft.graph.bodyType'
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
|
||||
microsoft.graph.followupFlag:
|
||||
title: followupFlag
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
completedDateTime:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The date and time that the follow-up was finished.
|
||||
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
dueDateTime:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The date and time that the follow-up is to be finished. Note: To set the due date, you must also specify the startDateTime; otherwise, you get a 400 Bad Request response.'
|
||||
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
flagStatus:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The status for follow-up for an item. Possible values are notFlagged, complete, and flagged.'
|
||||
$ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
|
||||
startDateTime:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The date and time that the follow-up is to begin.
|
||||
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: 'The flag value that indicates the status, start date, due date, or completion date for the message.'
|
||||
microsoft.graph.importance:
|
||||
title: importance
|
||||
enum:
|
||||
@@ -441,14 +289,18 @@ components:
|
||||
- normal
|
||||
- high
|
||||
type: string
|
||||
description: 'The importance of the message. The possible values are: low, normal, and high.'
|
||||
microsoft.graph.inferenceClassificationType:
|
||||
title: inferenceClassificationType
|
||||
enum:
|
||||
- focused
|
||||
- other
|
||||
type: string
|
||||
description: 'The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.'
|
||||
microsoft.graph.internetMessageHeader:
|
||||
title: internetMessageHeader
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
@@ -459,89 +311,104 @@ components:
|
||||
type: string
|
||||
description: The value in a key-value pair.
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
microsoft.graph.attachment:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: attachment
|
||||
type: object
|
||||
properties:
|
||||
contentType:
|
||||
type: string
|
||||
description: The MIME type.
|
||||
nullable: true
|
||||
isInline:
|
||||
type: boolean
|
||||
description: 'true if the attachment is an inline attachment; otherwise, false.'
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
name:
|
||||
type: string
|
||||
description: The attachment's file name.
|
||||
nullable: true
|
||||
size:
|
||||
maximum: 2147483647
|
||||
minimum: -2147483648
|
||||
type: number
|
||||
description: The length of the attachment in bytes.
|
||||
format: int32
|
||||
microsoft.graph.extension:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: extension
|
||||
type: object
|
||||
microsoft.graph.multiValueLegacyExtendedProperty:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: multiValueLegacyExtendedProperty
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A collection of property values.
|
||||
microsoft.graph.singleValueLegacyExtendedProperty:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: singleValueLegacyExtendedProperty
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
description: A property value.
|
||||
nullable: true
|
||||
microsoft.graph.messageCollectionResponse:
|
||||
title: Collection of message
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
|
||||
- type: object
|
||||
properties:
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
microsoft.graph.ODataErrors.ODataError:
|
||||
title: attachment
|
||||
required:
|
||||
- error
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
|
||||
microsoft.graph.entity:
|
||||
title: entity
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
contentType:
|
||||
type: string
|
||||
description: The MIME type.
|
||||
nullable: true
|
||||
isInline:
|
||||
type: boolean
|
||||
description: 'true if the attachment is an inline attachment; otherwise, false.'
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
name:
|
||||
type: string
|
||||
description: The attachment's file name.
|
||||
nullable: true
|
||||
size:
|
||||
maximum: 2147483647
|
||||
minimum: -2147483648
|
||||
type: number
|
||||
description: The length of the attachment in bytes.
|
||||
format: int32
|
||||
microsoft.graph.extension:
|
||||
title: extension
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
microsoft.graph.multiValueLegacyExtendedProperty:
|
||||
title: multiValueLegacyExtendedProperty
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A collection of property values.
|
||||
microsoft.graph.singleValueLegacyExtendedProperty:
|
||||
title: singleValueLegacyExtendedProperty
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
value:
|
||||
type: string
|
||||
description: A property value.
|
||||
nullable: true
|
||||
microsoft.graph.messageCollectionResponse:
|
||||
title: Base collection pagination and count responses
|
||||
type: object
|
||||
properties:
|
||||
'@odata.count':
|
||||
type: integer
|
||||
format: int64
|
||||
nullable: true
|
||||
'@odata.nextLink':
|
||||
type: string
|
||||
nullable: true
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
microsoft.graph.emailAddress:
|
||||
title: emailAddress
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
address:
|
||||
@@ -552,14 +419,20 @@ components:
|
||||
type: string
|
||||
description: The display name of the person or entity.
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: The recipient's email address.
|
||||
microsoft.graph.bodyType:
|
||||
title: bodyType
|
||||
enum:
|
||||
- text
|
||||
- html
|
||||
type: string
|
||||
description: The type of the content. Possible values are text and html.
|
||||
microsoft.graph.dateTimeTimeZone:
|
||||
title: dateTimeTimeZone
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
dateTime:
|
||||
@@ -569,6 +442,9 @@ components:
|
||||
type: string
|
||||
description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.'
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: The date and time that the follow-up was finished.
|
||||
microsoft.graph.followupFlagStatus:
|
||||
title: followupFlagStatus
|
||||
enum:
|
||||
@@ -576,49 +452,7 @@ components:
|
||||
- complete
|
||||
- flagged
|
||||
type: string
|
||||
BaseCollectionPaginationCountResponse:
|
||||
title: Base collection pagination and count responses
|
||||
type: object
|
||||
properties:
|
||||
'@odata.nextLink':
|
||||
type: string
|
||||
nullable: true
|
||||
microsoft.graph.ODataErrors.MainError:
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
x-ms-primary-error-message: true
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
details:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
|
||||
innerError:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
|
||||
microsoft.graph.ODataErrors.ErrorDetails:
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
microsoft.graph.ODataErrors.InnerError:
|
||||
type: object
|
||||
description: The structure of this object is service-specific
|
||||
description: 'The status for follow-up for an item. Possible values are notFlagged, complete, and flagged.'
|
||||
responses:
|
||||
microsoft.graph.messageCollectionResponse:
|
||||
description: Retrieved collection
|
||||
@@ -626,12 +460,6 @@ components:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.messageCollectionResponse'
|
||||
error:
|
||||
description: error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
|
||||
parameters:
|
||||
top:
|
||||
name: $top
|
||||
|
||||
+417
-818
File diff suppressed because it is too large
Load Diff
+241
-441
@@ -12,9 +12,6 @@ paths:
|
||||
- me.contact
|
||||
summary: List contacts
|
||||
description: 'Get a contact collection from the default contacts folder of the signed-in user. There are two scenarios where an app can get contacts in another user''s contact folder:'
|
||||
externalDocs:
|
||||
description: Find more info here
|
||||
url: https://learn.microsoft.com/graph/api/user-list-contacts?view=graph-rest-1.0
|
||||
operationId: me_ListContacts
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/top'
|
||||
@@ -31,83 +28,6 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- id
|
||||
- id desc
|
||||
- categories
|
||||
- categories desc
|
||||
- changeKey
|
||||
- changeKey desc
|
||||
- createdDateTime
|
||||
- createdDateTime desc
|
||||
- lastModifiedDateTime
|
||||
- lastModifiedDateTime desc
|
||||
- assistantName
|
||||
- assistantName desc
|
||||
- birthday
|
||||
- birthday desc
|
||||
- businessAddress
|
||||
- businessAddress desc
|
||||
- businessHomePage
|
||||
- businessHomePage desc
|
||||
- businessPhones
|
||||
- businessPhones desc
|
||||
- children
|
||||
- children desc
|
||||
- companyName
|
||||
- companyName desc
|
||||
- department
|
||||
- department desc
|
||||
- displayName
|
||||
- displayName desc
|
||||
- emailAddresses
|
||||
- emailAddresses desc
|
||||
- fileAs
|
||||
- fileAs desc
|
||||
- generation
|
||||
- generation desc
|
||||
- givenName
|
||||
- givenName desc
|
||||
- homeAddress
|
||||
- homeAddress desc
|
||||
- homePhones
|
||||
- homePhones desc
|
||||
- imAddresses
|
||||
- imAddresses desc
|
||||
- initials
|
||||
- initials desc
|
||||
- jobTitle
|
||||
- jobTitle desc
|
||||
- manager
|
||||
- manager desc
|
||||
- middleName
|
||||
- middleName desc
|
||||
- mobilePhone
|
||||
- mobilePhone desc
|
||||
- nickName
|
||||
- nickName desc
|
||||
- officeLocation
|
||||
- officeLocation desc
|
||||
- otherAddress
|
||||
- otherAddress desc
|
||||
- parentFolderId
|
||||
- parentFolderId desc
|
||||
- personalNotes
|
||||
- personalNotes desc
|
||||
- profession
|
||||
- profession desc
|
||||
- spouseName
|
||||
- spouseName desc
|
||||
- surname
|
||||
- surname desc
|
||||
- title
|
||||
- title desc
|
||||
- yomiCompanyName
|
||||
- yomiCompanyName desc
|
||||
- yomiGivenName
|
||||
- yomiGivenName desc
|
||||
- yomiSurname
|
||||
- yomiSurname desc
|
||||
type: string
|
||||
- name: $select
|
||||
in: query
|
||||
@@ -118,49 +38,6 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- id
|
||||
- categories
|
||||
- changeKey
|
||||
- createdDateTime
|
||||
- lastModifiedDateTime
|
||||
- assistantName
|
||||
- birthday
|
||||
- businessAddress
|
||||
- businessHomePage
|
||||
- businessPhones
|
||||
- children
|
||||
- companyName
|
||||
- department
|
||||
- displayName
|
||||
- emailAddresses
|
||||
- fileAs
|
||||
- generation
|
||||
- givenName
|
||||
- homeAddress
|
||||
- homePhones
|
||||
- imAddresses
|
||||
- initials
|
||||
- jobTitle
|
||||
- manager
|
||||
- middleName
|
||||
- mobilePhone
|
||||
- nickName
|
||||
- officeLocation
|
||||
- otherAddress
|
||||
- parentFolderId
|
||||
- personalNotes
|
||||
- profession
|
||||
- spouseName
|
||||
- surname
|
||||
- title
|
||||
- yomiCompanyName
|
||||
- yomiGivenName
|
||||
- yomiSurname
|
||||
- extensions
|
||||
- multiValueExtendedProperties
|
||||
- photo
|
||||
- singleValueExtendedProperties
|
||||
type: string
|
||||
- name: $expand
|
||||
in: query
|
||||
@@ -171,18 +48,10 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- '*'
|
||||
- extensions
|
||||
- multiValueExtendedProperties
|
||||
- photo
|
||||
- singleValueExtendedProperties
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
2XX:
|
||||
$ref: '#/components/responses/microsoft.graph.contactCollectionResponse'
|
||||
default:
|
||||
$ref: '#/components/responses/error'
|
||||
x-ms-pageable:
|
||||
nextLinkName: '@odata.nextLink'
|
||||
operationName: listMore
|
||||
@@ -190,256 +59,211 @@ paths:
|
||||
components:
|
||||
schemas:
|
||||
microsoft.graph.contactCollectionResponse:
|
||||
title: Collection of contact
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
|
||||
- type: object
|
||||
properties:
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.contact'
|
||||
microsoft.graph.ODataErrors.ODataError:
|
||||
required:
|
||||
- error
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
|
||||
BaseCollectionPaginationCountResponse:
|
||||
title: Base collection pagination and count responses
|
||||
type: object
|
||||
properties:
|
||||
'@odata.count':
|
||||
type: integer
|
||||
format: int64
|
||||
nullable: true
|
||||
'@odata.nextLink':
|
||||
type: string
|
||||
nullable: true
|
||||
microsoft.graph.contact:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
|
||||
- title: contact
|
||||
type: object
|
||||
properties:
|
||||
assistantName:
|
||||
type: string
|
||||
description: The name of the contact's assistant.
|
||||
nullable: true
|
||||
birthday:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The contact''s birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
businessAddress:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The contact's business address.
|
||||
businessHomePage:
|
||||
type: string
|
||||
description: The business home page of the contact.
|
||||
nullable: true
|
||||
businessPhones:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The contact's business phone numbers.
|
||||
children:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The names of the contact's children.
|
||||
companyName:
|
||||
type: string
|
||||
description: The name of the contact's company.
|
||||
nullable: true
|
||||
department:
|
||||
type: string
|
||||
description: The contact's department.
|
||||
nullable: true
|
||||
displayName:
|
||||
type: string
|
||||
description: 'The contact''s display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation.'
|
||||
nullable: true
|
||||
emailAddresses:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.emailAddress'
|
||||
description: The contact's email addresses.
|
||||
fileAs:
|
||||
type: string
|
||||
description: The name the contact is filed under.
|
||||
nullable: true
|
||||
generation:
|
||||
type: string
|
||||
description: The contact's suffix.
|
||||
nullable: true
|
||||
givenName:
|
||||
type: string
|
||||
description: The contact's given name.
|
||||
nullable: true
|
||||
homeAddress:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The contact's home address.
|
||||
homePhones:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The contact's home phone numbers.
|
||||
imAddresses:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The contact's instant messaging (IM) addresses.
|
||||
initials:
|
||||
type: string
|
||||
description: The contact's initials.
|
||||
nullable: true
|
||||
jobTitle:
|
||||
type: string
|
||||
description: The contact’s job title.
|
||||
nullable: true
|
||||
manager:
|
||||
type: string
|
||||
description: The name of the contact's manager.
|
||||
nullable: true
|
||||
middleName:
|
||||
type: string
|
||||
description: The contact's middle name.
|
||||
nullable: true
|
||||
mobilePhone:
|
||||
type: string
|
||||
description: The contact's mobile phone number.
|
||||
nullable: true
|
||||
nickName:
|
||||
type: string
|
||||
description: The contact's nickname.
|
||||
nullable: true
|
||||
officeLocation:
|
||||
type: string
|
||||
description: The location of the contact's office.
|
||||
nullable: true
|
||||
otherAddress:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: Other addresses for the contact.
|
||||
parentFolderId:
|
||||
type: string
|
||||
description: The ID of the contact's parent folder.
|
||||
nullable: true
|
||||
personalNotes:
|
||||
type: string
|
||||
description: The user's notes about the contact.
|
||||
nullable: true
|
||||
profession:
|
||||
type: string
|
||||
description: The contact's profession.
|
||||
nullable: true
|
||||
spouseName:
|
||||
type: string
|
||||
description: The name of the contact's spouse/partner.
|
||||
nullable: true
|
||||
surname:
|
||||
type: string
|
||||
description: The contact's surname.
|
||||
nullable: true
|
||||
title:
|
||||
type: string
|
||||
description: The contact's title.
|
||||
nullable: true
|
||||
yomiCompanyName:
|
||||
type: string
|
||||
description: The phonetic Japanese company name of the contact.
|
||||
nullable: true
|
||||
yomiGivenName:
|
||||
type: string
|
||||
description: The phonetic Japanese given name (first name) of the contact.
|
||||
nullable: true
|
||||
yomiSurname:
|
||||
type: string
|
||||
description: The phonetic Japanese surname (last name) of the contact.
|
||||
nullable: true
|
||||
extensions:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.extension'
|
||||
description: The collection of open extensions defined for the contact. Read-only. Nullable.
|
||||
multiValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
|
||||
description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
|
||||
photo:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: Optional contact picture. You can get or set a photo for a contact.
|
||||
singleValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
|
||||
description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
|
||||
microsoft.graph.ODataErrors.MainError:
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
x-ms-primary-error-message: true
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
details:
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
|
||||
innerError:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
|
||||
microsoft.graph.outlookItem:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: outlookItem
|
||||
type: object
|
||||
properties:
|
||||
categories:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The categories associated with the item
|
||||
changeKey:
|
||||
type: string
|
||||
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
|
||||
nullable: true
|
||||
createdDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
$ref: '#/components/schemas/microsoft.graph.contact'
|
||||
microsoft.graph.contact:
|
||||
title: contact
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
categories:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The categories associated with the item
|
||||
changeKey:
|
||||
type: string
|
||||
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
|
||||
nullable: true
|
||||
createdDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
assistantName:
|
||||
type: string
|
||||
description: The name of the contact's assistant.
|
||||
nullable: true
|
||||
birthday:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The contact''s birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
businessAddress:
|
||||
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
|
||||
businessHomePage:
|
||||
type: string
|
||||
description: The business home page of the contact.
|
||||
nullable: true
|
||||
businessPhones:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The contact's business phone numbers.
|
||||
children:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The names of the contact's children.
|
||||
companyName:
|
||||
type: string
|
||||
description: The name of the contact's company.
|
||||
nullable: true
|
||||
department:
|
||||
type: string
|
||||
description: The contact's department.
|
||||
nullable: true
|
||||
displayName:
|
||||
type: string
|
||||
description: 'The contact''s display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation.'
|
||||
nullable: true
|
||||
emailAddresses:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.emailAddress'
|
||||
description: The contact's email addresses.
|
||||
fileAs:
|
||||
type: string
|
||||
description: The name the contact is filed under.
|
||||
nullable: true
|
||||
generation:
|
||||
type: string
|
||||
description: The contact's suffix.
|
||||
nullable: true
|
||||
givenName:
|
||||
type: string
|
||||
description: The contact's given name.
|
||||
nullable: true
|
||||
homeAddress:
|
||||
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
|
||||
homePhones:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The contact's home phone numbers.
|
||||
imAddresses:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The contact's instant messaging (IM) addresses.
|
||||
initials:
|
||||
type: string
|
||||
description: The contact's initials.
|
||||
nullable: true
|
||||
jobTitle:
|
||||
type: string
|
||||
description: The contact’s job title.
|
||||
nullable: true
|
||||
manager:
|
||||
type: string
|
||||
description: The name of the contact's manager.
|
||||
nullable: true
|
||||
middleName:
|
||||
type: string
|
||||
description: The contact's middle name.
|
||||
nullable: true
|
||||
mobilePhone:
|
||||
type: string
|
||||
description: The contact's mobile phone number.
|
||||
nullable: true
|
||||
nickName:
|
||||
type: string
|
||||
description: The contact's nickname.
|
||||
nullable: true
|
||||
officeLocation:
|
||||
type: string
|
||||
description: The location of the contact's office.
|
||||
nullable: true
|
||||
otherAddress:
|
||||
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
|
||||
parentFolderId:
|
||||
type: string
|
||||
description: The ID of the contact's parent folder.
|
||||
nullable: true
|
||||
personalNotes:
|
||||
type: string
|
||||
description: The user's notes about the contact.
|
||||
nullable: true
|
||||
profession:
|
||||
type: string
|
||||
description: The contact's profession.
|
||||
nullable: true
|
||||
spouseName:
|
||||
type: string
|
||||
description: The name of the contact's spouse/partner.
|
||||
nullable: true
|
||||
surname:
|
||||
type: string
|
||||
description: The contact's surname.
|
||||
nullable: true
|
||||
title:
|
||||
type: string
|
||||
description: The contact's title.
|
||||
nullable: true
|
||||
yomiCompanyName:
|
||||
type: string
|
||||
description: The phonetic Japanese company name of the contact.
|
||||
nullable: true
|
||||
yomiGivenName:
|
||||
type: string
|
||||
description: The phonetic Japanese given name (first name) of the contact.
|
||||
nullable: true
|
||||
yomiSurname:
|
||||
type: string
|
||||
description: The phonetic Japanese surname (last name) of the contact.
|
||||
nullable: true
|
||||
extensions:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.extension'
|
||||
description: The collection of open extensions defined for the contact. Read-only. Nullable.
|
||||
multiValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
|
||||
description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
|
||||
photo:
|
||||
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
|
||||
singleValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
|
||||
description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
|
||||
microsoft.graph.physicalAddress:
|
||||
title: physicalAddress
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
city:
|
||||
@@ -462,8 +286,13 @@ components:
|
||||
type: string
|
||||
description: The street.
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: The contact's business address.
|
||||
microsoft.graph.emailAddress:
|
||||
title: emailAddress
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
address:
|
||||
@@ -474,76 +303,53 @@ components:
|
||||
type: string
|
||||
description: The display name of the person or entity.
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
microsoft.graph.extension:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: extension
|
||||
type: object
|
||||
microsoft.graph.multiValueLegacyExtendedProperty:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: multiValueLegacyExtendedProperty
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A collection of property values.
|
||||
microsoft.graph.profilePhoto:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: profilePhoto
|
||||
type: object
|
||||
properties:
|
||||
height:
|
||||
maximum: 2147483647
|
||||
minimum: -2147483648
|
||||
type: number
|
||||
description: The height of the photo. Read-only.
|
||||
format: int32
|
||||
nullable: true
|
||||
width:
|
||||
maximum: 2147483647
|
||||
minimum: -2147483648
|
||||
type: number
|
||||
description: The width of the photo. Read-only.
|
||||
format: int32
|
||||
nullable: true
|
||||
microsoft.graph.singleValueLegacyExtendedProperty:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: singleValueLegacyExtendedProperty
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
description: A property value.
|
||||
nullable: true
|
||||
microsoft.graph.ODataErrors.ErrorDetails:
|
||||
title: extension
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
microsoft.graph.ODataErrors.InnerError:
|
||||
type: object
|
||||
description: The structure of this object is service-specific
|
||||
microsoft.graph.entity:
|
||||
title: entity
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
microsoft.graph.multiValueLegacyExtendedProperty:
|
||||
title: multiValueLegacyExtendedProperty
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A collection of property values.
|
||||
microsoft.graph.profilePhoto:
|
||||
description: Optional contact picture. You can get or set a photo for a contact.
|
||||
microsoft.graph.singleValueLegacyExtendedProperty:
|
||||
title: singleValueLegacyExtendedProperty
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
value:
|
||||
type: string
|
||||
description: A property value.
|
||||
nullable: true
|
||||
responses:
|
||||
microsoft.graph.contactCollectionResponse:
|
||||
description: Retrieved collection
|
||||
@@ -551,12 +357,6 @@ components:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.contactCollectionResponse'
|
||||
error:
|
||||
description: error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
|
||||
parameters:
|
||||
top:
|
||||
name: $top
|
||||
|
||||
+3
-3
@@ -9,13 +9,13 @@
|
||||
"capabilities": {
|
||||
"conversation_starters": [
|
||||
{
|
||||
"text": "Get content for the navigation property children f"
|
||||
"text": "Get content for the navigation property items from"
|
||||
}
|
||||
]
|
||||
},
|
||||
"functions": [
|
||||
{
|
||||
"name": "drive_root_GetChildrenContent",
|
||||
"name": "drives_GetItemsContent",
|
||||
"description": "The content stream, if the item represents a file."
|
||||
}
|
||||
],
|
||||
@@ -29,7 +29,7 @@
|
||||
"url": "driveitem-openapi.yml"
|
||||
},
|
||||
"run_for_functions": [
|
||||
"drive_root_GetChildrenContent"
|
||||
"drives_GetItemsContent"
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
+19
-64
@@ -6,21 +6,14 @@ info:
|
||||
servers:
|
||||
- url: https://graph.microsoft.com/v1.0
|
||||
paths:
|
||||
'/drive/root/children/{driveItem-id}/content':
|
||||
'/drives/{drive-id}/items/{driveItem-id}/content':
|
||||
get:
|
||||
tags:
|
||||
- drive.driveItem
|
||||
summary: Get content for the navigation property children from drive
|
||||
- drives.driveItem
|
||||
summary: Get content for the navigation property items from drives
|
||||
description: 'The content stream, if the item represents a file.'
|
||||
operationId: drive_root_GetChildrenContent
|
||||
operationId: drives_GetItemsContent
|
||||
parameters:
|
||||
- name: driveItem-id
|
||||
in: path
|
||||
description: The unique identifier of driveItem
|
||||
required: true
|
||||
style: simple
|
||||
schema:
|
||||
type: string
|
||||
- name: $format
|
||||
in: query
|
||||
description: Format of the content
|
||||
@@ -29,64 +22,26 @@ paths:
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
2XX:
|
||||
description: Retrieved media content
|
||||
content:
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
default:
|
||||
$ref: '#/components/responses/error'
|
||||
components:
|
||||
schemas:
|
||||
microsoft.graph.ODataErrors.ODataError:
|
||||
required:
|
||||
- error
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
|
||||
microsoft.graph.ODataErrors.MainError:
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
parameters:
|
||||
- name: drive-id
|
||||
in: path
|
||||
description: The unique identifier of drive
|
||||
required: true
|
||||
style: simple
|
||||
schema:
|
||||
type: string
|
||||
message:
|
||||
- name: driveItem-id
|
||||
in: path
|
||||
description: The unique identifier of driveItem
|
||||
required: true
|
||||
style: simple
|
||||
schema:
|
||||
type: string
|
||||
x-ms-primary-error-message: true
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
details:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
|
||||
innerError:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
|
||||
microsoft.graph.ODataErrors.ErrorDetails:
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
microsoft.graph.ODataErrors.InnerError:
|
||||
type: object
|
||||
description: The structure of this object is service-specific
|
||||
responses:
|
||||
error:
|
||||
description: error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
|
||||
components: { }
|
||||
+4
-4
@@ -9,21 +9,21 @@
|
||||
"capabilities": {
|
||||
"conversation_starters": [
|
||||
{
|
||||
"text": "Get open extension"
|
||||
"text": "List messages"
|
||||
},
|
||||
{
|
||||
"text": "Create open extension"
|
||||
"text": "Create message"
|
||||
}
|
||||
]
|
||||
},
|
||||
"functions": [
|
||||
{
|
||||
"name": "me_CreateMessages",
|
||||
"description": "Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource. You can create an open extension in a resource instance and store custom data to it all in the same operation, except for specific resources. The table in the Permissions section lists the resources that support open extensions."
|
||||
"description": "Create a draft of a new message in either JSON or MIME format. When using JSON format, you can:\n- Include an attachment to the message.\n- Update the draft later to add content to the body or change other message properties. When using MIME format:\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\n- /* Add any attachments and S/MIME properties to the MIME content. By default, this operation saves the draft in the Drafts folder. Send the draft message in a subsequent operation. Alternatively, send a new message in a single operation, or create a draft to forward, reply and reply-all to an existing message."
|
||||
},
|
||||
{
|
||||
"name": "me_ListMessages",
|
||||
"description": "Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance."
|
||||
"description": "Get the messages in the signed-in user\u0026apos;s mailbox (including the Deleted Items and Clutter folders). Depending on the page size and mailbox data, getting messages from a mailbox can incur multiple requests. The default page size is 10 messages. Use $top to customize the page size, within the range of 1 and 1000. To improve the operation response time, use $select to specify the exact properties you need; see example 1 below. Fine-tune the values for $select and $top, especially when you must use a larger page size, as returning a page with hundreds of messages each with a full response payload may trigger the gateway timeout (HTTP 504). To get the next page of messages, simply apply the entire URL returned in @odata.nextLink to the next get-messages request. This URL includes any query parameters you may have specified in the initial request. Do not try to extract the $skip value from the @odata.nextLink URL to manipulate responses. This API uses the $skip value to keep count of all the items it has gone through in the user\u0026apos;s mailbox to return a page of message-type items. It\u0026apos;s therefore possible that even in the initial response, the $skip value is larger than the page size. For more information, see Paging Microsoft Graph data in your app. Currently, this operation returns message bodies in only HTML format. There are two scenarios where an app can get messages in another user\u0026apos;s mail folder:"
|
||||
}
|
||||
],
|
||||
"runtimes": [
|
||||
|
||||
+284
-456
@@ -10,11 +10,8 @@ paths:
|
||||
get:
|
||||
tags:
|
||||
- me.message
|
||||
summary: Get open extension
|
||||
description: Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance.
|
||||
externalDocs:
|
||||
description: Find more info here
|
||||
url: https://learn.microsoft.com/graph/api/opentypeextension-get?view=graph-rest-1.0
|
||||
summary: List messages
|
||||
description: 'Get the messages in the signed-in user''s mailbox (including the Deleted Items and Clutter folders). Depending on the page size and mailbox data, getting messages from a mailbox can incur multiple requests. The default page size is 10 messages. Use $top to customize the page size, within the range of 1 and 1000. To improve the operation response time, use $select to specify the exact properties you need; see example 1 below. Fine-tune the values for $select and $top, especially when you must use a larger page size, as returning a page with hundreds of messages each with a full response payload may trigger the gateway timeout (HTTP 504). To get the next page of messages, simply apply the entire URL returned in @odata.nextLink to the next get-messages request. This URL includes any query parameters you may have specified in the initial request. Do not try to extract the $skip value from the @odata.nextLink URL to manipulate responses. This API uses the $skip value to keep count of all the items it has gone through in the user''s mailbox to return a page of message-type items. It''s therefore possible that even in the initial response, the $skip value is larger than the page size. For more information, see Paging Microsoft Graph data in your app. Currently, this operation returns message bodies in only HTML format. There are two scenarios where an app can get messages in another user''s mail folder:'
|
||||
operationId: me_ListMessages
|
||||
parameters:
|
||||
- name: includeHiddenMessages
|
||||
@@ -38,69 +35,6 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- id
|
||||
- id desc
|
||||
- categories
|
||||
- categories desc
|
||||
- changeKey
|
||||
- changeKey desc
|
||||
- createdDateTime
|
||||
- createdDateTime desc
|
||||
- lastModifiedDateTime
|
||||
- lastModifiedDateTime desc
|
||||
- bccRecipients
|
||||
- bccRecipients desc
|
||||
- body
|
||||
- body desc
|
||||
- bodyPreview
|
||||
- bodyPreview desc
|
||||
- ccRecipients
|
||||
- ccRecipients desc
|
||||
- conversationId
|
||||
- conversationId desc
|
||||
- conversationIndex
|
||||
- conversationIndex desc
|
||||
- flag
|
||||
- flag desc
|
||||
- from
|
||||
- from desc
|
||||
- hasAttachments
|
||||
- hasAttachments desc
|
||||
- importance
|
||||
- importance desc
|
||||
- inferenceClassification
|
||||
- inferenceClassification desc
|
||||
- internetMessageHeaders
|
||||
- internetMessageHeaders desc
|
||||
- internetMessageId
|
||||
- internetMessageId desc
|
||||
- isDeliveryReceiptRequested
|
||||
- isDeliveryReceiptRequested desc
|
||||
- isDraft
|
||||
- isDraft desc
|
||||
- isRead
|
||||
- isRead desc
|
||||
- isReadReceiptRequested
|
||||
- isReadReceiptRequested desc
|
||||
- parentFolderId
|
||||
- parentFolderId desc
|
||||
- receivedDateTime
|
||||
- receivedDateTime desc
|
||||
- replyTo
|
||||
- replyTo desc
|
||||
- sender
|
||||
- sender desc
|
||||
- sentDateTime
|
||||
- sentDateTime desc
|
||||
- subject
|
||||
- subject desc
|
||||
- toRecipients
|
||||
- toRecipients desc
|
||||
- uniqueBody
|
||||
- uniqueBody desc
|
||||
- webLink
|
||||
- webLink desc
|
||||
type: string
|
||||
- name: $select
|
||||
in: query
|
||||
@@ -111,42 +45,6 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- id
|
||||
- categories
|
||||
- changeKey
|
||||
- createdDateTime
|
||||
- lastModifiedDateTime
|
||||
- bccRecipients
|
||||
- body
|
||||
- bodyPreview
|
||||
- ccRecipients
|
||||
- conversationId
|
||||
- conversationIndex
|
||||
- flag
|
||||
- from
|
||||
- hasAttachments
|
||||
- importance
|
||||
- inferenceClassification
|
||||
- internetMessageHeaders
|
||||
- internetMessageId
|
||||
- isDeliveryReceiptRequested
|
||||
- isDraft
|
||||
- isRead
|
||||
- isReadReceiptRequested
|
||||
- parentFolderId
|
||||
- receivedDateTime
|
||||
- replyTo
|
||||
- sender
|
||||
- sentDateTime
|
||||
- subject
|
||||
- toRecipients
|
||||
- uniqueBody
|
||||
- webLink
|
||||
- attachments
|
||||
- extensions
|
||||
- multiValueExtendedProperties
|
||||
- singleValueExtendedProperties
|
||||
type: string
|
||||
- name: $expand
|
||||
in: query
|
||||
@@ -157,18 +55,10 @@ paths:
|
||||
uniqueItems: true
|
||||
type: array
|
||||
items:
|
||||
enum:
|
||||
- '*'
|
||||
- attachments
|
||||
- extensions
|
||||
- multiValueExtendedProperties
|
||||
- singleValueExtendedProperties
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
2XX:
|
||||
$ref: '#/components/responses/microsoft.graph.messageCollectionResponse'
|
||||
default:
|
||||
$ref: '#/components/responses/error'
|
||||
x-ms-pageable:
|
||||
nextLinkName: '@odata.nextLink'
|
||||
operationName: listMore
|
||||
@@ -176,224 +66,194 @@ paths:
|
||||
post:
|
||||
tags:
|
||||
- me.message
|
||||
summary: Create open extension
|
||||
description: 'Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource. You can create an open extension in a resource instance and store custom data to it all in the same operation, except for specific resources. The table in the Permissions section lists the resources that support open extensions.'
|
||||
externalDocs:
|
||||
description: Find more info here
|
||||
url: https://learn.microsoft.com/graph/api/opentypeextension-post-opentypeextension?view=graph-rest-1.0
|
||||
summary: Create message
|
||||
description: "Create a draft of a new message in either JSON or MIME format. When using JSON format, you can:\n- Include an attachment to the message.\n- Update the draft later to add content to the body or change other message properties. When using MIME format:\n- Provide the applicable Internet message headers and the MIME content, all encoded in base64 format in the request body.\n- /* Add any attachments and S/MIME properties to the MIME content. By default, this operation saves the draft in the Drafts folder. Send the draft message in a subsequent operation. Alternatively, send a new message in a single operation, or create a draft to forward, reply and reply-all to an existing message."
|
||||
operationId: me_CreateMessages
|
||||
requestBody:
|
||||
description: New navigation property
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.outlookItem'
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
required: true
|
||||
responses:
|
||||
'201':
|
||||
2XX:
|
||||
description: Created navigation property.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
default:
|
||||
$ref: '#/components/responses/error'
|
||||
components:
|
||||
schemas:
|
||||
microsoft.graph.message:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
|
||||
- title: message
|
||||
type: object
|
||||
properties:
|
||||
bccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Bcc: recipients for the message.'
|
||||
body:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
|
||||
bodyPreview:
|
||||
type: string
|
||||
description: The first 255 characters of the message body. It is in text format.
|
||||
nullable: true
|
||||
ccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Cc: recipients for the message.'
|
||||
conversationId:
|
||||
type: string
|
||||
description: The ID of the conversation the email belongs to.
|
||||
nullable: true
|
||||
conversationIndex:
|
||||
type: string
|
||||
description: Indicates the position of the message within the conversation.
|
||||
format: base64url
|
||||
nullable: true
|
||||
flag:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.followupFlag'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The flag value that indicates the status, start date, due date, or completion date for the message.'
|
||||
from:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.'
|
||||
hasAttachments:
|
||||
type: boolean
|
||||
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src=''cid:[email protected]''>.'
|
||||
nullable: true
|
||||
importance:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.importance'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The importance of the message. The possible values are: low, normal, and high.'
|
||||
inferenceClassification:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.'
|
||||
internetMessageHeaders:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
|
||||
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
|
||||
internetMessageId:
|
||||
type: string
|
||||
description: The message ID in the format specified by RFC2822.
|
||||
nullable: true
|
||||
isDeliveryReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
isDraft:
|
||||
type: boolean
|
||||
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
|
||||
nullable: true
|
||||
isRead:
|
||||
type: boolean
|
||||
description: Indicates whether the message has been read.
|
||||
nullable: true
|
||||
isReadReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
parentFolderId:
|
||||
type: string
|
||||
description: The unique identifier for the message's parent mailFolder.
|
||||
nullable: true
|
||||
receivedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
replyTo:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: The email addresses to use when replying.
|
||||
sender:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.'
|
||||
sentDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
subject:
|
||||
type: string
|
||||
description: The subject of the message.
|
||||
nullable: true
|
||||
toRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The To: recipients for the message.'
|
||||
uniqueBody:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format.
|
||||
webLink:
|
||||
type: string
|
||||
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.'
|
||||
nullable: true
|
||||
attachments:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.attachment'
|
||||
description: The fileAttachment and itemAttachment attachments for the message.
|
||||
extensions:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.extension'
|
||||
description: The collection of open extensions defined for the message. Nullable.
|
||||
multiValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
|
||||
description: The collection of multi-value extended properties defined for the message. Nullable.
|
||||
singleValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
|
||||
description: The collection of single-value extended properties defined for the message. Nullable.
|
||||
microsoft.graph.outlookItem:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: outlookItem
|
||||
type: object
|
||||
properties:
|
||||
categories:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The categories associated with the item
|
||||
changeKey:
|
||||
type: string
|
||||
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
|
||||
nullable: true
|
||||
createdDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
title: message
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
categories:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: The categories associated with the item
|
||||
changeKey:
|
||||
type: string
|
||||
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
|
||||
nullable: true
|
||||
createdDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
bccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Bcc: recipients for the message.'
|
||||
body:
|
||||
$ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
bodyPreview:
|
||||
type: string
|
||||
description: The first 255 characters of the message body. It is in text format.
|
||||
nullable: true
|
||||
ccRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The Cc: recipients for the message.'
|
||||
conversationId:
|
||||
type: string
|
||||
description: The ID of the conversation the email belongs to.
|
||||
nullable: true
|
||||
conversationIndex:
|
||||
type: string
|
||||
description: Indicates the position of the message within the conversation.
|
||||
format: base64url
|
||||
nullable: true
|
||||
flag:
|
||||
$ref: '#/components/schemas/microsoft.graph.followupFlag'
|
||||
from:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
hasAttachments:
|
||||
type: boolean
|
||||
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src=''cid:[email protected]''>.'
|
||||
nullable: true
|
||||
importance:
|
||||
$ref: '#/components/schemas/microsoft.graph.importance'
|
||||
inferenceClassification:
|
||||
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
|
||||
internetMessageHeaders:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
|
||||
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
|
||||
internetMessageId:
|
||||
type: string
|
||||
description: The message ID in the format specified by RFC2822.
|
||||
nullable: true
|
||||
isDeliveryReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
isDraft:
|
||||
type: boolean
|
||||
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
|
||||
nullable: true
|
||||
isRead:
|
||||
type: boolean
|
||||
description: Indicates whether the message has been read.
|
||||
nullable: true
|
||||
isReadReceiptRequested:
|
||||
type: boolean
|
||||
description: Indicates whether a read receipt is requested for the message.
|
||||
nullable: true
|
||||
parentFolderId:
|
||||
type: string
|
||||
description: The unique identifier for the message's parent mailFolder.
|
||||
nullable: true
|
||||
receivedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
replyTo:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: The email addresses to use when replying.
|
||||
sender:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
sentDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
|
||||
format: date-time
|
||||
nullable: true
|
||||
subject:
|
||||
type: string
|
||||
description: The subject of the message.
|
||||
nullable: true
|
||||
toRecipients:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.recipient'
|
||||
description: 'The To: recipients for the message.'
|
||||
uniqueBody:
|
||||
$ref: '#/components/schemas/microsoft.graph.itemBody'
|
||||
webLink:
|
||||
type: string
|
||||
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.'
|
||||
nullable: true
|
||||
attachments:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.attachment'
|
||||
description: The fileAttachment and itemAttachment attachments for the message.
|
||||
extensions:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.extension'
|
||||
description: The collection of open extensions defined for the message. Nullable.
|
||||
multiValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
|
||||
description: The collection of multi-value extended properties defined for the message. Nullable.
|
||||
singleValueExtendedProperties:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
|
||||
description: The collection of single-value extended properties defined for the message. Nullable.
|
||||
microsoft.graph.recipient:
|
||||
title: recipient
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
emailAddress:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The recipient's email address.
|
||||
$ref: '#/components/schemas/microsoft.graph.emailAddress'
|
||||
'@odata.type':
|
||||
type: string
|
||||
discriminator:
|
||||
propertyName: '@odata.type'
|
||||
microsoft.graph.itemBody:
|
||||
title: itemBody
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
content:
|
||||
@@ -401,39 +261,27 @@ components:
|
||||
description: The content of the item.
|
||||
nullable: true
|
||||
contentType:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.bodyType'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The type of the content. Possible values are text and html.
|
||||
$ref: '#/components/schemas/microsoft.graph.bodyType'
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
|
||||
microsoft.graph.followupFlag:
|
||||
title: followupFlag
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
completedDateTime:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The date and time that the follow-up was finished.
|
||||
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
dueDateTime:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The date and time that the follow-up is to be finished. Note: To set the due date, you must also specify the startDateTime; otherwise, you get a 400 Bad Request response.'
|
||||
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
flagStatus:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: 'The status for follow-up for an item. Possible values are notFlagged, complete, and flagged.'
|
||||
$ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
|
||||
startDateTime:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
- type: object
|
||||
nullable: true
|
||||
description: The date and time that the follow-up is to begin.
|
||||
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: 'The flag value that indicates the status, start date, due date, or completion date for the message.'
|
||||
microsoft.graph.importance:
|
||||
title: importance
|
||||
enum:
|
||||
@@ -441,14 +289,18 @@ components:
|
||||
- normal
|
||||
- high
|
||||
type: string
|
||||
description: 'The importance of the message. The possible values are: low, normal, and high.'
|
||||
microsoft.graph.inferenceClassificationType:
|
||||
title: inferenceClassificationType
|
||||
enum:
|
||||
- focused
|
||||
- other
|
||||
type: string
|
||||
description: 'The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.'
|
||||
microsoft.graph.internetMessageHeader:
|
||||
title: internetMessageHeader
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
@@ -459,89 +311,104 @@ components:
|
||||
type: string
|
||||
description: The value in a key-value pair.
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
microsoft.graph.attachment:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: attachment
|
||||
type: object
|
||||
properties:
|
||||
contentType:
|
||||
type: string
|
||||
description: The MIME type.
|
||||
nullable: true
|
||||
isInline:
|
||||
type: boolean
|
||||
description: 'true if the attachment is an inline attachment; otherwise, false.'
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
name:
|
||||
type: string
|
||||
description: The attachment's file name.
|
||||
nullable: true
|
||||
size:
|
||||
maximum: 2147483647
|
||||
minimum: -2147483648
|
||||
type: number
|
||||
description: The length of the attachment in bytes.
|
||||
format: int32
|
||||
microsoft.graph.extension:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: extension
|
||||
type: object
|
||||
microsoft.graph.multiValueLegacyExtendedProperty:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: multiValueLegacyExtendedProperty
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A collection of property values.
|
||||
microsoft.graph.singleValueLegacyExtendedProperty:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/microsoft.graph.entity'
|
||||
- title: singleValueLegacyExtendedProperty
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
description: A property value.
|
||||
nullable: true
|
||||
microsoft.graph.messageCollectionResponse:
|
||||
title: Collection of message
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
|
||||
- type: object
|
||||
properties:
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
microsoft.graph.ODataErrors.ODataError:
|
||||
title: attachment
|
||||
required:
|
||||
- error
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
|
||||
microsoft.graph.entity:
|
||||
title: entity
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
contentType:
|
||||
type: string
|
||||
description: The MIME type.
|
||||
nullable: true
|
||||
isInline:
|
||||
type: boolean
|
||||
description: 'true if the attachment is an inline attachment; otherwise, false.'
|
||||
lastModifiedDateTime:
|
||||
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
|
||||
type: string
|
||||
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
|
||||
format: date-time
|
||||
nullable: true
|
||||
name:
|
||||
type: string
|
||||
description: The attachment's file name.
|
||||
nullable: true
|
||||
size:
|
||||
maximum: 2147483647
|
||||
minimum: -2147483648
|
||||
type: number
|
||||
description: The length of the attachment in bytes.
|
||||
format: int32
|
||||
microsoft.graph.extension:
|
||||
title: extension
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
microsoft.graph.multiValueLegacyExtendedProperty:
|
||||
title: multiValueLegacyExtendedProperty
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
nullable: true
|
||||
description: A collection of property values.
|
||||
microsoft.graph.singleValueLegacyExtendedProperty:
|
||||
title: singleValueLegacyExtendedProperty
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for an entity. Read-only.
|
||||
'@odata.type':
|
||||
type: string
|
||||
value:
|
||||
type: string
|
||||
description: A property value.
|
||||
nullable: true
|
||||
microsoft.graph.messageCollectionResponse:
|
||||
title: Base collection pagination and count responses
|
||||
type: object
|
||||
properties:
|
||||
'@odata.count':
|
||||
type: integer
|
||||
format: int64
|
||||
nullable: true
|
||||
'@odata.nextLink':
|
||||
type: string
|
||||
nullable: true
|
||||
value:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.message'
|
||||
microsoft.graph.emailAddress:
|
||||
title: emailAddress
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
address:
|
||||
@@ -552,14 +419,20 @@ components:
|
||||
type: string
|
||||
description: The display name of the person or entity.
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: The recipient's email address.
|
||||
microsoft.graph.bodyType:
|
||||
title: bodyType
|
||||
enum:
|
||||
- text
|
||||
- html
|
||||
type: string
|
||||
description: The type of the content. Possible values are text and html.
|
||||
microsoft.graph.dateTimeTimeZone:
|
||||
title: dateTimeTimeZone
|
||||
required:
|
||||
- '@odata.type'
|
||||
type: object
|
||||
properties:
|
||||
dateTime:
|
||||
@@ -569,6 +442,9 @@ components:
|
||||
type: string
|
||||
description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.'
|
||||
nullable: true
|
||||
'@odata.type':
|
||||
type: string
|
||||
description: The date and time that the follow-up was finished.
|
||||
microsoft.graph.followupFlagStatus:
|
||||
title: followupFlagStatus
|
||||
enum:
|
||||
@@ -576,49 +452,7 @@ components:
|
||||
- complete
|
||||
- flagged
|
||||
type: string
|
||||
BaseCollectionPaginationCountResponse:
|
||||
title: Base collection pagination and count responses
|
||||
type: object
|
||||
properties:
|
||||
'@odata.nextLink':
|
||||
type: string
|
||||
nullable: true
|
||||
microsoft.graph.ODataErrors.MainError:
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
x-ms-primary-error-message: true
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
details:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
|
||||
innerError:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
|
||||
microsoft.graph.ODataErrors.ErrorDetails:
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
target:
|
||||
type: string
|
||||
nullable: true
|
||||
microsoft.graph.ODataErrors.InnerError:
|
||||
type: object
|
||||
description: The structure of this object is service-specific
|
||||
description: 'The status for follow-up for an item. Possible values are notFlagged, complete, and flagged.'
|
||||
responses:
|
||||
microsoft.graph.messageCollectionResponse:
|
||||
description: Retrieved collection
|
||||
@@ -626,12 +460,6 @@ components:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.messageCollectionResponse'
|
||||
error:
|
||||
description: error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
|
||||
parameters:
|
||||
top:
|
||||
name: $top
|
||||
|
||||
@@ -13,7 +13,7 @@ cd dotnet/samples/Concepts/Resources/Plugins/CopilotAgentPlugins
|
||||
Microsoft Graph calendar events listing API for the current user.
|
||||
|
||||
```shell
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/calendar/events#GET -o CopilotAgentPlugins/CalendarPlugin
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/calendar/events#GET -o CopilotAgentPlugins/CalendarPlugin --pn Calendar
|
||||
```
|
||||
|
||||
### Contacts plugin
|
||||
@@ -21,7 +21,7 @@ kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/c
|
||||
Microsoft Graph contacts listing API for the current user.
|
||||
|
||||
```shell
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/contacts#GET -o CopilotAgentPlugins/ContactsPlugin
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/contacts#GET -o CopilotAgentPlugins/ContactsPlugin --pn Contacts
|
||||
```
|
||||
|
||||
### DriveItem plugin
|
||||
@@ -29,7 +29,7 @@ kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/c
|
||||
Microsoft Graph download a drive item for the current user.
|
||||
|
||||
```shell
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /drive/root/children/{driveItem-id}/content#GET -o CopilotAgentPlugins/DriveItemPlugin
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /drives/{drive-id}/items/{driveItem-id}/content#GET -o CopilotAgentPlugins/DriveItemPlugin --pn DriveItem
|
||||
```
|
||||
|
||||
### Messages plugin
|
||||
@@ -37,7 +37,7 @@ kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /driv
|
||||
Microsoft Graph list message and create a draft message for the current user.
|
||||
|
||||
```shell
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/messages#GET -i /me/messages#POST -o CopilotAgentPlugins/MessagesPlugin
|
||||
kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/messages#GET -i /me/messages#POST -o CopilotAgentPlugins/MessagesPlugin --pn Messages
|
||||
```
|
||||
|
||||
### Astronomy plugin
|
||||
@@ -45,7 +45,7 @@ kiota plugin add -t APIPlugin -d https://aka.ms/graph/v1.0/openapi.yaml -i /me/m
|
||||
NASA Astronomy Picture of the day endpoint mixed with Microsoft Graph messages to demonstrate a plugin with multiple APIs.
|
||||
|
||||
```shell
|
||||
kiota plugin add -t APIPlugin -d ../OpenAPI/NASA/apod.yaml -i /apod#GET -o CopilotAgentPlugins/AstronomyPlugin
|
||||
kiota plugin add -t APIPlugin -d ./OpenAPI/NASA/apod.yaml -i /apod#GET -o CopilotAgentPlugins/AstronomyPlugin --pn Astronomy
|
||||
cp CopilotAgentPlugins/MessagesPlugin/messages-openapi.yml CopilotAgentPlugins/AstronomyPlugin
|
||||
```
|
||||
|
||||
@@ -55,10 +55,10 @@ Add this snippet under runtimes
|
||||
{
|
||||
"type": "OpenApi",
|
||||
"auth": {
|
||||
"type": "None"
|
||||
"type": "None"
|
||||
},
|
||||
"spec": {
|
||||
"url": "messages-openapi.yml"
|
||||
"url": "messages-openapi.yml"
|
||||
},
|
||||
"run_for_functions": ["me_ListMessages"]
|
||||
}
|
||||
@@ -69,6 +69,6 @@ And this snippet under functions
|
||||
```json
|
||||
{
|
||||
"name": "me_ListMessages",
|
||||
"description": "Get an open extension (openTypeExtension object) identified by name or fully qualified name. The table in the Permissions section lists the resources that support open extensions. The following table lists the three scenarios where you can get an open extension from a supported resource instance."
|
||||
"description": "Get the messages in the signed-in user\u0026apos;s mailbox (including the Deleted Items and Clutter folders). Depending on the page size and mailbox data, getting messages from a mailbox can incur multiple requests. The default page size is 10 messages. Use $top to customize the page size, within the range of 1 and 1000. To improve the operation response time, use $select to specify the exact properties you need; see example 1 below. Fine-tune the values for $select and $top, especially when you must use a larger page size, as returning a page with hundreds of messages each with a full response payload may trigger the gateway timeout (HTTP 504). To get the next page of messages, simply apply the entire URL returned in @odata.nextLink to the next get-messages request. This URL includes any query parameters you may have specified in the initial request. Do not try to extract the $skip value from the @odata.nextLink URL to manipulate responses. This API uses the $skip value to keep count of all the items it has gone through in the user\u0026apos;s mailbox to return a page of message-type items. It\u0026apos;s therefore possible that even in the initial response, the $skip value is larger than the page size. For more information, see Paging Microsoft Graph data in your app. Currently, this operation returns message bodies in only HTML format. There are two scenarios where an app can get messages in another user\u0026apos;s mail folder:"
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user