Skip to main content
Create Default Workflow Step Option From Type

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

OptionType

CreateDefaultWorkflowStepOptionFromType: Creates a new carrier from the option type given, with the right kind of properties, defaults set.

OptionType
enum<string>
Available options:
None,
PersonData,
FormSubmission,
LinkClicked,
ProjectMembership,
SelectionMembership,
FormData

Response

OK

Workflow step split option carrier base carrier class. Carrier object for WorkflowStepOptionBase. Services for the WorkflowStepOptionBase Carrier is available from the Workflow Agent.

OptionType
enum<string>

Type of option

Available options:
None,
PersonData,
FormSubmission,
LinkClicked,
ProjectMembership,
SelectionMembership,
FormData
WorkflowStepOptionId
integer<int32>

Primary key

WorkflowStepId
integer<int32>

The workflow step this instance belongs to

WorkflowId
integer<int32>

Workflow id

Name
string

The name of this option

Rank
integer<int32>

Step order

Steps
object[]

The steps to execute if this option/path is selected