POST example/api/automatedflow/{automatedFlowId}/participantproperties

https://app.bwz.se/bedrock/example/api/automatedflow/{automatedFlowId}/participantproperties

Create AutomatedFlowParticipant properties for an AutomatedFlow

Request Information

URI Parameters

NameDescriptionTypeAdditional information
automatedFlowId

The AutomatedFlow id

integer

Required

Body Parameters

Automated flow participant properties

AutomatedFlowParticipantPropertyArgs
NameDescriptionTypeAdditional information
AutomatedFlowParticipantProperties

Automated flow participant properties

Collection of AutomatedFlowParticipantPropertyArgsModel

None.

Request Formats

application/json, text/json

Sample:
{
  "AutomatedFlowParticipantProperties": [
    {
      "Name": "sample string 1",
      "Type": 1,
      "IsRequired": true
    },
    {
      "Name": "sample string 1",
      "Type": 1,
      "IsRequired": true
    }
  ]
}

application/xml, text/xml

Sample:
<AutomatedFlowParticipantPropertyArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Automation">
  <AutomatedFlowParticipantProperties>
    <AutomatedFlowParticipantPropertyArgsModel>
      <IsRequired>true</IsRequired>
      <Name>sample string 1</Name>
      <Type>EMAIL</Type>
    </AutomatedFlowParticipantPropertyArgsModel>
    <AutomatedFlowParticipantPropertyArgsModel>
      <IsRequired>true</IsRequired>
      <Name>sample string 1</Name>
      <Type>EMAIL</Type>
    </AutomatedFlowParticipantPropertyArgsModel>
  </AutomatedFlowParticipantProperties>
</AutomatedFlowParticipantPropertyArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of AutomatedFlowParticipantPropertyModels.

AutomatedFlowParticipantPropertyModel
NameDescriptionTypeAdditional information
Name

The flow data property identifier name. E.g. "Email"/"Name".

string

None.

Required

Tells if the property is Required or not.

boolean

None.

Type

The flow data property type.

AutomatedFlowParticipantPropertyType

None.

AutomatedFlowId

The Id of the AutomatedFlow these properties belong to

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Required": true,
  "Type": 1,
  "AutomatedFlowId": 3
}

application/xml, text/xml

Sample:
<AutomatedFlowParticipantPropertyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Automation">
  <AutomatedFlowId>3</AutomatedFlowId>
  <Name>sample string 1</Name>
  <Required>true</Required>
  <Type>EMAIL</Type>
</AutomatedFlowParticipantPropertyModel>