GetAvailableTransitions

Description

This service returns a list of available transitions for the specified item. That list can be filtered to include only the transitions that have the specified attribute.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
item (required)	ItemIdentifier	Specifies the item for which available transitions are returned.
transitionOptions	GetTransitionOptions	Indicates the type of transitions to return. If empty or TRANSITIONS-ALL is specified, all transition types are returned. Specify TRANSITIONS-QUICK to return only quick transitions.
attributeName (optional)	string	Returns only transitions that have this transition attribute (see TS_TRANSATTRS for selections). This argument is only used for transitions created via an integration.
options	Options	Holds name value pairing for future arguments on certain calls. Use the FetchRequiredFields option to return a list of fields that are required to transition the item.

Response

One or more transitions are returned, though the list can be empty. See the Transition type for more detail.

Usage

The transition or transitions returned are limited by the item you specify. Only transitions available to the user are returned.

In the options element, you can send the FetchRequiredFields option with a value of 1 to return a list of required fields that must be completed for the transition to succeed. Note that this only applies to regular transitions. The FetchRequiredFields option is not passed by default.

Faults

Invalid database pointer.
The item ID is not valid.
Reading transition attribute fails.

XML

The following XML is a snippet of the payload that is sent with GetAvailableTransitions.

<urn:GetAvailableTransitions>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
    </urn:auth>
    <urn:item>
        <urn:displayName></urn:displayName>
        <urn:id>25</urn:id>
        <urn:uuid></urn:uuid>
        <urn:tableId>1000</urn:tableId>
        <urn:tableIdItemId></urn:tableIdItemId>
        <urn:issueId></urn:issueId>
    </urn:item>
    <urn:transitionOptions>TRANSITIONS-ALL</urn:transitionOptions>
    <urn:attributeName></urn:attributeName>
    <urn:options>
        <urn:extraOption>
            <urn:name>FetchRequiredFields</urn:name>
            <urn:value>1</urn:value>
        </urn:extraOption>
    </urn:options>
</urn:GetAvailableTransitions>