Get-BT_TaskInstance

Syntax

Get-BT_TaskInstance -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] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-OfferingToTaskKeyName <Object[]>] [-SortBy_OfferingToTaskKeyName_Ascending] [-SortBy_OfferingToTaskKeyName_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-ParentId <Object[]>] [-LinkedTaskId <Object[]>] [-SystemUserId <Object[]>] [-OrganizationId <Object[]>] [-AssignedToUserId <Object[]>] [-AssignedToTeamId <Object[]>] [-TriggeredViaUserId <Object[]>] [-TaskMetadataId <Object[]>] [-Status <string[]>] [-StatusMessage <Object[]>] [-SortBy_StatusMessage_Ascending] [-SortBy_StatusMessage_Descending] [-AutomationStatus <string[]>] [-ErrorCode <string[]>] [-ErrorMessage <Object[]>] [-SortBy_ErrorMessage_Ascending] [-SortBy_ErrorMessage_Descending] [-CallbackStatus <string[]>] [-ReleaseMode <string[]>] [-Category <string[]>] [-Priority <string[]>] [-StartedAt <string[]>] [-SortBy_StartedAt_Ascending] [-SortBy_StartedAt_Descending] [-DueByType <string[]>] [-DueBy <string[]>] [-SortBy_DueBy_Ascending] [-SortBy_DueBy_Descending] [-DueByMinutesFromStart <Object[]>] [-SortBy_DueByMinutesFromStart_Ascending] [-SortBy_DueByMinutesFromStart_Descending] [-CompletedAt <string[]>] [-SortBy_CompletedAt_Ascending] [-SortBy_CompletedAt_Descending] [-ReminderAt <string[]>] [-SortBy_ReminderAt_Ascending] [-SortBy_ReminderAt_Descending] [-CompletionType <string[]>] [-ExecutionOrder <Object[]>] [-SortBy_ExecutionOrder_Ascending] [-SortBy_ExecutionOrder_Descending] [-GeneratedByInformation <Object[]>] [-SortBy_GeneratedByInformation_Ascending] [-SortBy_GeneratedByInformation_Descending] [-OfferingInstanceId <Object[]>] [-ResumedAt <string[]>] [-SortBy_ResumedAt_Ascending] [-SortBy_ResumedAt_Descending] [-InternalTotalRunningTime <Object[]>] [-SortBy_InternalTotalRunningTime_Ascending] [-SortBy_InternalTotalRunningTime_Descending] [-TotalRunningTime <Object[]>] [-SortBy_TotalRunningTime_Ascending] [-SortBy_TotalRunningTime_Descending] [-CreationType <string[]>] [-Visibility <string[]>] [-IsResetUpdate <string>] [<CommonParameters>]

Get-BT_TaskInstance -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] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-OfferingToTaskKeyName <Object[]>] [-SortBy_OfferingToTaskKeyName_Ascending] [-SortBy_OfferingToTaskKeyName_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-ParentId <Object[]>] [-LinkedTaskId <Object[]>] [-SystemUserId <Object[]>] [-OrganizationId <Object[]>] [-AssignedToUserId <Object[]>] [-AssignedToTeamId <Object[]>] [-TriggeredViaUserId <Object[]>] [-TaskMetadataId <Object[]>] [-Status <string[]>] [-StatusMessage <Object[]>] [-SortBy_StatusMessage_Ascending] [-SortBy_StatusMessage_Descending] [-AutomationStatus <string[]>] [-ErrorCode <string[]>] [-ErrorMessage <Object[]>] [-SortBy_ErrorMessage_Ascending] [-SortBy_ErrorMessage_Descending] [-CallbackStatus <string[]>] [-ReleaseMode <string[]>] [-Category <string[]>] [-Priority <string[]>] [-StartedAt <string[]>] [-SortBy_StartedAt_Ascending] [-SortBy_StartedAt_Descending] [-DueByType <string[]>] [-DueBy <string[]>] [-SortBy_DueBy_Ascending] [-SortBy_DueBy_Descending] [-DueByMinutesFromStart <Object[]>] [-SortBy_DueByMinutesFromStart_Ascending] [-SortBy_DueByMinutesFromStart_Descending] [-CompletedAt <string[]>] [-SortBy_CompletedAt_Ascending] [-SortBy_CompletedAt_Descending] [-ReminderAt <string[]>] [-SortBy_ReminderAt_Ascending] [-SortBy_ReminderAt_Descending] [-CompletionType <string[]>] [-ExecutionOrder <Object[]>] [-SortBy_ExecutionOrder_Ascending] [-SortBy_ExecutionOrder_Descending] [-GeneratedByInformation <Object[]>] [-SortBy_GeneratedByInformation_Ascending] [-SortBy_GeneratedByInformation_Descending] [-OfferingInstanceId <Object[]>] [-ResumedAt <string[]>] [-SortBy_ResumedAt_Ascending] [-SortBy_ResumedAt_Descending] [-InternalTotalRunningTime <Object[]>] [-SortBy_InternalTotalRunningTime_Ascending] [-SortBy_InternalTotalRunningTime_Descending] [-TotalRunningTime <Object[]>] [-SortBy_TotalRunningTime_Ascending] [-SortBy_TotalRunningTime_Descending] [-CreationType <string[]>] [-Visibility <string[]>] [-IsResetUpdate <string>] [<CommonParameters>]

Detailed Description

Get-BT_TaskInstance gets a(an) BT_TaskInstance. Describes an actual task for execution. A task represents an IT task, which belongs to an IT service you can launch from MSPComplete. A task instance contains information about one of your executions of the task, such as the execution status and the customer organization id. The metadata of the task can be found in the associated task metadata object.

Parameters

Total Parameters: 98

EndpointUrl

Paremeter specs:

Ticket

Paremeter specs:

AssignedToTeamId

Paremeter specs:

AssignedToUserId

Paremeter specs:

AutomationStatus

Paremeter specs:

CallbackStatus

Paremeter specs:

Category

Paremeter specs:

CompletedAt

Paremeter specs:

CompletionType

Paremeter specs:

Created

Paremeter specs:

CreationType

Paremeter specs:

Description

Paremeter specs:

DueBy

Paremeter specs:

DueByMinutesFromStart

Paremeter specs:

DueByType

Paremeter specs:

Environment

Available values are listed below.

Paremeter specs:

ErrorCode

Paremeter specs:

ErrorMessage

Paremeter specs:

ExecutionOrder

Paremeter specs:

GeneratedByInformation

Paremeter specs:

Id

Paremeter specs:

InternalTotalRunningTime

Paremeter specs:

IsDeleted

Paremeter specs:

IsResetUpdate

Paremeter specs:

KeyName

Paremeter specs:

LinkedTaskId

Paremeter specs:

Name

Paremeter specs:

OfferingInstanceId

Paremeter specs:

OfferingToTaskKeyName

Paremeter specs:

OrganizationId

Paremeter specs:

PageOffset

Paremeter specs:

PageSize

Paremeter specs:

ParentId

Paremeter specs:

Priority

Paremeter specs:

ReleaseMode

Paremeter specs:

ReminderAt

Paremeter specs:

ResumedAt

Paremeter specs:

RetrieveAll

Paremeter specs:

ShouldUnmaskProperties

Paremeter specs:

SortBy_CompletedAt_Ascending

Paremeter specs:

SortBy_CompletedAt_Descending

Paremeter specs:

SortBy_Created_Ascending

Paremeter specs:

SortBy_Created_Descending

Paremeter specs:

SortBy_Description_Ascending

Paremeter specs:

SortBy_Description_Descending

Paremeter specs:

SortBy_DueBy_Ascending

Paremeter specs:

SortBy_DueBy_Descending

Paremeter specs:

SortBy_DueByMinutesFromStart_Ascending

Paremeter specs:

SortBy_DueByMinutesFromStart_Descending

Paremeter specs:

SortBy_ErrorMessage_Ascending

Paremeter specs:

SortBy_ErrorMessage_Descending

Paremeter specs:

SortBy_ExecutionOrder_Ascending

Paremeter specs:

SortBy_ExecutionOrder_Descending

Paremeter specs:

SortBy_GeneratedByInformation_Ascending

Paremeter specs:

SortBy_GeneratedByInformation_Descending

Paremeter specs:

SortBy_InternalTotalRunningTime_Ascending

Paremeter specs:

SortBy_InternalTotalRunningTime_Descending

Paremeter specs:

SortBy_KeyName_Ascending

Paremeter specs:

SortBy_KeyName_Descending

Paremeter specs:

SortBy_Name_Ascending

Paremeter specs:

SortBy_Name_Descending

Paremeter specs:

SortBy_OfferingToTaskKeyName_Ascending

Paremeter specs:

SortBy_OfferingToTaskKeyName_Descending

Paremeter specs:

SortBy_ReminderAt_Ascending

Paremeter specs:

SortBy_ReminderAt_Descending

Paremeter specs:

SortBy_ResumedAt_Ascending

Paremeter specs:

SortBy_ResumedAt_Descending

Paremeter specs:

SortBy_StartedAt_Ascending

Paremeter specs:

SortBy_StartedAt_Descending

Paremeter specs:

SortBy_StatusMessage_Ascending

Paremeter specs:

SortBy_StatusMessage_Descending

Paremeter specs:

SortBy_TotalRunningTime_Ascending

Paremeter specs:

SortBy_TotalRunningTime_Descending

Paremeter specs:

SortBy_Updated_Ascending

Paremeter specs:

SortBy_Updated_Descending

Paremeter specs:

SortBy_Version_Ascending

Paremeter specs:

SortBy_Version_Descending

Paremeter specs:

StartedAt

Paremeter specs:

Status

Paremeter specs:

StatusMessage

Paremeter specs:

SystemUserId

Paremeter specs:

TaskMetadataId

Paremeter specs:

TotalRunningTime

Paremeter specs:

TriggeredViaUserId

Paremeter specs:

Updated

Paremeter specs:

Version

Paremeter specs:

Visibility

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 -------------------------

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

$offeringInstances = Get-BT_OfferingInstance -Ticket $btTicket -OfferingMetadataId $offeringMetadata.Id

$taskInstances = Get-BT_TaskInstance -Ticket $btTicket -OfferingInstanceId $offeringInstances[0].Id -SortBy_ExecutionOrder_Ascending