Class WorkRequest
The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.
Inherited Members
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class WorkRequestProperties
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }Property Value
| Type | Description |
|---|---|
| string | The OCID of the compartment that contains the work request. |
Errors
Declaration
[JsonProperty(PropertyName = "errors")]
public List<WorkRequestError> Errors { get; set; }Property Value
| Type | Description |
|---|---|
| List<WorkRequestError> | The errors for work request. |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }Property Value
| Type | Description |
|---|---|
| string | The OCID of the work request. |
Remarks
Required
Logs
Declaration
[JsonProperty(PropertyName = "logs")]
public List<WorkRequestLogEntry> Logs { get; set; }Property Value
| Type | Description |
|---|---|
| List<WorkRequestLogEntry> | The logs for work request. |
OperationType
Declaration
[Required(ErrorMessage = "OperationType is required.")]
[JsonProperty(PropertyName = "operationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public WorkRequest.OperationTypeEnum? OperationType { get; set; }Property Value
| Type | Description |
|---|---|
| WorkRequest.OperationTypeEnum? | An enum-like description of the type of work the work request is doing. |
Remarks
Required
PercentComplete
Declaration
[JsonProperty(PropertyName = "percentComplete")]
public float? PercentComplete { get; set; }Property Value
| Type | Description |
|---|---|
| float? | How much progress the operation has made. |
Resources
Declaration
[JsonProperty(PropertyName = "resources")]
public List<WorkRequestResource> Resources { get; set; }Property Value
| Type | Description |
|---|---|
| List<WorkRequestResource> | The resources this work request affects. |
Status
Declaration
[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public WorkRequest.StatusEnum? Status { get; set; }Property Value
| Type | Description |
|---|---|
| WorkRequest.StatusEnum? | The current status of the work request. |
Remarks
Required
TimeAccepted
Declaration
[JsonProperty(PropertyName = "timeAccepted")]
public DateTime? TimeAccepted { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
TimeFinished
Declaration
[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
TimeStarted
Declaration
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |