“”“Add a new partition rule to an existing partition”
Function: add_partition_rule Version: 21.0+
Argument Name |
Type |
Description |
---|---|---|
partition_id |
string |
The id of the partition the new rule will be added to. |
rule |
string |
The rule of the new partition rule being added. |
quantity |
int |
The max quantity of seats this rule should take. |
response
{ "success": true, "error": "", "rule_id": "", "quantity": "", "rule": "", "valid_rule": true, "rule_error": "", "partition_id": "", "reserved": 0, "in_use": 0, "is_unrestricted": true, "licenses": [ { "id": "", "owning_users": [ { "user": "", "id": "" } ], "borrowing_users": [ { "user": "", "id": "" } ] } ] }
Key |
Type |
Description |
---|---|---|
rule_id |
string |
The id of the new rule. |
quantity |
int |
The max quantity of seats this rule can hold. |
rule |
string |
The condition that makes up the rule. |
valid_rule |
boolean |
Indicates if the rule has a valid condition. |
rule_error |
string |
The description of why the rule is invalid. |
partition_id |
string |
The id of the partition this rule belongs to. |
reserved |
int |
The number of seats reserved from this rule. |
in_use |
int |
The number of seats currently checked out from this rule. |
is_unrestricted |
boolean |
Indicates if this rule is from the unrestricted partition. |
licenses |
object |
Holds all licenses that are apart of this partition rule and the users that are checked out as part of this partition rule. |
licenses.id |
string |
The id of the license thats attached to this partition rule. |
licenses.owning_users |
object array |
The list of users from the license that own a seat from this partition rule. |
licenses.owning_users.user |
string |
The user@machine of the user owning a seat from this license. |
licenses.owning_users.id |
string |
The id of the seat this user has currently checked out. |
licenses.borrowing_users |
object array |
The list of users from the license that are borrowing a seat from this partition rule. |
licenses.borrowing_users.user |
string |
The user@machine of the user borrowing a seat from this license. |
licenses.borrowing_users.id |
string |
The id of the seat this user has currently checked out. |