Back to API references

SOAP API method Collection_constraint

Description

A single constraint of this collection

Parameters

Name Type Description
id * int Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
identifier * int identifier
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
collectionconstraint Structure of type 'collectionconstraint'
databaseconstraint Structure of type 'databaseconstraint'

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 '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?

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?