POST api/WorkflowFieldValues/InsertOrUpdateFieldValues
Request Information
URI Parameters
None.
Body Parameters
WorkflowFieldValueName | Description | 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": "ce28d2c7-c1eb-4d5f-b5a4-1e96f24eee6a", "WorkflowId": "9b632cf4-4813-4073-900d-17e2f69c0e57", "CurrentStepId": "63996e9b-18b8-4f07-9a63-e4a254f39ec9", "UserId": "388ddd79-bd0b-44e2-9fcc-56b700c8da23", "CPDId": "78d86fc7-bb63-414c-af0d-207f4d559cfc", "CPDPeriodId": "ef59852e-82eb-4ec0-8b3a-eef1a3aa13fc", "InvoiceId": "0652e1a5-3098-4b78-a1a0-ad3682258f7c", "CPDReductionId": "d8e54740-b469-433a-91f7-30ddd6142ed8", "ApplicableFrom": "2025-09-19T06:36:38.6684774+10:00", "ApplicableTo": "2025-09-19T06:36:38.6684774+10:00", "WaitlistEventId": "34be68ab-ae06-406d-9fe0-2629421bad30", "WaitlistTicketTypeId": "ca0041a0-43cc-4e14-b12c-56cf7a417a14", "CartId": "3b5a108c-16f5-40b8-a213-abede6adec0a", "ElectionId": "d444346a-bf2f-4a2a-a671-1b8bd0eedff6", "PropertyId": "ef275c98-a76c-46fc-862c-b5fa33a9eae5", "BookingId": "1491fa2b-94a3-4baf-8ca5-62a115e079b1", "EntityId": "2ab8d34d-50cd-4959-bab1-9419b48bb218", "EntityType": "sample string 4", "UserFullName": "sample string 5", "WorkflowName": "sample string 6", "CreatedDate": "2025-09-19T06:36:38.6684774+10:00", "CreatedDateTick": 8, "CreatedById": "bd3c2da3-82be-4e1f-be1c-05850fd684fa", "LastModifiedDate": "2025-09-19T06:36:38.6684774+10:00", "LastModifiedById": "e3c1ccb5-1192-4a8f-a9ab-1dcb366ffe8d", "IsArchived": true, "CommitStepId": "4f5b8803-60f3-4f45-8a39-0d7b459e921b", "Archived": "2025-09-19T06:36:38.6684774+10:00", "ArchivedById": "09fc0caf-f33a-4557-961c-fa3beb020c1c", "AssignedTo": "86b89251-a7a9-48b9-83bc-c9cc345cf879", "AssignedDate": "2025-09-19T06:36:38.6684774+10:00", "PaymentSuccessful": true, "PaymentGatewayTransactionRef": "sample string 11", "CrossCheckApplicationTypeSuccesful": true, "PreviousStepIds": [ "c0ee64a3-518a-4ef0-b4df-72fa9344e09f", "44f6d519-5b88-4be4-b5f2-1e43e942b463" ], "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": "9d470498-b870-4295-abd8-faccb59f64ba", "StepName": "sample string 2", "SubmittedTime": "2025-09-19T06:36:38.6684774+10:00", "SubmittedById": "0b745923-902c-4829-a076-71560b367045", "SubmittedBy": "sample string 5" }, { "StepId": "9d470498-b870-4295-abd8-faccb59f64ba", "StepName": "sample string 2", "SubmittedTime": "2025-09-19T06:36:38.6684774+10:00", "SubmittedById": "0b745923-902c-4829-a076-71560b367045", "SubmittedBy": "sample string 5" } ], "InitHistory": [ { "StepId": "03cbae9a-7af0-44ce-bb26-848c75264472", "StepName": "sample string 2", "InitTime": "2025-09-19T06:36:38.6684774+10:00", "InitById": "29a3e214-52d4-40e4-96e9-c3db31ab2c11", "InitBy": "sample string 5" }, { "StepId": "03cbae9a-7af0-44ce-bb26-848c75264472", "StepName": "sample string 2", "InitTime": "2025-09-19T06:36:38.6684774+10:00", "InitById": "29a3e214-52d4-40e4-96e9-c3db31ab2c11", "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-09-18T20:36:38.6684774Z</d2p1:DateTime> <d2p1:OffsetMinutes>600</d2p1:OffsetMinutes> </ApplicableFrom> <ApplicableTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-09-18T20:36:38.6684774Z</d2p1:DateTime> <d2p1:OffsetMinutes>600</d2p1:OffsetMinutes> </ApplicableTo> <Archived>2025-09-19T06:36:38.6684774+10:00</Archived> <ArchivedById>09fc0caf-f33a-4557-961c-fa3beb020c1c</ArchivedById> <AssignedDate>2025-09-19T06:36:38.6684774+10:00</AssignedDate> <AssignedTo>86b89251-a7a9-48b9-83bc-c9cc345cf879</AssignedTo> <BookingId>1491fa2b-94a3-4baf-8ca5-62a115e079b1</BookingId> <CPDId>78d86fc7-bb63-414c-af0d-207f4d559cfc</CPDId> <CPDPeriodId>ef59852e-82eb-4ec0-8b3a-eef1a3aa13fc</CPDPeriodId> <CPDReductionId>d8e54740-b469-433a-91f7-30ddd6142ed8</CPDReductionId> <CartId>3b5a108c-16f5-40b8-a213-abede6adec0a</CartId> <CommitStepId>4f5b8803-60f3-4f45-8a39-0d7b459e921b</CommitStepId> <CreatedById>bd3c2da3-82be-4e1f-be1c-05850fd684fa</CreatedById> <CreatedDate>2025-09-19T06:36:38.6684774+10:00</CreatedDate> <CreatedDateTick>8</CreatedDateTick> <CrossCheckApplicationTypeSuccesful>true</CrossCheckApplicationTypeSuccesful> <CurrentStepId>63996e9b-18b8-4f07-9a63-e4a254f39ec9</CurrentStepId> <ElectionId>d444346a-bf2f-4a2a-a671-1b8bd0eedff6</ElectionId> <EntityId>2ab8d34d-50cd-4959-bab1-9419b48bb218</EntityId> <EntityType>sample string 4</EntityType> <Id>ce28d2c7-c1eb-4d5f-b5a4-1e96f24eee6a</Id> <InitHistory> <FieldValueInitTime> <InitBy>sample string 5</InitBy> <InitById>29a3e214-52d4-40e4-96e9-c3db31ab2c11</InitById> <InitTime>2025-09-19T06:36:38.6684774+10:00</InitTime> <StepId>03cbae9a-7af0-44ce-bb26-848c75264472</StepId> <StepName>sample string 2</StepName> </FieldValueInitTime> <FieldValueInitTime> <InitBy>sample string 5</InitBy> <InitById>29a3e214-52d4-40e4-96e9-c3db31ab2c11</InitById> <InitTime>2025-09-19T06:36:38.6684774+10:00</InitTime> <StepId>03cbae9a-7af0-44ce-bb26-848c75264472</StepId> <StepName>sample string 2</StepName> </FieldValueInitTime> </InitHistory> <InvoiceId>0652e1a5-3098-4b78-a1a0-ad3682258f7c</InvoiceId> <IsArchived>true</IsArchived> <IsFinalised>true</IsFinalised> <LastModifiedById>e3c1ccb5-1192-4a8f-a9ab-1dcb366ffe8d</LastModifiedById> <LastModifiedDate>2025-09-19T06:36:38.6684774+10:00</LastModifiedDate> <PaymentGatewayTransactionRef>sample string 11</PaymentGatewayTransactionRef> <PaymentSuccessful>true</PaymentSuccessful> <PreviousStepIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>c0ee64a3-518a-4ef0-b4df-72fa9344e09f</d2p1:guid> <d2p1:guid>44f6d519-5b88-4be4-b5f2-1e43e942b463</d2p1:guid> </PreviousStepIds> <PropertyId>ef275c98-a76c-46fc-862c-b5fa33a9eae5</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>9d470498-b870-4295-abd8-faccb59f64ba</StepId> <StepName>sample string 2</StepName> <SubmittedBy>sample string 5</SubmittedBy> <SubmittedById>0b745923-902c-4829-a076-71560b367045</SubmittedById> <SubmittedTime>2025-09-19T06:36:38.6684774+10:00</SubmittedTime> </WorkflowStepSubmitTime> <WorkflowStepSubmitTime> <StepId>9d470498-b870-4295-abd8-faccb59f64ba</StepId> <StepName>sample string 2</StepName> <SubmittedBy>sample string 5</SubmittedBy> <SubmittedById>0b745923-902c-4829-a076-71560b367045</SubmittedById> <SubmittedTime>2025-09-19T06:36:38.6684774+10:00</SubmittedTime> </WorkflowStepSubmitTime> </SubmitTimes> <UserFullName>sample string 5</UserFullName> <UserId>388ddd79-bd0b-44e2-9fcc-56b700c8da23</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>34be68ab-ae06-406d-9fe0-2629421bad30</WaitlistEventId> <WaitlistTicketTypeId>ca0041a0-43cc-4e14-b12c-56cf7a417a14</WaitlistTicketTypeId> <WorkflowId>9b632cf4-4813-4073-900d-17e2f69c0e57</WorkflowId> <WorkflowName>sample string 6</WorkflowName> </WorkflowFieldValue>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.