PATCH example/api/automatedflow/participants/{automatedFlowParticipantId}

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

Update an automated flow participant partially by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
automatedFlowParticipantId

The id of the automated flow participant

integer

Required

Body Parameters

Automated flow participant data

UpdateAutomatedFlowParticipantArgs
NameDescriptionTypeAdditional information
AutomatedFlowParticipantPropertyData

Automated flow participant data

Collection of AutomatedFlowParticipantPropertyData

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<UpdateAutomatedFlowParticipantArgs 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>
</UpdateAutomatedFlowParticipantArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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-12-23T06:34:54.1201887+01:00",
  "AutomatedFlowParticipantObject": "sample string 4",
  "Id": 5,
  "ModifiedDate": "2024-12-23T06:34:54.1201887+01:00",
  "NextAutomatedFlowAction": {
    "Id": "3dcec156-6009-45f5-b9b4-f3a0750d89ec",
    "Name": "sample string 2",
    "ScheduledExecutionTime": "2024-12-23T06:34:54.1201887+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-12-23T06:34:54.1201887+01:00</CreationDate>
  <Id>5</Id>
  <ModifiedDate>2024-12-23T06:34:54.1201887+01:00</ModifiedDate>
  <NextAutomatedFlowAction>
    <Id>3dcec156-6009-45f5-b9b4-f3a0750d89ec</Id>
    <Name>sample string 2</Name>
    <ScheduledExecutionTime>2024-12-23T06:34:54.1201887+01:00</ScheduledExecutionTime>
    <Type>sample string 3</Type>
  </NextAutomatedFlowAction>
  <Source>sample string 7</Source>
</AutomatedFlowParticipantModel>