Back to API references

SOAP API method CollectionConstraintRule_constraint

Description

What is the constraint this rule belongs to?

Parameters

Name Type Description
id * int Unique identifier (id) of the object CollectionConstraintRule. The method only applies to the collectionconstraintrule with this id.
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?