Create custom fields

Custom fields are additional data fields that you define. You can define up to eight custom fields on a principal or SCO using custom-field-update.

Once you define the custom field, by default you can set its value either by editing the value in Connect Enterprise Manager or by calling custom-field-update.

To specify that the value can only be updated through the API, call custom-field-update with the parameter object-type=object-type-read-only.

Define a custom field and set it on a user

First, create the field with custom-field-update:

https://example.com/api/xml?action=custom-field-update
    &object-type=object-type-principal&permission-id=manage
    &account-id=624520&name=Location&comments=adobe%20location
    &field-type=text&is-required=true&is-primary=false&display-seq=9

The name field defines the field name as your application displays it, so use appropriate spelling and capitalization. The custom field in this example is defined for all Connect Enterprise principals.

Parse the field element in the response for the field-id:

<field field-id="2007184366" object-type="object-type-principal"
        display-seq="9" account-id="624520" is-primary="false" 
        permission-id="manage" is-required="true" field-type="text">
  <comments>test</comments> 
  <name>Country</name> 
</field>

Get the principal-id of the user (see "Find a principal-id").

Call acl-field-update to set the value of the field, passing a field-id, the user's principal-id as acl-id, and a value:

https://example.com/api/xml?action=acl-field-update
    &acl-id=2006258745&field-id=2007017474&value=San%20Francisco

Parse the response for a status code of ok.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/03_perm6.htm