SOAP API method Collection_createConstraint

Back to API references

Description
Create a new constraint on the collection

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
Parameter 'name' : string
Name of the new constraint
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'databaseconstraint' : Structure of type 'databaseconstraint'
Return value 'collectionconstraint' : Structure of type 'collectionconstraint'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'databaseconstraint'
This structure databaseconstraint was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the constraint.
Property 'name' : string
The name of the constraint.
Property 'description' : string
Description of the constraint
Property 'disabled' : boolean
Is this constraint disabled?

Structure 'collectionconstraint'
This structure collectionconstraint was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the constraint.
Property 'name' : string
The name of the constraint.
Property 'description' : string
Description of the constraint
Property 'disabled' : boolean
Is this constraint disabled?