GetFieldSelections

Description

This service returns the full list of available selections for single and multi-selection fields.

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.
field (required)	FieldIdentifier	The field for which selections should be returned.
project (optional)	ProjectIdentifier	The project that contains the field.

Response

FieldSelectionsHolder is returned, one for each field that is specified in the call. For each field, the unique FieldIdentifier, field selection type, field attributes, and options are returned. For more detail, see FieldSelectionsHolder.

Usage

The GetFieldSelections call enables you to see the list of available field selections for Single Selection, Multi-Selection, and Binary/Trinary fields on a primary item.

Only Single Selection, Multi-Selection, and Binary/Trinary field types can be used with the GetFieldSelections call.

You will typically use the GetItem call first to retrieve a list of FieldIdentifiers for the Single Selection, Multi-Selection, and Binary/Trinary fields on an item, and then specify those FieldIdentifiers in the GetFieldSelections call.

Faults

The user lacks sufficient permission.

XML

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

<urn:GetFieldSelections>
     <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
     </urn:auth>
     <urn:field>
        <urn:dbName>ACTIVEINACTIVE</urn:dbName>
     </urn:field>
     <urn:field>
        <urn:dbName>PRIORITY</urn:dbName>
     </urn:field>
     <urn:field>
        <urn:dbName>FUNCTIONAL_AREAS</urn:dbName>
     </urn:field>
     <urn:project>
        <urn:displayName>IDM Project</urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:fullyQualifiedName></urn:fullyQualifiedName>
        <urn:internalName></urn:internalName>
     </urn:project>
</urn:GetFieldSelections>