POST api/WorkflowFieldValues/BulkArchive

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Filter	WorkflowFieldFilter	None.
Archive	boolean	None.
ArchiveById	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Filter": {
    "IsFinalised": true,
    "IsTriggered": true,
    "PassedPaymentGateway": true,
    "NotSubmittedPaymentGateway": true,
    "EntityWorkflowIds": [
      "9ea27eb8-2fe0-4af1-892e-31410e1414aa",
      "ad60a8af-1c81-43d3-a01c-f846a8e952be"
    ],
    "WorkflowInstanceOwner": "sample string 5",
    "WorkflowInstanceOwnerId": "sample string 6",
    "AssignedToUserId": "sample string 7",
    "PageNumber": 8,
    "PageSize": 9,
    "StartDate": "2025-11-05T20:22:59.6281291+11:00",
    "EndDate": "2025-11-05T20:22:59.6281291+11:00",
    "EntityId": "sample string 12",
    "IsArchived": true
  },
  "Archive": true,
  "ArchiveById": "sample string 2"
}

application/xml, text/xml

Sample:

<BulkArchiveModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkflowAPI.Models">
  <Archive>true</Archive>
  <ArchiveById>sample string 2</ArchiveById>
  <Filter>
    <AssignedToUserId>sample string 7</AssignedToUserId>
    <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-11-05T09:22:59.6281291Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>660</d3p1:OffsetMinutes>
    </EndDate>
    <EntityId>sample string 12</EntityId>
    <EntityWorkflowIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>9ea27eb8-2fe0-4af1-892e-31410e1414aa</d3p1:guid>
      <d3p1:guid>ad60a8af-1c81-43d3-a01c-f846a8e952be</d3p1:guid>
    </EntityWorkflowIds>
    <IsArchived>true</IsArchived>
    <IsFinalised>true</IsFinalised>
    <IsTriggered>true</IsTriggered>
    <NotSubmittedPaymentGateway>true</NotSubmittedPaymentGateway>
    <PageNumber>8</PageNumber>
    <PageSize>9</PageSize>
    <PassedPaymentGateway>true</PassedPaymentGateway>
    <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-11-05T09:22:59.6281291Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>660</d3p1:OffsetMinutes>
    </StartDate>
    <WorkflowInstanceOwner>sample string 5</WorkflowInstanceOwner>
    <WorkflowInstanceOwnerId>sample string 6</WorkflowInstanceOwnerId>
  </Filter>
</BulkArchiveModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.