GetAvailableSubmitTransitions

Description

This service returns all submit transitions for the specified project.

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.
project (required)	ProjectIdentifier	Specifies the project for which all available submit transitions are returned.
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 submit the item.

Response

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

Usage

The transition or transitions returned is limited by the project you specify.

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 Submit transition to succeed. Note that this only applies to regular Submit transitions (not E-mail Submit transitions). The FetchRequiredFields option is not passed by default.

Faults

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

XML

The following XML is a snippet of the payload being sent with GetAvailableSubmitTransitions.

<urn:GetAvailableSubmitTransitions>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname>localhost</urn:hostname>
    </urn:auth>
    <urn:projectId>6</urn:projectId>
    <urn:attributeName></urn:attributeName>
    <urn:options>
        <urn:extraOption>
            <urn:name>FetchRequiredFields</urn:name>
            <urn:value>1</urn:value>
        </urn:extraOption>
    </urn:options>
</urn:GetAvailableSubmitTransitions>