SOAP API method CollectionConstraint_rule
Description
A single rule of this constraint.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object CollectionConstraint. The method only applies to the collectionconstraint with this id. |
| identifier * | int | ID of the rule |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| collectionconstraintrule | Structure of type 'collectionconstraintrule' | |
| databaseconstraintrule | Structure of type 'databaseconstraintrule' |
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 |
Structure 'collectionconstraintrule'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the constraint rule. |
| name | string | The name of the constraint rule. |
| disabled | boolean | Is this rule disabled? |
Structure 'databaseconstraintrule'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the constraint rule. |
| name | string | The name of the constraint rule. |
| disabled | boolean | Is this rule disabled? |