POST api/WorkflowFieldValues/Search

Request Information

URI Parameters

None.

Body Parameters

WorkflowFieldFilter
NameDescriptionTypeAdditional information
IsFinalised

boolean

None.

IsTriggered

boolean

None.

PassedPaymentGateway

boolean

None.

EntityWorkflowIds

Collection of globally unique identifier

None.

WorkflowInstanceOwner

string

None.

WorkflowInstanceOwnerId

string

None.

AssignedToUserId

string

None.

PageNumber

integer

None.

PageSize

integer

None.

StartDate

date

None.

EndDate

date

None.

EntityId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "IsFinalised": true,
  "IsTriggered": true,
  "PassedPaymentGateway": true,
  "EntityWorkflowIds": [
    "dfb0800d-6c67-4c27-9740-642636e8620e",
    "a5a3bab9-5b7e-4c74-beb4-dbd6dc8a01d4"
  ],
  "WorkflowInstanceOwner": "sample string 4",
  "WorkflowInstanceOwnerId": "sample string 5",
  "AssignedToUserId": "sample string 6",
  "PageNumber": 7,
  "PageSize": 8,
  "StartDate": "2024-11-29T10:44:54.3304361+11:00",
  "EndDate": "2024-11-29T10:44:54.3304361+11:00",
  "EntityId": "sample string 11"
}

application/xml, text/xml

Sample:
<WorkflowFieldFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkflowAPI.Models">
  <AssignedToUserId>sample string 6</AssignedToUserId>
  <EndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-28T23:44:54.3304361Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
  </EndDate>
  <EntityId>sample string 11</EntityId>
  <EntityWorkflowIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>dfb0800d-6c67-4c27-9740-642636e8620e</d2p1:guid>
    <d2p1:guid>a5a3bab9-5b7e-4c74-beb4-dbd6dc8a01d4</d2p1:guid>
  </EntityWorkflowIds>
  <IsFinalised>true</IsFinalised>
  <IsTriggered>true</IsTriggered>
  <PageNumber>7</PageNumber>
  <PageSize>8</PageSize>
  <PassedPaymentGateway>true</PassedPaymentGateway>
  <StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-28T23:44:54.3304361Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
  </StartDate>
  <WorkflowInstanceOwner>sample string 4</WorkflowInstanceOwner>
  <WorkflowInstanceOwnerId>sample string 5</WorkflowInstanceOwnerId>
</WorkflowFieldFilter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WorkflowFieldFilter'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.