Milestones

Endpoints for working with Milestones. See Introduction to Milestones Endpoints for more information.

Milestone

A milestone representing a point in the life cycle of a document, presentation, or spreadsheet and can be used to mark progress or completion of a particular phase.

Properties

Name	Type	Description	Restrictions
created	Action	The creation action of the milestone	required
id	string	Identifier of a milestone.	required
remarks	string	The remarks associated with the milestone	required
resource	MilestoneResourceRef	Represents a reference to the resource associated with a milestone. The type property will determine which of the other properties is set.	required
title	string	The title of the milestone	required

Example

{
  "created": {
    "dateTime": "2019-10-28T15:03:27Z",
    "user": {
      "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
    }
  },
  "id": "bWlsZXN0b25lLXYxOjQzODU0ZmU0NmU2MDQ4M2E4MTU0ZjdmMGI3MWI5YjllOjJjNjQzOGFiNDU1NTNkZTY",
  "remarks": "Baseline captured before the Q1 review cycle",
  "resource": {
    "document": {
      "document": "16b1f641613847469b7aa1ca29af40b1",
      "revision": "2c6438ab45553de6"
    },
    "presentation": {
      "presentation": "2e24cb107c8d46a78bd6574b07b4ee2c",
      "revision": "2c6438ab4541de6d"
    },
    "spreadsheet": {
      "revision": "2c6438ab4541de6d",
      "spreadsheet": "7a5e271acf1d49d480a6fbabc394a0fa"
    },
    "type": "document"
  },
  "title": "Start of Q1"
}

MilestoneCreation

Parameters used to create a milestone in a document, presentation, or spreadsheet. The created milestone will be associated with the latest revision at the point of milestone creation.

Properties

Name	Type	Description	Restrictions
document	string	The unique identifier of the document being referred to
presentation	string	The unique identifier of the presentation being referred to
remarks	string	The remarks associated with the milestone
spreadsheet	string	The unique identifier of the spreadsheet being referred to
title	string	The title of the milestone	required, Maximum length: 200, Minimum length: 1
type	MilestoneResourceType	The type of content associated with a milestone.	required

Example

{
  "document": "16b1f641613847469b7aa1ca29af40b1",
  "presentation": "16b1f641613847469b7aa1ca29af40b1",
  "remarks": "Baseline captured before the Q1 review cycle",
  "spreadsheet": "16b1f641613847469b7aa1ca29af40b1",
  "title": "Start of Q1",
  "type": "document"
}

MilestoneId

The unique identifier of the milestone

Properties

Name	Type	Description	Restrictions
anonymous	string	The unique identifier of the milestone	Minimum length: 1

Example

"WW91IGZvdW5kIG1d5kIGSd2lIQ"

MilestoneListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Milestone 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	[Milestone]	The list of Milestone objects returned by the request.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2019-10-28T15:03:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "id": "bWlsZXN0b25lLXYxOjQzODU0ZmU0NmU2MDQ4M2E4MTU0ZjdmMGI3MWI5YjllOjJjNjQzOGFiNDU1NTNkZTY",
      "remarks": "Baseline captured before the Q1 review cycle",
      "resource": {
        "document": {
          "document": "16b1f641613847469b7aa1ca29af40b1",
          "revision": "2c6438ab45553de6"
        },
        "type": "document"
      },
      "title": "Start of Q1"
    }
  ]
}

MilestoneResourceRef

Represents a reference to the resource associated with a milestone. The type property will determine which of the other properties is set.

Properties

Name	Type	Description	Restrictions
document	DocumentRef¦null	The reference to the document for document type milestone
presentation	PresentationRef¦null	The reference to the presentation for presentation type milestone
spreadsheet	SpreadsheetRef¦null	The reference to the spreadsheet for spreadsheet type milestone
type	MilestoneResourceType	The type of content associated with a milestone.	required

Example

{
  "document": {
    "document": "16b1f641613847469b7aa1ca29af40b1",
    "revision": "2c6438ab45553de6"
  },
  "presentation": {
    "presentation": "2e24cb107c8d46a78bd6574b07b4ee2c",
    "revision": "2c6438ab4541de6d"
  },
  "spreadsheet": {
    "revision": "2c6438ab4541de6d",
    "spreadsheet": "7a5e271acf1d49d480a6fbabc394a0fa"
  },
  "type": "document"
}

MilestoneResourceType

The type of content associated with a milestone.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of content associated with a milestone.

Enumerated Values

Property	Value
anonymous	document
anonymous	presentation
anonymous	spreadsheet

Example

"document"