PolicyEvaluationRecord interface
This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to.
Properties
| artifact |
A string which uniquely identifies the target of a policy evaluation. |
| completed |
Time when this policy finished evaluating on this pull request. |
| configuration | Contains all configuration data for the policy which is being evaluated. |
| context | Internal context data of this policy evaluation. |
| evaluation |
Guid which uniquely identifies this evaluation record (one policy running on one pull request). |
| started |
Time when this policy was first evaluated on this pull request. |
| status | Status of the policy (Running, Approved, Failed, etc.) |
Property Details
artifactId
A string which uniquely identifies the target of a policy evaluation.
artifactId: string
Property Value
string
completedDate
Time when this policy finished evaluating on this pull request.
completedDate: Date
Property Value
Date
configuration
Contains all configuration data for the policy which is being evaluated.
configuration: PolicyConfiguration
Property Value
context
Internal context data of this policy evaluation.
context: any
Property Value
any
evaluationId
Guid which uniquely identifies this evaluation record (one policy running on one pull request).
evaluationId: string
Property Value
string
startedDate
Time when this policy was first evaluated on this pull request.
startedDate: Date
Property Value
Date
status
Status of the policy (Running, Approved, Failed, etc.)
status: PolicyEvaluationStatus