POST api/WorkflowFieldValues/Commit

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
WorkflowId	globally unique identifier	None.
CurrentStepId	globally unique identifier	None.
UserId	globally unique identifier	None.
CPDId	globally unique identifier	None.
CPDPeriodId	globally unique identifier	None.
InvoiceId	globally unique identifier	None.
CPDReductionId	globally unique identifier	None.
ApplicableFrom	date	None.
ApplicableTo	date	None.
WaitlistEventId	globally unique identifier	None.
WaitlistTicketTypeId	globally unique identifier	None.
CartId	globally unique identifier	None.
ElectionId	globally unique identifier	None.
PropertyId	globally unique identifier	None.
BookingId	globally unique identifier	None.
EntityId	globally unique identifier	None.
EntityType	string	None.
UserFullName	string	None.
WorkflowName	string	None.
CreatedDate	date	None.
CreatedDateTick	integer	None.
CreatedById	globally unique identifier	None.
LastModifiedDate	date	None.
LastModifiedById	globally unique identifier	None.
IsArchived	boolean	None.
CommitStepId	globally unique identifier	None.
Archived	date	None.
ArchivedById	globally unique identifier	None.
AssignedTo	globally unique identifier	None.
AssignedDate	date	None.
PaymentSuccessful	boolean	None.
PaymentGatewayTransactionRef	string	None.
CrossCheckApplicationTypeSuccesful	boolean	None.
PreviousStepIds	Collection of globally unique identifier	None.
Values	Collection of WorkflowValue	None.
SubmitTimes	Collection of WorkflowStepSubmitTime	None.
InitHistory	Collection of FieldValueInitTime	None.
Response	BaseResponseModel	None.
IsFinalised	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "871991a7-bf5b-4812-9fd8-88d1011eb7f2",
  "WorkflowId": "8a80ace0-3d8c-4b6b-94ba-e2d073912c18",
  "CurrentStepId": "57b5026e-a049-4848-8b11-b136406a54dc",
  "UserId": "0d6fb74e-756c-4cc5-986f-9e7460b35b40",
  "CPDId": "e05da5d9-ef6b-4a28-8ad5-a12fcf94cce7",
  "CPDPeriodId": "27acd509-d14c-46d7-9bb0-cdfff478c2d3",
  "InvoiceId": "34773e74-03c3-47ea-9060-58c203655b47",
  "CPDReductionId": "70f90973-6cf8-47d5-9106-2185de41e304",
  "ApplicableFrom": "2025-07-01T17:15:18.7939101+10:00",
  "ApplicableTo": "2025-07-01T17:15:18.7939101+10:00",
  "WaitlistEventId": "c99daea0-b5db-4436-a096-c5664d3b3e3b",
  "WaitlistTicketTypeId": "25111bdb-d47c-404e-b44f-7f2cec938200",
  "CartId": "75cc79a9-0c6d-4600-a7ba-488dfb9e9b3d",
  "ElectionId": "4707a4f0-179c-45b4-a401-7cf9df03fef5",
  "PropertyId": "da42f757-b10f-4962-9b9b-8f714112ff39",
  "BookingId": "bbd9252d-dd5c-4226-a70e-ea26aa30ca22",
  "EntityId": "65da6203-d3b8-4619-95f1-b5235feead5e",
  "EntityType": "sample string 4",
  "UserFullName": "sample string 5",
  "WorkflowName": "sample string 6",
  "CreatedDate": "2025-07-01T17:15:18.7939101+10:00",
  "CreatedDateTick": 8,
  "CreatedById": "dddcc70a-b249-465d-9fff-4db39c626a5a",
  "LastModifiedDate": "2025-07-01T17:15:18.7939101+10:00",
  "LastModifiedById": "44707c73-1033-4104-8950-62ed4ddc883f",
  "IsArchived": true,
  "CommitStepId": "0954c968-851c-4895-88cf-af082f34f687",
  "Archived": "2025-07-01T17:15:18.7939101+10:00",
  "ArchivedById": "f89cf936-a85a-4179-aee7-837019ee545c",
  "AssignedTo": "1ba616da-664f-4c10-bf24-827df381a748",
  "AssignedDate": "2025-07-01T17:15:18.7939101+10:00",
  "PaymentSuccessful": true,
  "PaymentGatewayTransactionRef": "sample string 11",
  "CrossCheckApplicationTypeSuccesful": true,
  "PreviousStepIds": [
    "4d67b8f6-8e13-4014-8096-9c5b4a6931b4",
    "7b29a77a-3d66-4c2f-8019-c591a1daebed"
  ],
  "Values": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "FileValues": {},
      "Mapping": "sample string 4",
      "FieldType": "sample string 5",
      "Text": "sample string 6",
      "AdditionalRef": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "FileValues": {},
      "Mapping": "sample string 4",
      "FieldType": "sample string 5",
      "Text": "sample string 6",
      "AdditionalRef": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "SubmitTimes": [
    {
      "StepId": "3346e068-be93-424e-be20-f631c012c9cc",
      "StepName": "sample string 2",
      "SubmittedTime": "2025-07-01T17:15:18.8039081+10:00",
      "SubmittedById": "84609873-8a8a-4978-8828-c66a9aedc0c7",
      "SubmittedBy": "sample string 5"
    },
    {
      "StepId": "3346e068-be93-424e-be20-f631c012c9cc",
      "StepName": "sample string 2",
      "SubmittedTime": "2025-07-01T17:15:18.8039081+10:00",
      "SubmittedById": "84609873-8a8a-4978-8828-c66a9aedc0c7",
      "SubmittedBy": "sample string 5"
    }
  ],
  "InitHistory": [
    {
      "StepId": "38609074-1e59-4307-8aa1-94f94b84ae2b",
      "StepName": "sample string 2",
      "InitTime": "2025-07-01T17:15:18.8049136+10:00",
      "InitById": "32133531-cc33-4f62-9a0a-e8aca871beed",
      "InitBy": "sample string 5"
    },
    {
      "StepId": "38609074-1e59-4307-8aa1-94f94b84ae2b",
      "StepName": "sample string 2",
      "InitTime": "2025-07-01T17:15:18.8049136+10:00",
      "InitById": "32133531-cc33-4f62-9a0a-e8aca871beed",
      "InitBy": "sample string 5"
    }
  ],
  "Response": {
    "Result": {
      "Success": true,
      "Message": "sample string 2",
      "Errors": [
        {
          "Message": "sample string 1"
        },
        {
          "Message": "sample string 1"
        }
      ]
    }
  },
  "IsFinalised": true
}

application/xml, text/xml

Sample:

<WorkflowFieldValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkflowAPI.Models">
  <ApplicableFrom xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-07-01T07:15:18.7939101Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>600</d2p1:OffsetMinutes>
  </ApplicableFrom>
  <ApplicableTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-07-01T07:15:18.7939101Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>600</d2p1:OffsetMinutes>
  </ApplicableTo>
  <Archived>2025-07-01T17:15:18.7939101+10:00</Archived>
  <ArchivedById>f89cf936-a85a-4179-aee7-837019ee545c</ArchivedById>
  <AssignedDate>2025-07-01T17:15:18.7939101+10:00</AssignedDate>
  <AssignedTo>1ba616da-664f-4c10-bf24-827df381a748</AssignedTo>
  <BookingId>bbd9252d-dd5c-4226-a70e-ea26aa30ca22</BookingId>
  <CPDId>e05da5d9-ef6b-4a28-8ad5-a12fcf94cce7</CPDId>
  <CPDPeriodId>27acd509-d14c-46d7-9bb0-cdfff478c2d3</CPDPeriodId>
  <CPDReductionId>70f90973-6cf8-47d5-9106-2185de41e304</CPDReductionId>
  <CartId>75cc79a9-0c6d-4600-a7ba-488dfb9e9b3d</CartId>
  <CommitStepId>0954c968-851c-4895-88cf-af082f34f687</CommitStepId>
  <CreatedById>dddcc70a-b249-465d-9fff-4db39c626a5a</CreatedById>
  <CreatedDate>2025-07-01T17:15:18.7939101+10:00</CreatedDate>
  <CreatedDateTick>8</CreatedDateTick>
  <CrossCheckApplicationTypeSuccesful>true</CrossCheckApplicationTypeSuccesful>
  <CurrentStepId>57b5026e-a049-4848-8b11-b136406a54dc</CurrentStepId>
  <ElectionId>4707a4f0-179c-45b4-a401-7cf9df03fef5</ElectionId>
  <EntityId>65da6203-d3b8-4619-95f1-b5235feead5e</EntityId>
  <EntityType>sample string 4</EntityType>
  <Id>871991a7-bf5b-4812-9fd8-88d1011eb7f2</Id>
  <InitHistory>
    <FieldValueInitTime>
      <InitBy>sample string 5</InitBy>
      <InitById>32133531-cc33-4f62-9a0a-e8aca871beed</InitById>
      <InitTime>2025-07-01T17:15:18.8049136+10:00</InitTime>
      <StepId>38609074-1e59-4307-8aa1-94f94b84ae2b</StepId>
      <StepName>sample string 2</StepName>
    </FieldValueInitTime>
    <FieldValueInitTime>
      <InitBy>sample string 5</InitBy>
      <InitById>32133531-cc33-4f62-9a0a-e8aca871beed</InitById>
      <InitTime>2025-07-01T17:15:18.8049136+10:00</InitTime>
      <StepId>38609074-1e59-4307-8aa1-94f94b84ae2b</StepId>
      <StepName>sample string 2</StepName>
    </FieldValueInitTime>
  </InitHistory>
  <InvoiceId>34773e74-03c3-47ea-9060-58c203655b47</InvoiceId>
  <IsArchived>true</IsArchived>
  <IsFinalised>true</IsFinalised>
  <LastModifiedById>44707c73-1033-4104-8950-62ed4ddc883f</LastModifiedById>
  <LastModifiedDate>2025-07-01T17:15:18.7939101+10:00</LastModifiedDate>
  <PaymentGatewayTransactionRef>sample string 11</PaymentGatewayTransactionRef>
  <PaymentSuccessful>true</PaymentSuccessful>
  <PreviousStepIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>4d67b8f6-8e13-4014-8096-9c5b4a6931b4</d2p1:guid>
    <d2p1:guid>7b29a77a-3d66-4c2f-8019-c591a1daebed</d2p1:guid>
  </PreviousStepIds>
  <PropertyId>da42f757-b10f-4962-9b9b-8f714112ff39</PropertyId>
  <Response xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkflowAPI.Models.Common">
    <d2p1:Result>
      <d2p1:Errors>
        <d2p1:ErrorMessage>
          <d2p1:Message>sample string 1</d2p1:Message>
        </d2p1:ErrorMessage>
        <d2p1:ErrorMessage>
          <d2p1:Message>sample string 1</d2p1:Message>
        </d2p1:ErrorMessage>
      </d2p1:Errors>
      <d2p1:Message>sample string 2</d2p1:Message>
      <d2p1:Success>true</d2p1:Success>
    </d2p1:Result>
  </Response>
  <SubmitTimes>
    <WorkflowStepSubmitTime>
      <StepId>3346e068-be93-424e-be20-f631c012c9cc</StepId>
      <StepName>sample string 2</StepName>
      <SubmittedBy>sample string 5</SubmittedBy>
      <SubmittedById>84609873-8a8a-4978-8828-c66a9aedc0c7</SubmittedById>
      <SubmittedTime>2025-07-01T17:15:18.8039081+10:00</SubmittedTime>
    </WorkflowStepSubmitTime>
    <WorkflowStepSubmitTime>
      <StepId>3346e068-be93-424e-be20-f631c012c9cc</StepId>
      <StepName>sample string 2</StepName>
      <SubmittedBy>sample string 5</SubmittedBy>
      <SubmittedById>84609873-8a8a-4978-8828-c66a9aedc0c7</SubmittedById>
      <SubmittedTime>2025-07-01T17:15:18.8039081+10:00</SubmittedTime>
    </WorkflowStepSubmitTime>
  </SubmitTimes>
  <UserFullName>sample string 5</UserFullName>
  <UserId>0d6fb74e-756c-4cc5-986f-9e7460b35b40</UserId>
  <Values>
    <WorkflowValue>
      <AdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
      </AdditionalRef>
      <FieldType>sample string 5</FieldType>
      <FileValues />
      <Mapping>sample string 4</Mapping>
      <Name>sample string 1</Name>
      <Text>sample string 6</Text>
      <Value>sample string 2</Value>
    </WorkflowValue>
    <WorkflowValue>
      <AdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
      </AdditionalRef>
      <FieldType>sample string 5</FieldType>
      <FileValues />
      <Mapping>sample string 4</Mapping>
      <Name>sample string 1</Name>
      <Text>sample string 6</Text>
      <Value>sample string 2</Value>
    </WorkflowValue>
  </Values>
  <WaitlistEventId>c99daea0-b5db-4436-a096-c5664d3b3e3b</WaitlistEventId>
  <WaitlistTicketTypeId>25111bdb-d47c-404e-b44f-7f2cec938200</WaitlistTicketTypeId>
  <WorkflowId>8a80ace0-3d8c-4b6b-94ba-e2d073912c18</WorkflowId>
  <WorkflowName>sample string 6</WorkflowName>
</WorkflowFieldValue>

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 'WorkflowFieldValue'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.