Operations

Use these endpoints to manage operations, such as to check their status.

CopyFileListResult

Returns a JSON object with data and @nextLink properties. data contains a list of CopyFileResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[CopyFileResult]	Details about the result of copying a file	read-only

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "kind": "Document"
    }
  ]
}

CopyFileResult

Details about the result of copying a file

Properties

Name	Type	Description	Restrictions
container	string	The unique identifier of the container that houses the file, such as a folder. If the container is the root folder, this will be an empty string.
id	string	The unique identifier of the file	read-only
kind	string	Kind of the file

Enumerated Values

Property	Value
kind	Document
kind	Spreadsheet
kind	Presentation
kind	Folder

Example

{
  "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "kind": "Document"
}

DestinationLinkSourceConversionResult

A result of a destination link source conversion operation.

Properties

Name	Type	Description	Restrictions
anchor	string¦null	The unique identifier for the anchor.
destinationLink	string¦null	The unique identifier for the destination link.
type	DestinationLinkSourceConversionResultType	The type of the destination link source conversion result.	required

Example

{
  "anchor": "WA5SVkJWXOy5MbSHX25Qf9BVz5xTvLfJadt5eXzqTxLT4o2Lo1ceQHmLbSppCdBhQUFBSE",
  "type": "anchor"
}

DestinationLinkSourceConversionResultType

The type of the destination link source conversion result.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the destination link source conversion result.

Enumerated Values

Property	Value
anonymous	anchor
anonymous	destinationLink

Example

"anchor"

DestinationLinkSourceConversionResultListResult

Returns a JSON object with data and @nextLink properties. data contains a list of DestinationLinkSourceConversionResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[DestinationLinkSourceConversionResult]	The current page of destination link source conversion results
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "anchor": "WA5SVkJWXOy5MbSHX25Qf9BVz5xTvLfJadt5eXzqTxLT4o2Lo1ceQHmLbSppCdBhQUFBSE",
      "type": "anchor"
    },
    {
      "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "destinationLink"
    }
  ],
  "revision": "24601abc"
}

ImageUploadResult

A reference to a resource that was created by an image upload.

Properties

Name	Type	Description	Restrictions
image	string¦null	The ID of the image that was created.
type	string	The type of resource created from an image upload.	required

Enumerated Values

Property	Value
type	image

Example

{
  "image": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "image"
}

ImageUploadResultCollection

A collection of created results from an image upload. When there are no additional results before the current collection, the previous property will be null. When there are no additional results after the current collection, the next property will be null.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[ImageUploadResult]	The current page of data.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "image": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "image"
    }
  ]
}

ImportFileListResult

Returns a JSON object with data and @nextLink properties. data contains a list of ImportFileResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[ImportFileResult]	Details about the result of importing a file	read-only

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "kind": "Document"
    }
  ]
}

ImportFileResult

Details about the result of importing a file

Properties

Name	Type	Description	Restrictions
container	string	The unique identifier of the container that houses the file, such as a folder. If the container is the root folder, this will be an empty string.
id	string	The unique identifier of the file	read-only
kind	string	Kind of the file

Enumerated Values

Property	Value
kind	Document
kind	Spreadsheet
kind	Presentation
kind	Folder
kind	SupportingDocument

Example

{
  "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "kind": "Document"
}

MilestoneCreationListResult

Returns a JSON object with data and @nextLink properties. data contains a list of MilestoneCreationResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[MilestoneCreationResult]	The current page of data.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "milestone": "string",
      "type": "milestone"
    }
  ]
}

MilestoneCreationResult

A reference to a resource that was created by an operation.

Properties

Name	Type	Description	Restrictions
milestone	string¦null	The ID of the milestone that was created.
type	MilestoneCreationResultType	The type of resource created from a milestone creation	required

Example

{
  "milestone": "string",
  "type": "milestone"
}

MilestoneCreationResultType

The type of resource created from a milestone creation

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of resource created from a milestone creation

Enumerated Values

Property	Value
anonymous	milestone

Example

"milestone"

Operation

Details about the operation, including its ID, status, milestone dates, and the url of the resource upon successful completion of the operation.

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
details	[OperationDetail]¦null	A list of additional details about the operation	read-only
id	string	The unique identifier of the operation	read-only
originalRequest	string(uuid)	This is the Request ID that initiated this async operation. Giving this ID to support can help track issues with your operations.	read-only
resourceUrl	string¦null	The link to the resulting resource(s)	read-only
status	string	The current status of the operation	read-only
updated	Action	When the action was performed, and details about the user who did it	read-only

Enumerated Values

Property	Value
status	acknowledged
status	queued
status	started
status	completed
status	cancelled
status	failed

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "details": [
    {
      "code": "InvalidOrder",
      "message": "Attempted to modify locked cells",
      "target": "name"
    }
  ],
  "id": "128f274395254cf17eda6b3eb3d021b9",
  "originalRequest": "7bee78f7-417b-42bc-ace9-e588c65d19bf",
  "resourceUrl": "string",
  "status": "completed",
  "updated": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  }
}

OperationDetail

An OperationDetail contains extra information about an Operation

Properties

Name	Type	Description	Restrictions
code	string¦null	The error code for specified error details	read-only
message	string¦null	A message describing the detail	read-only
target	string¦null	For failures, this will be the target of the error	read-only

Example

{
  "code": "string",
  "message": "Attempted to modify locked cells",
  "target": "string"
}

PatchDocumentListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchPresentationListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSectionListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSheetListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSlideLayoutListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSlideListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSpreadsheetListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchTablePropertiesListResult

RReturns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

RichTextAnchorCreationResult

A reference to a resource that was created by an operation.

Properties

Name	Type	Description	Restrictions
anchor	string¦null	The ID of the anchor that was created.
type	string	The type of resource created from a rich text anchor creation.	required

Enumerated Values

Property	Value
type	anchor

Example

{
  "anchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "anchor"
}

RichTextAnchorCreationResultCollection

A collection of created results from a rich text anchor creation. When there are no additional results before the current collection, the previous property will be null. When there are no additional results after the current collection, the next property will be null.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[RichTextAnchorCreationResult]	The current page of data.
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "anchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "anchor"
    }
  ],
  "revision": "24601abc"
}

RichTextDuplicationEditResult

A reference to a resource that was created by a rich text duplication edit.

Properties

Name	Type	Description	Restrictions
table	TableId¦null	The unique identifier of the table created by the rich text duplication edit.
type	string	The type of resource created from a rich text duplication edit.

Enumerated Values

Property	Value
type	table

Example

{
  "table": "WA5SVkJWXOy5MbSHX25Qf9BVz5xTvLfJadt5eXzqTxLT4o2Lo1ceQHmLbSppCdBhQUFBSE",
  "type": "table"
}

RichTextDuplicationEditListResult

Returns a JSON object with data and @nextLink properties. data contains a list of RichTextDuplicationEditResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[RichTextDuplicationEditResult]	A reference to a resource that was created by a rich text duplication edit.	read-only
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "table": "WA5SVkJWXOy5MbSHX25Qf9BVz5xTvLfJadt5eXzqTxLT4o2Lo1ceQHmLbSppCdBhQUFBSE",
      "type": "table"
    }
  ],
  "revision": "24601abc"
}

RichTextEditResult

A reference to a resource that was created by a rich text edit.

Properties

Name	Type	Description	Restrictions
richText	RichTextId¦null	The unique identifier of the rich text created by the rich text edit.
table	TableId¦null	The unique identifier of the table created by the rich text edit.
type	string	The type of resource created from a rich text edit.

Enumerated Values

Property	Value
type	table
type	richText

Example

{
  "table": "8610c7b132e944cb9e5c11daf08b1b1c",
  "type": "table"
}

RichTextEditListResult

Returns a JSON object with data and @nextLink properties. data contains a list of RichTextEditResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[RichTextEditResult]	A reference to a resource that was created by a rich text edit.	read-only
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "table": "8610c7b132e944cb9e5c11daf08b1b1c",
      "type": "table"
    }
  ],
  "revision": "24601abc"
}

RichTextLinksEditResult

A reference to a resource that was created by rich text links edit.

Properties

Name	Type	Description	Restrictions
destinationLink	string¦null	The unique identifier of a destination link created by the rich text links edit.
type	string	The type of resource created from a rich text link edit

Enumerated Values

Property	Value
type	destinationLink

Example

{
  "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "destinationLink"
}

RichTextLinksEditListResult

Returns a JSON object with data and @nextLink properties. data contains a list of RichTextLinksEditResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[RichTextLinksEditResult]	A reference to a resource that was created by rich text links edit.	read-only
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "destinationLink"
    },
    {
      "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJASdasdlkfasl",
      "type": "destinationLink"
    }
  ],
  "revision": "24601abc"
}

TableAnchorCreationResult

A reference to a resource that was created by an operation.

Properties

Name	Type	Description	Restrictions
anchor	string¦null	The ID of the anchor that was created.
type	string	The type of resource created from an image upload.	required

Enumerated Values

Property	Value
type	anchor

Example

{
  "anchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "anchor"
}

TableAnchorCreationResultCollection

A collection of created results from a table anchor creation. When there are no additional results before the current collection, the previous property will be null. When there are no additional results after the current collection, the next property will be null.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[TableAnchorCreationResult]	The current page of data.
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "anchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "anchor"
    }
  ],
  "revision": "24601abc"
}

TableEditListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

TableLinksEditListResult

Returns a JSON object with data and @nextLink properties. data contains a list of TextLinksEditResult objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[TableLinksEditResult]	A reference to a resource that was created by an operation.	read-only
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "destinationLink"
    },
    {
      "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJASdasdlkfasl",
      "type": "destinationLink"
    }
  ],
  "revision": "24601abc"
}

TableLinksEditResult

A reference to a resource that was created by an operation.

Properties

Name	Type	Description	Restrictions
destinationLink	string¦null	The unique identifier of a destination link created by the table links edit.
type	string	The type of resource created from a table link edit.	required

Enumerated Values

Property	Value
type	destinationLink

Example

{
  "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "destinationLink"
}

TableReapplyFilterListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}