Agent skill

get-atwsskill

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/get-atwsskill

SKILL.md

Get-AtwsSkill

SYNOPSIS

This function get one or more Skill through the Autotask Web Services API.

SYNTAX

Filter (Default)

Get-AtwsSkill -Filter <String[]> [-GetReferenceEntityById <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

By_parameters

Get-AtwsSkill [-GetReferenceEntityById <String>] [-Active <Nullable`1[]>] [-CategoryID <String[]>]
 [-Description <String[]>] [-id <Nullable`1[]>] [-Name <String[]>] [-NotEquals <String[]>] [-IsNull <String[]>]
 [-IsNotNull <String[]>] [-GreaterThan <String[]>] [-GreaterThanOrEquals <String[]>] [-LessThan <String[]>]
 [-LessThanOrEquals <String[]>] [-Like <String[]>] [-NotLike <String[]>] [-BeginsWith <String[]>]
 [-EndsWith <String[]>] [-Contains <String[]>] [-IsThisDay <String[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Get_all

Get-AtwsSkill [-All] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function creates a query based on any parameters you give and returns any resulting objects from the Autotask Web Services Api. By default the function returns any objects with properties that are Equal (-eq) to the value of the parameter. To give you more flexibility you can modify the operator by using -NotEquals [ParameterName[]], -LessThan [ParameterName[]] and so on.

Possible operators for all parameters are: -NotEquals -GreaterThan -GreaterThanOrEqual -LessThan -LessThanOrEquals

Additional operators for [string] parameters are: -Like (supports * or % as wildcards) -NotLike -BeginsWith -EndsWith -Contains

Properties with picklists are: CategoryID

Entities that have fields that refer to the base entity of this CmdLet:

EXAMPLES

EXAMPLE 1

Get-AtwsSkill -Id 0
Returns the object with Id 0, if any.

EXAMPLE 2

Get-AtwsSkill -SkillName SomeName
Returns the object with SkillName 'SomeName', if any.

EXAMPLE 3

Get-AtwsSkill -SkillName 'Some Name'
Returns the object with SkillName 'Some Name', if any.

EXAMPLE 4

Get-AtwsSkill -SkillName 'Some Name' -NotEquals SkillName
Returns any objects with a SkillName that is NOT equal to 'Some Name', if any.

EXAMPLE 5

Get-AtwsSkill -SkillName SomeName* -Like SkillName
Returns any object with a SkillName that matches the simple pattern 'SomeName*'. Supported wildcards are * and %.

EXAMPLE 6

Get-AtwsSkill -SkillName SomeName* -NotLike SkillName
Returns any object with a SkillName that DOES NOT match the simple pattern 'SomeName*'. Supported wildcards are * and %.

EXAMPLE 7

Returns any Skills with property CategoryID equal to the <PickList Label>. '-PickList' is any parameter on .

EXAMPLE 8

-NotEquals CategoryID 
Returns any Skills with property CategoryID NOT equal to the <PickList Label>.

EXAMPLE 9

, <PickList Label2>
Returns any Skills with property CategoryID equal to EITHER <PickList Label1> OR <PickList Label2>.

EXAMPLE 10

, <PickList Label2> -NotEquals CategoryID
Returns any Skills with property CategoryID NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>.

EXAMPLE 11

, <PickList Label2> -Like SkillName -NotEquals CategoryID -GreaterThan Id
An example of a more complex query. This command returns any Skills with Id GREATER THAN 1234, a SkillName that matches the simple pattern SomeName* AND that has a CategoryID that is NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>.

PARAMETERS

-Filter

A filter that limits the number of objects that is returned from the API

yaml
Type: String[]
Parameter Sets: Filter
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GetReferenceEntityById

Follow this external ID and return any external objects

yaml
Type: String
Parameter Sets: Filter, By_parameters
Aliases: GetRef

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-All

Return all objects in one query

yaml
Type: SwitchParameter
Parameter Sets: Get_all
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Active

Active

yaml
Type: Nullable`1[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CategoryID

Category ID

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Description

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

Skill ID

yaml
Type: Nullable`1[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NotEquals

{{ Fill NotEquals Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsNull

{{ Fill IsNull Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsNotNull

{{ Fill IsNotNull Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GreaterThan

{{ Fill GreaterThan Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GreaterThanOrEquals

{{ Fill GreaterThanOrEquals Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LessThan

{{ Fill LessThan Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LessThanOrEquals

{{ Fill LessThanOrEquals Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Like

{{ Fill Like Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NotLike

{{ Fill NotLike Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BeginsWith

{{ Fill BeginsWith Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EndsWith

{{ Fill EndsWith Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Contains

{{ Fill Contains Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsThisDay

{{ Fill IsThisDay Description }}

yaml
Type: String[]
Parameter Sets: By_parameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Nothing. This function only takes parameters.

OUTPUTS

[Autotask.Skill[]]. This function outputs the Autotask.Skill that was returned by the API.

NOTES

Related commands:

RELATED LINKS

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results