POST api/Workflow/Save

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.
Created	date	None.
LastModified	date	None.
WorkflowName	string	None.
Values	Collection of WorkflowPostedField	None.
PaymentSuccessful	boolean	None.
PaymentGatewayTransactionRef	string	None.
PreviousStepIds	Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "47babd19-420d-4709-9b42-4e1c6ea0748e",
  "WorkflowId": "9b60b7d5-cc73-4b03-bd98-d47250dac130",
  "CurrentStepId": "bbaf138c-da07-4f2b-8cd2-ea18b9984e3c",
  "UserId": "bc295bbf-a282-4fe5-822f-71a2ed532699",
  "CPDId": "b3069004-b364-4142-b1a0-12887e7c1de8",
  "Created": "2024-11-29T09:31:52.9768436+11:00",
  "LastModified": "2024-11-29T09:31:52.9768436+11:00",
  "WorkflowName": "sample string 6",
  "Values": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "Mapping": "sample string 3",
      "FieldType": "sample string 4",
      "Text": "sample string 5",
      "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",
      "Mapping": "sample string 3",
      "FieldType": "sample string 4",
      "Text": "sample string 5",
      "AdditionalRef": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "PaymentSuccessful": true,
  "PaymentGatewayTransactionRef": "sample string 7",
  "PreviousStepIds": [
    "ddcbaae3-7950-47b3-ae7b-8bbe45c86992",
    "c736c295-3745-4e8f-ab7d-0776104ca7dd"
  ]
}

application/xml, text/xml

Sample:

<WorkflowPostedFieldsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Request">
  <CPDId>b3069004-b364-4142-b1a0-12887e7c1de8</CPDId>
  <Created>2024-11-29T09:31:52.9768436+11:00</Created>
  <CurrentStepId>bbaf138c-da07-4f2b-8cd2-ea18b9984e3c</CurrentStepId>
  <Id>47babd19-420d-4709-9b42-4e1c6ea0748e</Id>
  <LastModified>2024-11-29T09:31:52.9768436+11:00</LastModified>
  <PaymentGatewayTransactionRef>sample string 7</PaymentGatewayTransactionRef>
  <PaymentSuccessful>true</PaymentSuccessful>
  <PreviousStepIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>ddcbaae3-7950-47b3-ae7b-8bbe45c86992</d2p1:guid>
    <d2p1:guid>c736c295-3745-4e8f-ab7d-0776104ca7dd</d2p1:guid>
  </PreviousStepIds>
  <UserId>bc295bbf-a282-4fe5-822f-71a2ed532699</UserId>
  <Values>
    <WorkflowPostedField>
      <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 4</FieldType>
      <Mapping>sample string 3</Mapping>
      <Name>sample string 1</Name>
      <Text>sample string 5</Text>
      <Value>sample string 2</Value>
    </WorkflowPostedField>
    <WorkflowPostedField>
      <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 4</FieldType>
      <Mapping>sample string 3</Mapping>
      <Name>sample string 1</Name>
      <Text>sample string 5</Text>
      <Value>sample string 2</Value>
    </WorkflowPostedField>
  </Values>
  <WorkflowId>9b60b7d5-cc73-4b03-bd98-d47250dac130</WorkflowId>
  <WorkflowName>sample string 6</WorkflowName>
</WorkflowPostedFieldsRequestModel>

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

Response Information

Resource Description

BaseResponseModel

Name	Description	Type	Additional information
Result		ResponseResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Errors": [
      {
        "Message": "sample string 1"
      },
      {
        "Message": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<BaseResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response">
  <Result>
    <Errors>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
    </Errors>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </Result>
</BaseResponseModel>