POST example/api/automatedflow

https://app.bwz.se/bedrock/example/api/automatedflow

Create a new AutomatedFlow

Request Information

URI Parameters

None.

Body Parameters

Id of the Publication that the flow emails will be sent from

CreateAutomatedFlowArgs
NameDescriptionTypeAdditional information
Name

Name of the AutomatedFlow

string

None.

Description

A description of the AutomatedFlow

string

None.

PublicationId

Id of the Publication that the flow emails will be sent from

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "PublicationId": 3
}

application/xml, text/xml

Sample:
<CreateAutomatedFlowArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Automation">
  <Description>sample string 2</Description>
  <Name>sample string 1</Name>
  <PublicationId>3</PublicationId>
</CreateAutomatedFlowArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An AutomatedFlowModel of the created AutomatedFlow.

AutomatedFlowModel
NameDescriptionTypeAdditional information
AdminSystemMailId

Admin system mail id

integer

None.

AutomatedFlowState

Automated flow state

AutomatedFlowState

None.

CreatedByUserId

Created by user id

integer

None.

CreationDate

Creation date

date

None.

Description

Description

string

None.

FlowData

JSON data that represents the automated flow

string

None.

Id

The automated flow id

integer

None.

IsRunning

Tells if the flow is running or not.

boolean

None.

ModifiedDate

Modified date

date

None.

Name

Name

string

None.

PublicationId

Publication id

integer

None.

SendAdminEmail

Decides if statistic emails shouls be sent to administrator or not

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "AdminSystemMailId": 1,
  "AutomatedFlowState": 1,
  "CreatedByUserId": 1,
  "CreationDate": "2024-12-23T06:15:01.9846558+01:00",
  "Description": "sample string 3",
  "FlowData": "sample string 4",
  "Id": 5,
  "IsRunning": true,
  "ModifiedDate": "2024-12-23T06:15:01.9846558+01:00",
  "Name": "sample string 8",
  "PublicationId": 9,
  "SendAdminEmail": true
}

application/xml, text/xml

Sample:
<AutomatedFlowModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Automation">
  <AdminSystemMailId>1</AdminSystemMailId>
  <AutomatedFlowState>Design</AutomatedFlowState>
  <CreatedByUserId>1</CreatedByUserId>
  <CreationDate>2024-12-23T06:15:01.9846558+01:00</CreationDate>
  <Description>sample string 3</Description>
  <FlowData>sample string 4</FlowData>
  <Id>5</Id>
  <IsRunning>true</IsRunning>
  <ModifiedDate>2024-12-23T06:15:01.9846558+01:00</ModifiedDate>
  <Name>sample string 8</Name>
  <PublicationId>9</PublicationId>
  <SendAdminEmail>true</SendAdminEmail>
</AutomatedFlowModel>