Show / Hide Table of Contents

Class ListWorkRequestsRequest

Inheritance
object
ListWorkRequestsRequest
Implements
IOciRequest
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.RoverService.Requests
Assembly: OCI.DotNetSDK.Rover.dll
Syntax
public class ListWorkRequestsRequest : IOciRequest
Examples

Click here to see an example of how to use ListWorkRequests request.

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment in which to list resources.

Remarks

Required

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

The maximum number of items to return.

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

The client request ID for tracing.

OperationType

Declaration
[HttpConverter(TargetEnum.Query, "operationType")]
public WorkRequestOperationType? OperationType { get; set; }
Property Value
Type Description
WorkRequestOperationType?

Filter results by the type of the operation associated with the work request.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

ResourceId

Declaration
[HttpConverter(TargetEnum.Query, "resourceId")]
public string ResourceId { get; set; }
Property Value
Type Description
string

Filter work requests by the resource ocid.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListWorkRequestsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListWorkRequestsRequest.SortByEnum?

Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrders? SortOrder { get; set; }
Property Value
Type Description
SortOrders?

The sort order to use, either 'asc' or 'desc'.

Status

Declaration
[HttpConverter(TargetEnum.Query, "status")]
public WorkRequestOperationStatus? Status { get; set; }
Property Value
Type Description
WorkRequestOperationStatus?

Filter results by work request status.

Implements

IOciRequest
In this article
Back to top