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

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

Stops an AutomatedFlow if it is running

Request Information

URI Parameters

Name	Description	Type	Additional information
automatedFlowId	The Id of the AutomatedFlow	integer	Required

Body Parameters

None.

Response Information

Resource Description

An AutomatedFlowModel of the stopped flow

AutomatedFlowModel

Name	Description	Type	Additional 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-11-21T17:21:07.0497392+01:00",
  "Description": "sample string 3",
  "FlowData": "sample string 4",
  "Id": 5,
  "IsRunning": true,
  "ModifiedDate": "2024-11-21T17:21:07.0497392+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-11-21T17:21:07.0497392+01:00</CreationDate>
  <Description>sample string 3</Description>
  <FlowData>sample string 4</FlowData>
  <Id>5</Id>
  <IsRunning>true</IsRunning>
  <ModifiedDate>2024-11-21T17:21:07.0497392+01:00</ModifiedDate>
  <Name>sample string 8</Name>
  <PublicationId>9</PublicationId>
  <SendAdminEmail>true</SendAdminEmail>
</AutomatedFlowModel>