Get-BT_TaskMetadata

Syntax

Get-BT_TaskMetadata -Ticket <Ticket> [-Environment <string>] [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-EditVersion <Object[]>] [-SortBy_EditVersion_Ascending] [-SortBy_EditVersion_Descending] [-SystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-DefaultAssignedToUserId <Object[]>] [-DefaultAssignedToTeamId <Object[]>] [-CallbackHandlerName <Object[]>] [-SortBy_CallbackHandlerName_Ascending] [-SortBy_CallbackHandlerName_Descending] [-AdditionalCallbackHandlerNames <Object[]>] [-SortBy_AdditionalCallbackHandlerNames_Ascending] [-SortBy_AdditionalCallbackHandlerNames_Descending] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-Instructions <Object[]>] [-SortBy_Instructions_Ascending] [-SortBy_Instructions_Descending] [-DefaultCategory <string[]>] [-DefaultPriority <string[]>] [-DefaultReminderPeriodInMinutes <Object[]>] [-SortBy_DefaultReminderPeriodInMinutes_Ascending] [-SortBy_DefaultReminderPeriodInMinutes_Descending] [-DefaultDueByType <string[]>] [-DefaultDueBy <string[]>] [-SortBy_DefaultDueBy_Ascending] [-SortBy_DefaultDueBy_Descending] [-DefaultDueByMinutesFromStart <Object[]>] [-SortBy_DefaultDueByMinutesFromStart_Ascending] [-SortBy_DefaultDueByMinutesFromStart_Descending] [-DefaultReminderAt <string[]>] [-SortBy_DefaultReminderAt_Ascending] [-SortBy_DefaultReminderAt_Descending] [-CompletionType <string[]>] [-WorkflowType <Object[]>] [-SortBy_WorkflowType_Ascending] [-SortBy_WorkflowType_Descending] [-ActivityName <Object[]>] [-SortBy_ActivityName_Ascending] [-SortBy_ActivityName_Descending] [-RetryCount <Object[]>] [-SortBy_RetryCount_Ascending] [-SortBy_RetryCount_Descending] [-IsSystemAdded <string>] [-LibraryReleaseLevel <string[]>] [-Visibility <string[]>] [-GroupName <Object[]>] [-SortBy_GroupName_Ascending] [-SortBy_GroupName_Descending] [-ShouldAutomaticallyStart <string>] [-AllowedExecutionEnvironment <string[]>] [<CommonParameters>]

Get-BT_TaskMetadata -Ticket <Ticket> -EndpointUrl <string> [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-EditVersion <Object[]>] [-SortBy_EditVersion_Ascending] [-SortBy_EditVersion_Descending] [-SystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-DefaultAssignedToUserId <Object[]>] [-DefaultAssignedToTeamId <Object[]>] [-CallbackHandlerName <Object[]>] [-SortBy_CallbackHandlerName_Ascending] [-SortBy_CallbackHandlerName_Descending] [-AdditionalCallbackHandlerNames <Object[]>] [-SortBy_AdditionalCallbackHandlerNames_Ascending] [-SortBy_AdditionalCallbackHandlerNames_Descending] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-Instructions <Object[]>] [-SortBy_Instructions_Ascending] [-SortBy_Instructions_Descending] [-DefaultCategory <string[]>] [-DefaultPriority <string[]>] [-DefaultReminderPeriodInMinutes <Object[]>] [-SortBy_DefaultReminderPeriodInMinutes_Ascending] [-SortBy_DefaultReminderPeriodInMinutes_Descending] [-DefaultDueByType <string[]>] [-DefaultDueBy <string[]>] [-SortBy_DefaultDueBy_Ascending] [-SortBy_DefaultDueBy_Descending] [-DefaultDueByMinutesFromStart <Object[]>] [-SortBy_DefaultDueByMinutesFromStart_Ascending] [-SortBy_DefaultDueByMinutesFromStart_Descending] [-DefaultReminderAt <string[]>] [-SortBy_DefaultReminderAt_Ascending] [-SortBy_DefaultReminderAt_Descending] [-CompletionType <string[]>] [-WorkflowType <Object[]>] [-SortBy_WorkflowType_Ascending] [-SortBy_WorkflowType_Descending] [-ActivityName <Object[]>] [-SortBy_ActivityName_Ascending] [-SortBy_ActivityName_Descending] [-RetryCount <Object[]>] [-SortBy_RetryCount_Ascending] [-SortBy_RetryCount_Descending] [-IsSystemAdded <string>] [-LibraryReleaseLevel <string[]>] [-Visibility <string[]>] [-GroupName <Object[]>] [-SortBy_GroupName_Ascending] [-SortBy_GroupName_Descending] [-ShouldAutomaticallyStart <string>] [-AllowedExecutionEnvironment <string[]>] [<CommonParameters>]

Detailed Description

Get-BT_TaskMetadata gets a(an) BT_TaskMetadata. Describes different types of tasks and how they behave. A task represents an IT task, which belongs to an IT service you can launch from MSPComplete. A task metadata contains information about one of your executions of the task, such as the execution status and the customer organization id.

Parameters

Total Parameters: 87

EndpointUrl

Paremeter specs:

Ticket

Paremeter specs:

ActivityName

Paremeter specs:

AdditionalCallbackHandlerNames

Paremeter specs:

AllowedExecutionEnvironment

Paremeter specs:

CallbackHandlerName

Paremeter specs:

CompletionType

Paremeter specs:

Created

Paremeter specs:

DefaultAssignedToTeamId

Paremeter specs:

DefaultAssignedToUserId

Paremeter specs:

DefaultCategory

Paremeter specs:

DefaultDueBy

Paremeter specs:

DefaultDueByMinutesFromStart

Paremeter specs:

DefaultDueByType

Paremeter specs:

DefaultPriority

Paremeter specs:

DefaultReminderAt

Paremeter specs:

DefaultReminderPeriodInMinutes

Paremeter specs:

Description

Paremeter specs:

EditVersion

Paremeter specs:

Environment

Available values are listed below.

Paremeter specs:

GroupName

Paremeter specs:

Id

Paremeter specs:

Instructions

Paremeter specs:

IsDeleted

Paremeter specs:

IsSystemAdded

Paremeter specs:

KeyName

Paremeter specs:

LibraryReleaseLevel

Paremeter specs:

Name

Paremeter specs:

PageOffset

Paremeter specs:

PageSize

Paremeter specs:

RetrieveAll

Paremeter specs:

RetryCount

Paremeter specs:

ShouldAutomaticallyStart

Paremeter specs:

ShouldUnmaskProperties

Paremeter specs:

SortBy_ActivityName_Ascending

Paremeter specs:

SortBy_ActivityName_Descending

Paremeter specs:

SortBy_AdditionalCallbackHandlerNames_Ascending

Paremeter specs:

SortBy_AdditionalCallbackHandlerNames_Descending

Paremeter specs:

SortBy_CallbackHandlerName_Ascending

Paremeter specs:

SortBy_CallbackHandlerName_Descending

Paremeter specs:

SortBy_Created_Ascending

Paremeter specs:

SortBy_Created_Descending

Paremeter specs:

SortBy_DefaultDueBy_Ascending

Paremeter specs:

SortBy_DefaultDueBy_Descending

Paremeter specs:

SortBy_DefaultDueByMinutesFromStart_Ascending

Paremeter specs:

SortBy_DefaultDueByMinutesFromStart_Descending

Paremeter specs:

SortBy_DefaultReminderAt_Ascending

Paremeter specs:

SortBy_DefaultReminderAt_Descending

Paremeter specs:

SortBy_DefaultReminderPeriodInMinutes_Ascending

Paremeter specs:

SortBy_DefaultReminderPeriodInMinutes_Descending

Paremeter specs:

SortBy_Description_Ascending

Paremeter specs:

SortBy_Description_Descending

Paremeter specs:

SortBy_EditVersion_Ascending

Paremeter specs:

SortBy_EditVersion_Descending

Paremeter specs:

SortBy_GroupName_Ascending

Paremeter specs:

SortBy_GroupName_Descending

Paremeter specs:

SortBy_Instructions_Ascending

Paremeter specs:

SortBy_Instructions_Descending

Paremeter specs:

SortBy_KeyName_Ascending

Paremeter specs:

SortBy_KeyName_Descending

Paremeter specs:

SortBy_Name_Ascending

Paremeter specs:

SortBy_Name_Descending

Paremeter specs:

SortBy_RetryCount_Ascending

Paremeter specs:

SortBy_RetryCount_Descending

Paremeter specs:

SortBy_Updated_Ascending

Paremeter specs:

SortBy_Updated_Descending

Paremeter specs:

SortBy_Version_Ascending

Paremeter specs:

SortBy_Version_Descending

Paremeter specs:

SortBy_WorkflowType_Ascending

Paremeter specs:

SortBy_WorkflowType_Descending

Paremeter specs:

SystemUserId

Paremeter specs:

Updated

Paremeter specs:

Version

Paremeter specs:

Visibility

Paremeter specs:

WorkflowType

Paremeter specs:

WorkgroupOrganizationId

Paremeter specs:

Outputs

System.Object

Notes

Task metadata and task instance

There are two different types of entities for tasks:

the metadata, called TaskMetadata, which contains information about the task, such as the name and the type of the task

the instance, called TaskInstance, which contains information about one of your executions of the task, such as the execution status and the customer organization id

Public and private MSPComplete tasks

With MSPC, you can create your own custom tasks. While MSPComplete tasks offered by BitTitan do not belong to any workgroup, your private tasks belong to your workgroups.

Examples

-------------------------- Example 1 -------------------------

$offeringMetadataEntities = Get-BT_OfferingMetadata -Ticket $btTicket -KeyName "HealthCheckForAzure"

$offeringMetadataToTaskMetadataEntities = Get-BT_OfferingMetadataToTaskMetadata -Ticket $btTicket -OfferingMetadataId $offeringMetadataEntities[0].Id -SortBy_TaskDefaultExecutionOrder_Ascending

$taskMetadataEntities = Get-BT_TaskMetadata -Ticket $btTicket -Id $offeringMetadataToTaskMetadataEntities.TaskMetadataId