custom-fields

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Lists all custom fields defined in an account and details about the fields.

Custom fields provide information about objects (SCOs) or principals that is not already defined in Adobe Connect Enterprise Manager. You can create custom fields, or update their value, using custom-field-update.

Request URL

http://server_name/api/xml
    ?action=custom-fields
    &filter-definition=value
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
filter-definition	Filter definition	N	A filter to reduce the volume of the response.
`session`	String	N	The value of the `BREEZESESSION` cookie`.` Use this parameter if you do not use a client-side cookie management library.

Filters

You can filter the response on any element or attribute it contains.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code=allowedValue /> 
    <custom-fields>
        <field permission-id=allowedValue object-type=allowedValue 
                field-id=string account-id=integer display-seq=integer
                field-type=allowedValue is-primary=boolean is-required=boolean>
            <name>string</name> 
        </field>
    </custom-fields>
</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).
`custom-fields`		Container	The list of custom fields that match the query.
`field`		Container	Details about one custom field.
	`permission-id`	Allowed value	The permission the current user has to access the custom field (see permission-id for values).
	`object-type`	Allowed value	The type of object the custom field describes (see permission-id for values).
	`field-id`	String	The name of the field, as identified on the server.
	`account-id`	Integer	The ID of the account in which the custom field is defined.
	`display-seq`	Integer	The sequence in which Enterprise Manager or your application displays the custom field, relative to other custom fields.
	`field-type`	Allowed value	The type of data the custom field accepts. Allowed values are `text`, `textarea`, and `password`.
	`is-primary`	Boolean	Whether the custom field can be deleted (`true` if no, and `false` if yes).
	`is-required`	Boolean	Whether this custom field is required. `true` if a value must be specified for this field in each object that uses it. Otherwise, `false`.
`name`		String	The name of the custom field as Enterprise Manager or your application displays it.

Sample request

https://example.com/api/xml?action=custom-fields&filter-like-name=name

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <custom-fields>
        <field permission-id="manage" object-type="object-type-principal" 
                field-id="first-name" account-id="624520" display-seq="1" 
                field-type="text" is-primary="true" is-required="true">
            <name>First Name</name> 
        </field>
        <field permission-id="manage" object-type="object-type-principal" 
                field-id="last-name" account-id="624520" display-seq="2" 
                field-type="text" is-primary="true" is-required="true">
            <name>Last Name</name> 
        </field>
    </custom-fields>
</results>