GET v1/Surveys/{surveyId}/QuotaTargets/{eTag}
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Supervisor
Scripter
LimitedUser
QuotaManager
OperationsUser
SampleManager
DemoUser
Permissions required to make this request:
SurveyQuotaFrame.Read
Survey.Read
Supports survey simulations
This method retrieves a Full QuotaFrame structure based on survey. The successful counts are also retrieved
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
The id of the survey |
string |
Required |
eTag |
The ETag version of the quota |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a list of quota level targets
Response Message
SurveysQuotaFrameResponseModelName | Description | Type | Additional information |
---|---|---|---|
Id | string |
None. |
|
Variables | Collection of SurveysQuotaFrameVariable |
None. |
|
Target |
Target counts |
integer |
None. |
Successful |
Successful counts, only retrieved when ETag is specified |
integer |
None. |
Response Formats
application/json, text/json
{ "Id": "sample string 1", "Variables": [ { "Id": "ccb81cac-91ed-400c-9061-93b961bc1646", "Name": "sample string 2", "IsMulti": true, "Levels": [ { "Id": "4924c09a-3355-4ed3-9a2a-02d116a1200e", "Name": "sample string 2", "Variables": [], "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Successful": 3, "DisplayIndex": 4 }, { "Id": "4924c09a-3355-4ed3-9a2a-02d116a1200e", "Name": "sample string 2", "Variables": [], "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Successful": 3, "DisplayIndex": 4 } ], "DisplayIndex": 4 }, { "Id": "ccb81cac-91ed-400c-9061-93b961bc1646", "Name": "sample string 2", "IsMulti": true, "Levels": [ { "Id": "4924c09a-3355-4ed3-9a2a-02d116a1200e", "Name": "sample string 2", "Variables": [], "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Successful": 3, "DisplayIndex": 4 }, { "Id": "4924c09a-3355-4ed3-9a2a-02d116a1200e", "Name": "sample string 2", "Variables": [], "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Successful": 3, "DisplayIndex": 4 } ], "DisplayIndex": 4 } ], "Target": 1, "Successful": 2 }
application/xml
Sample not available.
text/xml
Sample not available.