Namespace: "urn:zimbraAdmin"
GetAttributeInfo SOAP Command

Get attribute information

Authorization token required true
Admin Authorization token required true

GetAttributeInfoRequest

Only one of attrs or entryTypes can be specified.
If both are specified, INVALID_REQUEST will be thrown.
If neither is specified, all attributes will be returned.

    <GetAttributeInfoRequest [attrs="{attrs-to-return}"] [entryTypes="{entry-types}"] /> ## GetAttributeInfoRequest

The following table describes elements and attributes you can define within a <GetAttributeInfoRequest> element:

XPath Required / Optional Description
@attrs Optional (0 or 1) Type:String
Comma separated list of attributes to return
@entryTypes Optional (0 or 1) Type:String
Comma separated list of entry types. Attributes on the specified entry types will be returned.
valid entry types:
     account,alias,distributionList,cos,globalConfig,domain,server,mimeEntry,zimletEntry,
     calendarResource,identity,dataSource,pop3DataSource,imapDataSource,rssDataSource,
     liveDataSource,galDataSource,signature,xmppComponent,aclTarget.oauth2DataSource
 

GetAttributeInfoResponse

    <GetAttributeInfoResponse> ## GetAttributeInfoResponse
        (<a n="{attr-name}" desc="{attr-desc}" /> ## AttributeDescription)*
    </GetAttributeInfoResponse>

The following table describes elements and attributes you can define within a <GetAttributeInfoResponse> element:

XPath Required / Optional Description
/a Optional (0 or more) Attribute descriptions
/a@n Required (only 1) Type:String
Attribute name
/a@desc Required (only 1) Type:String
Attribute description