Add-BT_TaskMetadata

Syntax

Add-BT_TaskMetadata -Ticket <Ticket> [-Environment <string>] [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-EditVersion <int>] [-SystemUserId <guid>] [-WorkgroupOrganizationId <guid>] [-DefaultAssignedToUserId <guid>] [-DefaultAssignedToTeamId <guid>] [-CallbackHandlerName <string>] [-AdditionalCallbackHandlerNames <string>] [-Name <string>] [-KeyName <string>] [-Description <string>] [-Instructions <string>] [-DefaultCategory <TaskCategory>] [-DefaultPriority <Priority>] [-DefaultReminderPeriodInMinutes <int>] [-DefaultKeywords <string[]>] [-DefaultDueByType <DateRepresentType>] [-DefaultDueBy <datetime>] [-DefaultDueByMinutesFromStart <int>] [-DefaultReminderAt <datetime>] [-CompletionType <TaskCompletionType>] [-WorkflowType <string>] [-ActivityName <string>] [-RetryCount <int>] [-IsSystemAdded <bool>] [-LibraryReleaseLevel <TaskLibraryReleaseLevel>] [-Visibility <MetadataVisibility>] [-GroupName <string>] [-Input <TaskVariableDescriptor[]>] [-Output <TaskVariableDescriptor[]>] [-InputBusinessTypesComputed <PropertyBusinessType[]>] [-OutputBusinessTypesComputed <PropertyBusinessType[]>] [-EntityTypeDependencies <EntityTypeDependency[]>] [-AdvancedSettings <TaskAdvancedSettings>] [-ShouldAutomaticallyStart <bool>] [-AllowedExecutionEnvironment <AllowedExecutionEnvironmentType>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Add-BT_TaskMetadata -Ticket <Ticket> -EndpointUrl <string> [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-EditVersion <int>] [-SystemUserId <guid>] [-WorkgroupOrganizationId <guid>] [-DefaultAssignedToUserId <guid>] [-DefaultAssignedToTeamId <guid>] [-CallbackHandlerName <string>] [-AdditionalCallbackHandlerNames <string>] [-Name <string>] [-KeyName <string>] [-Description <string>] [-Instructions <string>] [-DefaultCategory <TaskCategory>] [-DefaultPriority <Priority>] [-DefaultReminderPeriodInMinutes <int>] [-DefaultKeywords <string[]>] [-DefaultDueByType <DateRepresentType>] [-DefaultDueBy <datetime>] [-DefaultDueByMinutesFromStart <int>] [-DefaultReminderAt <datetime>] [-CompletionType <TaskCompletionType>] [-WorkflowType <string>] [-ActivityName <string>] [-RetryCount <int>] [-IsSystemAdded <bool>] [-LibraryReleaseLevel <TaskLibraryReleaseLevel>] [-Visibility <MetadataVisibility>] [-GroupName <string>] [-Input <TaskVariableDescriptor[]>] [-Output <TaskVariableDescriptor[]>] [-InputBusinessTypesComputed <PropertyBusinessType[]>] [-OutputBusinessTypesComputed <PropertyBusinessType[]>] [-EntityTypeDependencies <EntityTypeDependency[]>] [-AdvancedSettings <TaskAdvancedSettings>] [-ShouldAutomaticallyStart <bool>] [-AllowedExecutionEnvironment <AllowedExecutionEnvironmentType>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Detailed Description

Add-BT_TaskMetadata adds a(an) BT_TaskMetadata. Describes different types of tasks and how they behave.

Parameters

Total Parameters: 55

EndpointUrl

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

ActivityName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AdditionalCallbackHandlerNames

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AdvancedSettings

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AllowedExecutionEnvironment

Available values are listed below.

Value Description
BitTitanCloud BitTitan cloud.
Gateway Customer-owned gateway.
Any Any environment.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CallbackHandlerName

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

DefaultAssignedToTeamId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultAssignedToUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultCategory

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

DefaultDueBy

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultDueByMinutesFromStart

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultDueByType

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

DefaultKeywords

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultPriority

Available values are listed below.

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

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultReminderAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultReminderPeriodInMinutes

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Description

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EditVersion

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

GroupName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Input

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

InputBusinessTypesComputed

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

IsSystemAdded

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

KeyName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

LibraryReleaseLevel

Available values are listed below.

Value Description
None The should not appear in the Task Library - it is only used in the runbooks that specify it.
SystemLevel The should appear in the Task Library for all users.
Template The should appear in the Task Library but only be available for copying.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Name

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Output

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OutputBusinessTypesComputed

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RetryCount

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ShouldAutomaticallyStart

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

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

WorkflowType

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

WorkgroupOrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Examples