Add-BT_TaskInstance

Syntax

Add-BT_TaskInstance -Ticket <Ticket> -TaskMetadataId <guid> [-Environment <string>] [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-Name <string>] [-KeyName <string>] [-OfferingToTaskKeyName <string>] [-Description <string>] [-ParentId <guid>] [-LinkedTaskId <guid>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-AssignedToUserId <guid>] [-AssignedToTeamId <guid>] [-TriggeredViaUserId <guid>] [-TaskMetadata <TaskMetadata>] [-Status <TaskStatus>] [-StatusMessage <string>] [-AutomationStatus <AutomationStatus>] [-ErrorCode <ErrorCode>] [-ErrorMessage <string>] [-ErrorParameters <NamedParameter[]>] [-CallbackStatus <CallbackStatus>] [-ReleaseMode <ReleaseMode>] [-Category <TaskCategory>] [-Priority <Priority>] [-StartedAt <datetime>] [-DueByType <DateRepresentType>] [-DueBy <datetime>] [-DueByMinutesFromStart <int>] [-CompletedAt <datetime>] [-ReminderAt <datetime>] [-Keywords <string[]>] [-CompletionType <TaskCompletionType>] [-Notes <string>] [-ExecutionOrder <double>] [-GeneratedByInformation <string>] [-OfferingInstanceId <guid>] [-OfferingInstance <OfferingInstance>] [-ResumedAt <datetime>] [-TotalRunningTime <long>] [-Instructions <string>] [-CreationType <CallableMetadataCreationType>] [-Visibility <MetadataVisibility>] [-InputVariables <TaskInstanceVariableMapping[]>] [-EntityTypeDependencies <EntityTypeDependency[]>] [-AdvancedSettings <TaskAdvancedSettings>] [-TaskVariables <TaskVariable[]>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Add-BT_TaskInstance -Ticket <Ticket> -EndpointUrl <string> -TaskMetadataId <guid> [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-Name <string>] [-KeyName <string>] [-OfferingToTaskKeyName <string>] [-Description <string>] [-ParentId <guid>] [-LinkedTaskId <guid>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-AssignedToUserId <guid>] [-AssignedToTeamId <guid>] [-TriggeredViaUserId <guid>] [-TaskMetadata <TaskMetadata>] [-Status <TaskStatus>] [-StatusMessage <string>] [-AutomationStatus <AutomationStatus>] [-ErrorCode <ErrorCode>] [-ErrorMessage <string>] [-ErrorParameters <NamedParameter[]>] [-CallbackStatus <CallbackStatus>] [-ReleaseMode <ReleaseMode>] [-Category <TaskCategory>] [-Priority <Priority>] [-StartedAt <datetime>] [-DueByType <DateRepresentType>] [-DueBy <datetime>] [-DueByMinutesFromStart <int>] [-CompletedAt <datetime>] [-ReminderAt <datetime>] [-Keywords <string[]>] [-CompletionType <TaskCompletionType>] [-Notes <string>] [-ExecutionOrder <double>] [-GeneratedByInformation <string>] [-OfferingInstanceId <guid>] [-OfferingInstance <OfferingInstance>] [-ResumedAt <datetime>] [-TotalRunningTime <long>] [-Instructions <string>] [-CreationType <CallableMetadataCreationType>] [-Visibility <MetadataVisibility>] [-InputVariables <TaskInstanceVariableMapping[]>] [-EntityTypeDependencies <EntityTypeDependency[]>] [-AdvancedSettings <TaskAdvancedSettings>] [-TaskVariables <TaskVariable[]>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Detailed Description

Add-BT_TaskInstance adds a(an) BT_TaskInstance. Describes an actual task for execution.

Parameters

Total Parameters: 65

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TaskMetadataId

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AccessLevel

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AdvancedSettings

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AssignedToTeamId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AssignedToUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AutomationStatus

Available values are listed below.

Value Description
NotStarted Not started.
Pending Pending.
Running Running.
Completed Completed.
Failed Failed.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CallbackStatus

Available values are listed below.

Value Description
None None.
WaitingForInstantiationCallback Waiting for instantiation callback.
WaitingForExecutionCallback Waiting for execution callback.
CallbackFailed Callback failed.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Category

Available values are listed below.

Value Description
None None.
Processing Processing task.
Validation Validation task.
Input ""Input"" task, i.e. it's a task requesting input from the user/UI.
Confirmation Confirmation task.
Instructional Instructional tasks with pre-defined instructions and title.
Combo Combo tasks that roll-up other tasks as separate pages.
Automation Automation task that runs a script in a container.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CompletedAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CompletionType

Available values are listed below.

Value Description
Automatic Automatic, no user interaction needed.
Manual Manual, user interaction is needed.
Autocomplete Autocomplete, user clicks on the start link and task will autocomplete.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CreationType

Available values are listed below.

Value Description
New Created manually; not included in metadata.
IncludedOnDeploy Created by deployment; included in metadata.
ProcessingTaskWithPrimaryData Created by a processing task to represent information about the execution of its primary data.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Description

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DueBy

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DueByMinutesFromStart

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DueByType

Available values are listed below.

Value Description
Absolute Absolute date: a specific date, e.g. 01-01-2010.
Relative Relative date: calculated from a reference time with a given time interval. E.g. last 30 days.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EntityTypeDependencies

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Environment

Available values are listed below.

Value Description
BT Represents BT
Beta Represents Beta
Develop Represents Develop
Release Represents Release
Test Represents Test
China Represents China
Germany Represents Germany
Alpha Represents Alpha
Today Represents Today
Sandbox-02 Represents Sandbox-02
Sandbox-03 Represents Sandbox-03

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ErrorCode

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ErrorMessage

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ErrorParameters

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ExecutionOrder

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

GeneratedByInformation

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

InputVariables

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Instructions

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

KeyName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Keywords

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

LinkedTaskId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Name

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Notes

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OfferingInstance

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OfferingInstanceId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OfferingToTaskKeyName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ParentId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Priority

Available values are listed below.

Value Description
Normal Normal/average.
Low Low.
High High.
Critical Critical.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ReleaseMode

Available values are listed below.

Value Description
Released Indicates that this is a released OfferingInstance / TaskInstance.
Design Indicates that this is a design mode OfferingInstance / TaskInstance.
Estimate Indicates that this is an estimate mode OfferingInstance / TaskInstance.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ReminderAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ResumedAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

StartedAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Status

Available values are listed below.

Value Description
NotStarted Not started.
Blocked Blocked.
InProgress In progress.
Completed Completed.
Failed Failed.
CompletedWithErrors Completed with errors.
Cancelled Cancelled.
Ready Ready to start (all previous tasks completed).
Skipped A user manually skipped the task.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

StatusMessage

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TaskMetadata

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TaskVariables

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TotalRunningTime

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TriggeredViaUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Updated

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Visibility

Available values are listed below.

Value Description
Hidden Hidden.
Public Entire workgroup.
OnlyMe Owner only.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Examples

0 Comments