User Guide

acl-field-update 55

acl-field-update

Availability

Breeze 5.

Description

Updates the field value for the given ACL and field. The caller requires modify permission on the

ACL.

An ACL is a securable Breeze object, for example, a principal, SCO, or account. For more

information, see “About principals, SCOs, and IDs” on page 17.

Parameters

acl-id

The ID of the ACL that you want to modify. This can be a principal-id, sco-id, or

account-id.

field-id The ID of the field that you want to edit.

value The value that you want to set for the field specified by the field-id parameter.

Filters

Results cannot be sorted or filtered.

Returned elements

None.

Sample results

The following call updates the first name of the user with ACL ID 38140560 (call acl-field-

list

to determine the ACL ID):

http://server_name/api/xml?action=acl-field-update&acl-id=38140560&field-

id=first-name&value=Mary%20Sue

The results are as follows:

</results>

Now call acl-field-list again to see the updated first name:

http://server_name/api/xml?action=acl-field-list&field-id=first-name

The results are as follows:

<acl-field-list>

<value>Stephanie</value>

</acl>

</acl>