GetURLField

Description

This service returns a list of URLs from a specified URL field on an item.

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.
itemId (required) ItemIdentifier Specifies the item that contains the URL field.
fieldId (required) FieldIdentifier Specifies the URL field.
urlIdentifier (optional) Identifier Holds generic information about a URL. Used to specify which URLs to return if there are multiple URLs.

Response

FieldObjectResponse is returned. See FieldObjectHolder.

Usage

Use urlIdentifier to return specific URLs from a URL field instead of all URLs. If you do not include urlIdentifier to limit the response, all URLs are returned.

Faults

XML

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

<urn:GetURLField>
    <urn:auth>
        <urn:userId>bill</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
    </urn:auth>
    <urn:itemId>
        <urn:displayName></urn:displayName>
        <urn:id>2</urn:id>
        <urn:uuid></urn:uuid>
        <urn:tableId>1012</urn:tableId>
        <urn:tableIdItemId></urn:tableIdItemId>
        <urn:issueId></urn:issueId>
    </urn:itemId>
    <urn:fieldId>
        <urn:displayName></urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:dbName>MULTI_URL</urn:dbName>
    </urn:fieldId>
    <urn:urlIdentifier>
        <urn:displayName></urn:displayName>
        <urn:id>5</urn:id>
        <urn:uuid></urn:uuid>
    </urn:urlIdentifier>
    <urn:urlIdentifier>
        <urn:displayName></urn:displayName>
        <urn:id>6</urn:id>
        <urn:uuid></urn:uuid>
    </urn:urlIdentifier> 
</urn:GetURLField>