UpdateURLField

Description

This service updates a specified URL field on an item using a specified transition.

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.
transitionId (optional)	TransitionIdentifier	Specifies the transition to use to update the URL field. If not specified, the system Update transition is used.
deleteAll (optional)	boolean	Clears the contents of a URL field. Default is false. If set to true, all other settings in the call are ignored.
breakLock (optional)	boolean	Determines if the transition should run regardless if an item is locked or not. Default is true.
alwaysTrans (optional)	boolean	If set to true, this runs the transition even if the URL field was not changed. Default is false.
urlObject (optional)	URLObj	Holds identification for one or more URLs and enables you to add, update, or delete entries in 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

This call updates a URL field within the scope of a transition.

Use urlObject to add, update, or delete specific entries in the specified URL field. See URLObj

Faults

Invalid database pointer.
The itemId is not valid.
The fieldId is not valid.
No suitable transition is found.
The user lacks sufficient permissions.

XML

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

<urn:UpdateURLField>
    <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>140</urn:id>
        <urn:uuid></urn:uuid>
        <urn:tableId>1000</urn:tableId>
        <urn:tableIdItemId></urn:tableIdItemId>
        <urn:issueId></urn:issueId>
    </urn:itemId>
    <urn:fieldId>
        <urn:displayName>MyURL</urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:dbName></urn:dbName>
    </urn:fieldId>
    <urn:transitionId>
        <urn:displayName></urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:internalName></urn:internalName>
    </urn:transitionId>
    <urn:deleteAll>false</urn:deleteAll>
    <urn:breakLock>true</urn:breakLock>
    <urn:alwaysTrans>false</urn:alwaysTrans>
    <urn:urlObject>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:name>acme</urn:name>
        <urn:action>NEW-ONLY</urn:action>
        <urn:contents>http://www.acme.com</urn:contents>
    </urn:urlObject>
    <urn:urlIdentifier>
        <urn:displayName>acme</urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
    </urn:urlIdentifier>
</urn:UpdateFileField>