Back to API references

SOAP API method CollectionField_retrieve


Name Type Description
id * string The identifier (id) of the object that is retrieved
* required parameters

Return values

Name Type Description
collectionfield Structure of type 'collectionfield' All properties of the retrieved collectionfield

Structure 'collectionfield'

Name Type Description
id int The ID of the collectionfield.
name string The name of the collectionfield.
weight int The weight of the collectionfield.
displayed boolean Is this collectionfield displayed?.
indatatable boolean Is this field added to the data table?
type string The type of this collectionfield.
value string The default value of this collectionfield.
specialcontent string The special content of this collectionfield.
big boolean Is this field a big field?
pixelwidth int The width of this collectionfield.
ordered boolean Is this collectionfield ordered by default?.
length integer Get the length of the collection field
lines integer Get the number of lines of the collection field
hidden boolean Is this a hidden field?
index boolean Is this field indexed?