SOAP API method Collection_createConstraint
Description
Create a new constraint on the collection
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object Collection. The method only applies to the collection with this id. |
name * | string | Name of the new constraint |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
databaseconstraint | Structure of type 'databaseconstraint' | |
collectionconstraint | Structure of type 'collectionconstraint' |
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 'databaseconstraint'
Name | Type | Description |
---|---|---|
id | int | The ID of the constraint. |
name | string | The name of the constraint. |
description | string | Description of the constraint |
disabled | boolean | Is this constraint disabled? |
Structure 'collectionconstraint'
Name | Type | Description |
---|---|---|
id | int | The ID of the constraint. |
name | string | The name of the constraint. |
description | string | Description of the constraint |
disabled | boolean | Is this constraint disabled? |