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": "4b32dcf0-df18-4f44-8fd1-7b266853182c", "WorkflowId": "b6c89815-9107-4c05-97b0-3648ad8ea6f6", "CurrentStepId": "515aa8d4-972c-4cc9-bdc0-f8e73dc43cbf", "UserId": "d4fa734b-37e3-4c78-828c-0925af0e24d5", "CPDId": "73a5e92d-9eaf-42b8-8b37-64d9570416ca", "CPDPeriodId": "575f2872-53fc-4d08-8ce4-5a8555c326c0", "InvoiceId": "e573cba5-17cb-4b8c-9ac2-85ad84eff6d7", "CPDReductionId": "e5273a18-1ffb-4d70-8e9f-84ee60428ee1", "ApplicableFrom": "2025-09-19T03:06:56.6636835+10:00", "ApplicableTo": "2025-09-19T03:06:56.6636835+10:00", "WaitlistEventId": "7f638c08-4709-4ef4-94ae-5d2e3a2d3ff9", "WaitlistTicketTypeId": "5727bf29-6de0-4d27-86c0-4be5c454e984", "CartId": "071145bc-fbde-4246-8c52-4ceca38a5631", "ElectionId": "b11db43a-eb14-4497-afe8-ecfdb54cd55a", "PropertyId": "b3299b39-d9fb-495d-89bf-ec936d995e70", "BookingId": "03f9a7fb-f23b-46d9-bd45-87a090aa9f4b", "EntityId": "9761b9ae-fd6c-425b-a45a-711da9ae6bc9", "EntityType": "sample string 4", "UserFullName": "sample string 5", "WorkflowName": "sample string 6", "CreatedDate": "2025-09-19T03:06:56.6646838+10:00", "CreatedDateTick": 8, "CreatedById": "6e2e4ea6-8452-4248-a7dc-ff442740bf45", "LastModifiedDate": "2025-09-19T03:06:56.6646838+10:00", "LastModifiedById": "be21fcac-1c02-475b-87b5-fbdff4905408", "IsArchived": true, "CommitStepId": "fb71776f-946a-48d1-96af-3bc9bbd1e7c4", "Archived": "2025-09-19T03:06:56.6646838+10:00", "ArchivedById": "8eee6d13-dece-4a00-a62f-9ac58b9c2458", "AssignedTo": "6dd596a5-bec1-4628-9bd7-9a12dc07179b", "AssignedDate": "2025-09-19T03:06:56.6646838+10:00", "PaymentSuccessful": true, "PaymentGatewayTransactionRef": "sample string 11", "CrossCheckApplicationTypeSuccesful": true, "PreviousStepIds": [ "1dd676ec-b33e-4389-94bd-9fba0d4429bc", "5976ffc4-5cad-4b82-8641-332f31f8dc4d" ], "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": "c0601154-b3f6-467e-b56c-106d608e783e", "StepName": "sample string 2", "SubmittedTime": "2025-09-19T03:06:56.6666836+10:00", "SubmittedById": "c8e1fab8-b7f0-4e7e-929a-a4be4479c54d", "SubmittedBy": "sample string 5" }, { "StepId": "c0601154-b3f6-467e-b56c-106d608e783e", "StepName": "sample string 2", "SubmittedTime": "2025-09-19T03:06:56.6666836+10:00", "SubmittedById": "c8e1fab8-b7f0-4e7e-929a-a4be4479c54d", "SubmittedBy": "sample string 5" } ], "InitHistory": [ { "StepId": "fd00f35f-2d7d-4f56-91ca-dc5e82b3be3b", "StepName": "sample string 2", "InitTime": "2025-09-19T03:06:56.6666836+10:00", "InitById": "07e5c319-18ac-4217-b933-0c0d333eca8b", "InitBy": "sample string 5" }, { "StepId": "fd00f35f-2d7d-4f56-91ca-dc5e82b3be3b", "StepName": "sample string 2", "InitTime": "2025-09-19T03:06:56.6666836+10:00", "InitById": "07e5c319-18ac-4217-b933-0c0d333eca8b", "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-18T17:06:56.6636835Z</d2p1:DateTime> <d2p1:OffsetMinutes>600</d2p1:OffsetMinutes> </ApplicableFrom> <ApplicableTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-09-18T17:06:56.6636835Z</d2p1:DateTime> <d2p1:OffsetMinutes>600</d2p1:OffsetMinutes> </ApplicableTo> <Archived>2025-09-19T03:06:56.6646838+10:00</Archived> <ArchivedById>8eee6d13-dece-4a00-a62f-9ac58b9c2458</ArchivedById> <AssignedDate>2025-09-19T03:06:56.6646838+10:00</AssignedDate> <AssignedTo>6dd596a5-bec1-4628-9bd7-9a12dc07179b</AssignedTo> <BookingId>03f9a7fb-f23b-46d9-bd45-87a090aa9f4b</BookingId> <CPDId>73a5e92d-9eaf-42b8-8b37-64d9570416ca</CPDId> <CPDPeriodId>575f2872-53fc-4d08-8ce4-5a8555c326c0</CPDPeriodId> <CPDReductionId>e5273a18-1ffb-4d70-8e9f-84ee60428ee1</CPDReductionId> <CartId>071145bc-fbde-4246-8c52-4ceca38a5631</CartId> <CommitStepId>fb71776f-946a-48d1-96af-3bc9bbd1e7c4</CommitStepId> <CreatedById>6e2e4ea6-8452-4248-a7dc-ff442740bf45</CreatedById> <CreatedDate>2025-09-19T03:06:56.6646838+10:00</CreatedDate> <CreatedDateTick>8</CreatedDateTick> <CrossCheckApplicationTypeSuccesful>true</CrossCheckApplicationTypeSuccesful> <CurrentStepId>515aa8d4-972c-4cc9-bdc0-f8e73dc43cbf</CurrentStepId> <ElectionId>b11db43a-eb14-4497-afe8-ecfdb54cd55a</ElectionId> <EntityId>9761b9ae-fd6c-425b-a45a-711da9ae6bc9</EntityId> <EntityType>sample string 4</EntityType> <Id>4b32dcf0-df18-4f44-8fd1-7b266853182c</Id> <InitHistory> <FieldValueInitTime> <InitBy>sample string 5</InitBy> <InitById>07e5c319-18ac-4217-b933-0c0d333eca8b</InitById> <InitTime>2025-09-19T03:06:56.6666836+10:00</InitTime> <StepId>fd00f35f-2d7d-4f56-91ca-dc5e82b3be3b</StepId> <StepName>sample string 2</StepName> </FieldValueInitTime> <FieldValueInitTime> <InitBy>sample string 5</InitBy> <InitById>07e5c319-18ac-4217-b933-0c0d333eca8b</InitById> <InitTime>2025-09-19T03:06:56.6666836+10:00</InitTime> <StepId>fd00f35f-2d7d-4f56-91ca-dc5e82b3be3b</StepId> <StepName>sample string 2</StepName> </FieldValueInitTime> </InitHistory> <InvoiceId>e573cba5-17cb-4b8c-9ac2-85ad84eff6d7</InvoiceId> <IsArchived>true</IsArchived> <IsFinalised>true</IsFinalised> <LastModifiedById>be21fcac-1c02-475b-87b5-fbdff4905408</LastModifiedById> <LastModifiedDate>2025-09-19T03:06:56.6646838+10:00</LastModifiedDate> <PaymentGatewayTransactionRef>sample string 11</PaymentGatewayTransactionRef> <PaymentSuccessful>true</PaymentSuccessful> <PreviousStepIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>1dd676ec-b33e-4389-94bd-9fba0d4429bc</d2p1:guid> <d2p1:guid>5976ffc4-5cad-4b82-8641-332f31f8dc4d</d2p1:guid> </PreviousStepIds> <PropertyId>b3299b39-d9fb-495d-89bf-ec936d995e70</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>c0601154-b3f6-467e-b56c-106d608e783e</StepId> <StepName>sample string 2</StepName> <SubmittedBy>sample string 5</SubmittedBy> <SubmittedById>c8e1fab8-b7f0-4e7e-929a-a4be4479c54d</SubmittedById> <SubmittedTime>2025-09-19T03:06:56.6666836+10:00</SubmittedTime> </WorkflowStepSubmitTime> <WorkflowStepSubmitTime> <StepId>c0601154-b3f6-467e-b56c-106d608e783e</StepId> <StepName>sample string 2</StepName> <SubmittedBy>sample string 5</SubmittedBy> <SubmittedById>c8e1fab8-b7f0-4e7e-929a-a4be4479c54d</SubmittedById> <SubmittedTime>2025-09-19T03:06:56.6666836+10:00</SubmittedTime> </WorkflowStepSubmitTime> </SubmitTimes> <UserFullName>sample string 5</UserFullName> <UserId>d4fa734b-37e3-4c78-828c-0925af0e24d5</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>7f638c08-4709-4ef4-94ae-5d2e3a2d3ff9</WaitlistEventId> <WaitlistTicketTypeId>5727bf29-6de0-4d27-86c0-4be5c454e984</WaitlistTicketTypeId> <WorkflowId>b6c89815-9107-4c05-97b0-3648ad8ea6f6</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.