acl-field-update

Availability

Breeze 5; Connect Enterprise Web Services 6

Description

Updates the value of a field that belongs to a principal, SCO, or account.

The principal, SCO, or account belongs to at least one access control list (ACL), which lists the principals that have permission to access the principal, SCO, or account.

Call acl-field-info to determine the fields the principal, SCO, or account has. In the response, you can see the field-id you need for the request to acl-field-update:

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <acl-fields>
        <field acl-id="2006258745" field-id="email">
            <value>joy@acme.com</value> 
        </field> ...
    </acl-fields>
</results>

You can specify multiple trios of acl-id, field-id, and value. If you do, use an HTTP POST method, rather than a GET, to make the request. The GET method has limitations that might cause the request to be truncated. With a POST, you can add about 50 trios to the request.

To call acl-field-update, you need modify permission on the principal, SCO, or account.

Request URL

http://server_name/api/xml
    ?action=acl-field-update
    &acl-id=integer
    &field-id=string
    &value=string
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`acl-id`	Integer	Y	The ID of the SCO, principal, or account. Can be a valid `sco-id`, `account-id`, or `principal-id`.
`field-id`	String	Y	The name of the field for which you want to update value. The field can be a server-defined field or a custom field. A custom field has a field-id starting with `x-`, such as `x-12056`.
`value`	String	Y	The value to set.
`session`	String	N	The value of the `BREEZESESSION` cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue /> 
</results>

Response values

Element	Attribute	Type	Description
`results`		Container	All results the action returns.
`status`		Empty, with attributes	The status of the response.
	`code`	Allowed value	A code indicating the response status (see status).

Sample request

https://example.com/api/xml?action=acl-field-update&acl-id=2006404141
    &field-id=first-name&value=john

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code="ok" /> 
</results>