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

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

Create automated flow participants.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
automatedFlowId

The automated flow id.

integer

Required

Body Parameters

Source of the AutomatedFlowParticipant

CreateAutomatedFlowParticipantArgs
NameDescriptionTypeAdditional information
AutomatedFlowParticipantPropertyData

Automated flow participant property data

Collection of AutomatedFlowParticipantPropertyData

None.

Source

Source of the AutomatedFlowParticipant

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AutomatedFlowParticipantPropertyData": [
    {
      "Name": "sample string 1",
      "Value": {}
    },
    {
      "Name": "sample string 1",
      "Value": {}
    }
  ],
  "Source": "sample string 1"
}

application/xml, text/xml

Sample:
<CreateAutomatedFlowParticipantArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Automation">
  <AutomatedFlowParticipantPropertyData>
    <AutomatedFlowParticipantPropertyData>
      <Name>sample string 1</Name>
      <Value />
    </AutomatedFlowParticipantPropertyData>
    <AutomatedFlowParticipantPropertyData>
      <Name>sample string 1</Name>
      <Value />
    </AutomatedFlowParticipantPropertyData>
  </AutomatedFlowParticipantPropertyData>
  <Source>sample string 1</Source>
</CreateAutomatedFlowParticipantArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The AutomatedFlowParticipant that has been created.

AutomatedFlowParticipantModel
NameDescriptionTypeAdditional information
AutomatedFlowId

Id of the AutomatedFlow

integer

None.

CreatedByUserId

Id of the User that created the AutomatedFlowParticipant

integer

None.

CreationDate

CreationDate of the AutomatedFlowParticipant

date

None.

AutomatedFlowParticipantObject

The JSON representation of the AutomatedFlowParticipant

string

None.

Id

The Id of the AutomatedFlowParticipant

integer

None.

ModifiedDate

ModifiedDate of the the AutomatedFlowParticipant

date

None.

NextAutomatedFlowAction

AutomatedFlowActionModel of the next AutomatedFlowAction

AutomatedFlowActionModel

None.

Source

Source how the AutomatedFlowParticipant was created

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AutomatedFlowId": 1,
  "CreatedByUserId": 2,
  "CreationDate": "2024-11-21T17:46:57.2295437+01:00",
  "AutomatedFlowParticipantObject": "sample string 4",
  "Id": 5,
  "ModifiedDate": "2024-11-21T17:46:57.2295437+01:00",
  "NextAutomatedFlowAction": {
    "Id": "a93aa495-13f5-4c50-9e00-b98c4726c63d",
    "Name": "sample string 2",
    "ScheduledExecutionTime": "2024-11-21T17:46:57.2295437+01:00",
    "Type": "sample string 3",
    "Version": 1
  },
  "Source": "sample string 7"
}

application/xml, text/xml

Sample:
<AutomatedFlowParticipantModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Automation">
  <AutomatedFlowId>1</AutomatedFlowId>
  <AutomatedFlowParticipantObject>sample string 4</AutomatedFlowParticipantObject>
  <CreatedByUserId>2</CreatedByUserId>
  <CreationDate>2024-11-21T17:46:57.2295437+01:00</CreationDate>
  <Id>5</Id>
  <ModifiedDate>2024-11-21T17:46:57.2295437+01:00</ModifiedDate>
  <NextAutomatedFlowAction>
    <Id>a93aa495-13f5-4c50-9e00-b98c4726c63d</Id>
    <Name>sample string 2</Name>
    <ScheduledExecutionTime>2024-11-21T17:46:57.2295437+01:00</ScheduledExecutionTime>
    <Type>sample string 3</Type>
  </NextAutomatedFlowAction>
  <Source>sample string 7</Source>
</AutomatedFlowParticipantModel>