Delete Quotas API
This API is used to deactivate quotas.
Command
"client/deleteQuotas/1"
Inputs
The following values are expected in the JSON body:
Name | Type | Required | Description |
---|---|---|---|
command | String | Must be "client/deleteQuotas/1" |
|
rfg_id | String | RFG project identifier. This is the identifier you received when you submitted the project. |
|
quota_ids | String[] | Array of quota identifiers that correspond to the quotas that should be deactivated. Either this parameter or deleteAll=true must be present. |
|
deleteAll | Boolean | True if all the quotas in the project should be deactivated. Either this parameter with a true value or the quota_ids parameter must be present. |
Outputs
The JSON output will always contain the original command and a result. If the result > 0, an error has occurred (refer to Error Codes) and a message field will describe the error. If result = 0, the command succeeded and there will not be response field.
Example Command
{
command : "client/deleteQuotas/1",
rfg_id : "RFG12345-001",
quota_ids : ["RFG12345-001- q2","RFG12345-001- q5"]
}
{
command : "client/deleteQuotas/1",
rfg_id : "RFG12345-001",
deleteAll : true
}