Update Quota API

This API is used to add a quota to a previously submitted project.


Command

"client/updateQuota/1"


Inputs

The following values are expected in the JSON body:

Name Type Required Description
command String

Must be "client/updateQuota/1"

rfg_id String

RFG project identifier. This is the identifier you received when you submitted the project.

quota_id String

Quota identifier that you received when you first added this quota.

datapoints Object[]

Array of JSON objects that contains the datapoints considered by this quota, its structure should be the same as the one used in the datapoints array of the project.

limit Integer

Number of starts or completes (determined by the project-level field, quotaLimitBy) that are available for the quota.


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/updateQuota/1",
     rfg_id : "RFG12345-001",
     quota_id : "RFG12345-001- q2",
     datapoints:[
          {
               name:"Gender",
               values:[1]
          },
          {
               name:"Ethnicity (US)",
               values:[3,6]
          }
     ],
     limit:20
}