GET example/api/automatedflow/{automatedFlowId}/participantproperties
https://app.bwz.se/bedrock/example/api/automatedflow/{automatedFlowId}/participantproperties
Get all automated flow participant property fields. These properties defines an automated flow participant.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
automatedFlowId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of AutomatedFlowParticipantPropertyModelName | Description | Type | Additional 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 }, { "Name": "sample string 1", "Required": true, "Type": 1, "AutomatedFlowId": 3 } ]
application/xml, text/xml
Sample:
<ArrayOfAutomatedFlowParticipantPropertyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Automation"> <AutomatedFlowParticipantPropertyModel> <AutomatedFlowId>3</AutomatedFlowId> <Name>sample string 1</Name> <Required>true</Required> <Type>EMAIL</Type> </AutomatedFlowParticipantPropertyModel> <AutomatedFlowParticipantPropertyModel> <AutomatedFlowId>3</AutomatedFlowId> <Name>sample string 1</Name> <Required>true</Required> <Type>EMAIL</Type> </AutomatedFlowParticipantPropertyModel> </ArrayOfAutomatedFlowParticipantPropertyModel>