accessReviewHistoryInstance resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a recurrence of an accessReviewHistoryDefinition object. A history definition that doesn't recur has exactly one instance.

Every accessReviewHistoryInstance along with its associated accessReviewHistoryDefinition contain the properties reviewHistoryPeriodStartDateTime, reviewHistoryPeriodEndDateTime, decisions, scheduleSettings, and scopes. These properties are used when scheduling recurrences and selecting review data and can be modified. Each accessReviewHistoryInstance object and data is only available for 30 days. Once an accessReviewHistoryInstance status has been moved to done, a link can be generated to retrieve the instance's data by calling generateDownloadUri.

Methods

Method	Return type	Description
List accessReviewHistoryInstances	accessReviewHistoryInstance collection	Retrieve a list of the accessReviewHistoryInstance objects and their properties.
generateDownloadUri	accessReviewHistoryDefinition	Generates a URI that can be used to retrieve the instance's review history data.

Properties

Property	Type	Description
downloadUri	String	Uri that can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required.
expirationDateTime	DateTimeOffset	Timestamp when this instance and associated data expires and the history is deleted. Required.
fulfilledDateTime	DateTimeOffset	Timestamp when all of the available data for this instance was collected. This will be set after this instance's status is set to done. Required.
id	String	The assigned unique identifier of an access review history instance. Read-only. Required.
reviewHistoryPeriodEndDateTime	DateTimeOffset	Timestamp, reviews ending on or before this date are in the fetched history data.
reviewHistoryPeriodStartDateTime	DateTimeOffset	Timestamp, reviews starting on or after this date are in the fetched history data.
runDateTime	DateTimeOffset	Timestamp when the instance's history data is scheduled to be generated.
status	accessReviewHistoryStatus	Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue. Once the status has been marked as done, a link can be generated to retrieve the instance's data by calling generateDownloadUri method.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.accessReviewHistoryInstance",
  "id": "String (identifier)",
  "reviewHistoryPeriodStartDateTime": "String (timestamp)",
  "reviewHistoryPeriodEndDateTime": "String (timestamp)",
  "status": "String",
  "runDateTime": "String (timestamp)",
  "fulfilledDateTime": "String (timestamp)",
  "downloadUri": "String",
  "expirationDateTime": "String (timestamp)"
}