SOAP API method ImportColumn_setField
Description
If the column is associated with a collection, a collectionfield must be supplied (or the ID or the name of such a field) or 'id' if ID's of subprofiles are stored in the column. If the column is not associated with a collection, a (database)field must be supplied (or the ID or name of a (database)field) or 'id' if ID's of profiles are stored in the column.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object ImportColumn. The method only applies to the importcolumn with this id. |
field | Structure of type 'field' | |
collectionfield | Structure of type 'collectionfield' | |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Structure 'field'
Name | Type | Description |
---|---|---|
id | int | The ID of the field. |
name | string | The name of the field. |
big | boolean | Is this field a big field?. |
pixelwidth | int | The width of this field. |
weight | int | The weight of this field. |
type | string | The type of this field. |
value | string | The default value of this field. |
specialcontent | string | The special content of this field. |
ordered | boolean | Is this the field that we order by by default? |
displayed | boolean | Is this field displayed? |
indatatable | boolean | Is this field added to the data table? |
length | integer | Get the length of the field |
lines | integer | Get the number of lines in this field |
hidden | boolean | Is this field hidden? |
index | boolean | Is this field indexed? |
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? |
Structure 'login'
Name | Type | Description |
---|---|---|
username | string | The username of the login attempt |
account | string | The account name of the login attempt |
password | string | The password for the login attempt |