Root Schema : v1-quota-result
Type: object
The collection of quota groups.
Show Source
{
"description":"The collection of quota groups.",
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/definitions/v1-quota"
}
}
}
}
Nested Schema : items
Type: array
Show Source
{
"type":"array",
"items":{
"$ref":"#/definitions/v1-quota"
}
}
Nested Schema : Quota Manage
Type: object
Title: Quota Manage
Show Source
-
areas:
array Areas
Title: Areas
The array of objects containing the data (that is, quota groups) of a single capacity area or the aggregated result from multiple capacity areas.
-
date:
string(date)
Title: Date
The date specified in the request.
Example: 2016-07-22
{
"type":"object",
"title":"Quota Manage",
"properties":{
"date":{
"type":"string",
"format":"date",
"example":"2016-07-22",
"title":"Date",
"description":"The date specified in the request."
},
"areas":{
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity area.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"name":{
"description":"The name of the capacity area. The parameter is not returned, if the 'aggregateResults' option is enabled.",
"type":"string"
},
"quotaPercent":{
"description":"The quota value in percentage.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum value of the quota. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The total working time of technicians in a particular capacity area and in a particular day.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The total working time in a particular capacity area and in a particular day based on plans.",
"type":"integer"
},
"otherActivities":{
"description":"The total travel time and duration of all activities that are not a part of capacity management.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The percent of the daily quota that is used by the booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0) - QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the 'Locked' option is set for the cell in the Quota View.</li><li>(1 << 1) - QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 3) - QUOTA_STATUS_QUOTA_PERCENT_IS_READWRITE: Defines whether the value of the 'quotaPercent' field can be modified.</li></ul><p>When the operation calculates the values of the flags that define the 'read-write' access, the following points are considered:</p><ul><li>The configuration of the capacity area.</li><li>The restrictions of the modified data in the past (including working hours since midnight).</li></ul><p>Also, the parameter is not returned when its value is equal to 0. It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"categories":{
"description":"The array of objects containing the data (that is, quota groups) for the capacity categories.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The maximum available capacity in the particular capacity category.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The maximum available capacity in the particular capacity category based on plans.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The quota percentage of the capacity category currently used for booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"plan":{
"description":"The planned workload obtained from the Forecasting module.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0): QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the \"Locked\" option is set for the cell in the Quota view.</li><li>(1 << 1): QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 4) - QUOTA_STATUS_QUOTA_PERCENT_DAY_IS_READWRITE: Defines whether the value of the 'quotaPercent Day' field can be modified.</li><li>(1 << 5) - QUOTA_STATUS_QUOTA_PERCENT_CATEGORY_IS_READWRITE: Defines whether the value of the 'quotaPercentCategory' field can be modified.</li><li>(1 << 6) - QUOTA_STATUS_STOP_BOOKING_AT_IS_READWRITE: Defines whether the value of the 'stopBookingAt' field can be modified. Also, this field is not returned when its value is equal to 0.</li><p>It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"intervals":{
"description":"The array of quota limits within the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
}
},
"title":"Areas",
"description":"The array of objects containing the data (that is, quota groups) of a single capacity area or the aggregated result from multiple capacity areas."
}
}
}
Nested Schema : Areas
Type: array
Title: Areas
The array of objects containing the data (that is, quota groups) of a single capacity area or the aggregated result from multiple capacity areas.
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity area.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"name":{
"description":"The name of the capacity area. The parameter is not returned, if the 'aggregateResults' option is enabled.",
"type":"string"
},
"quotaPercent":{
"description":"The quota value in percentage.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum value of the quota. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The total working time of technicians in a particular capacity area and in a particular day.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The total working time in a particular capacity area and in a particular day based on plans.",
"type":"integer"
},
"otherActivities":{
"description":"The total travel time and duration of all activities that are not a part of capacity management.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The percent of the daily quota that is used by the booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0) - QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the 'Locked' option is set for the cell in the Quota View.</li><li>(1 << 1) - QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 3) - QUOTA_STATUS_QUOTA_PERCENT_IS_READWRITE: Defines whether the value of the 'quotaPercent' field can be modified.</li></ul><p>When the operation calculates the values of the flags that define the 'read-write' access, the following points are considered:</p><ul><li>The configuration of the capacity area.</li><li>The restrictions of the modified data in the past (including working hours since midnight).</li></ul><p>Also, the parameter is not returned when its value is equal to 0. It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"categories":{
"description":"The array of objects containing the data (that is, quota groups) for the capacity categories.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The maximum available capacity in the particular capacity category.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The maximum available capacity in the particular capacity category based on plans.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The quota percentage of the capacity category currently used for booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"plan":{
"description":"The planned workload obtained from the Forecasting module.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0): QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the \"Locked\" option is set for the cell in the Quota view.</li><li>(1 << 1): QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 4) - QUOTA_STATUS_QUOTA_PERCENT_DAY_IS_READWRITE: Defines whether the value of the 'quotaPercent Day' field can be modified.</li><li>(1 << 5) - QUOTA_STATUS_QUOTA_PERCENT_CATEGORY_IS_READWRITE: Defines whether the value of the 'quotaPercentCategory' field can be modified.</li><li>(1 << 6) - QUOTA_STATUS_STOP_BOOKING_AT_IS_READWRITE: Defines whether the value of the 'stopBookingAt' field can be modified. Also, this field is not returned when its value is equal to 0.</li><p>It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"intervals":{
"description":"The array of quota limits within the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
}
},
"title":"Areas",
"description":"The array of objects containing the data (that is, quota groups) of a single capacity area or the aggregated result from multiple capacity areas."
}
Nested Schema : items
Type: object
Show Source
-
categories:
array categories
The array of objects containing the data (that is, quota groups) for the capacity categories.
-
count:
integer
The number of booked activities.
-
label:
string
Minimum Length: 1
Maximum Length: 40
The label of the capacity area.
-
maxAvailable:
integer
The total working time of technicians in a particular capacity area and in a particular day.
-
maxAvailableByPlans:
integer
The total working time in a particular capacity area and in a particular day based on plans.
-
minQuota:
integer
The minimum value of the quota.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
name:
string
The name of the capacity area. The parameter is not returned, if the 'aggregateResults' option is enabled.
-
otherActivities:
integer
The total travel time and duration of all activities that are not a part of capacity management.
-
quota:
integer
The quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quotaPercent:
number(float)
The quota value in percentage.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
status:
integer
The bitmask parameter that defines the status of the quota cell. The following flags are available:
- (1 << 0) - QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the 'Locked' option is set for the cell in the Quota View.
- (1 << 1) - QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.
- (1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.
- (1 << 3) - QUOTA_STATUS_QUOTA_PERCENT_IS_READWRITE: Defines whether the value of the 'quotaPercent' field can be modified.
When the operation calculates the values of the flags that define the 'read-write' access, the following points are considered:
- The configuration of the capacity area.
- The restrictions of the modified data in the past (including working hours since midnight).
Also, the parameter is not returned when its value is equal to 0. It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.
-
used:
integer
The amount of existing capacity consumed in minutes.
-
usedQuotaPercent:
number(float)
The percent of the daily quota that is used by the booked activities.
{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity area.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"name":{
"description":"The name of the capacity area. The parameter is not returned, if the 'aggregateResults' option is enabled.",
"type":"string"
},
"quotaPercent":{
"description":"The quota value in percentage.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum value of the quota. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The total working time of technicians in a particular capacity area and in a particular day.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The total working time in a particular capacity area and in a particular day based on plans.",
"type":"integer"
},
"otherActivities":{
"description":"The total travel time and duration of all activities that are not a part of capacity management.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The percent of the daily quota that is used by the booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0) - QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the 'Locked' option is set for the cell in the Quota View.</li><li>(1 << 1) - QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 3) - QUOTA_STATUS_QUOTA_PERCENT_IS_READWRITE: Defines whether the value of the 'quotaPercent' field can be modified.</li></ul><p>When the operation calculates the values of the flags that define the 'read-write' access, the following points are considered:</p><ul><li>The configuration of the capacity area.</li><li>The restrictions of the modified data in the past (including working hours since midnight).</li></ul><p>Also, the parameter is not returned when its value is equal to 0. It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"categories":{
"description":"The array of objects containing the data (that is, quota groups) for the capacity categories.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The maximum available capacity in the particular capacity category.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The maximum available capacity in the particular capacity category based on plans.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The quota percentage of the capacity category currently used for booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"plan":{
"description":"The planned workload obtained from the Forecasting module.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0): QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the \"Locked\" option is set for the cell in the Quota view.</li><li>(1 << 1): QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 4) - QUOTA_STATUS_QUOTA_PERCENT_DAY_IS_READWRITE: Defines whether the value of the 'quotaPercent Day' field can be modified.</li><li>(1 << 5) - QUOTA_STATUS_QUOTA_PERCENT_CATEGORY_IS_READWRITE: Defines whether the value of the 'quotaPercentCategory' field can be modified.</li><li>(1 << 6) - QUOTA_STATUS_STOP_BOOKING_AT_IS_READWRITE: Defines whether the value of the 'stopBookingAt' field can be modified. Also, this field is not returned when its value is equal to 0.</li><p>It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"intervals":{
"description":"The array of quota limits within the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
}
}
Nested Schema : categories
Type: array
The array of objects containing the data (that is, quota groups) for the capacity categories.
Show Source
{
"description":"The array of objects containing the data (that is, quota groups) for the capacity categories.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The maximum available capacity in the particular capacity category.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The maximum available capacity in the particular capacity category based on plans.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The quota percentage of the capacity category currently used for booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"plan":{
"description":"The planned workload obtained from the Forecasting module.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0): QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the \"Locked\" option is set for the cell in the Quota view.</li><li>(1 << 1): QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 4) - QUOTA_STATUS_QUOTA_PERCENT_DAY_IS_READWRITE: Defines whether the value of the 'quotaPercent Day' field can be modified.</li><li>(1 << 5) - QUOTA_STATUS_QUOTA_PERCENT_CATEGORY_IS_READWRITE: Defines whether the value of the 'quotaPercentCategory' field can be modified.</li><li>(1 << 6) - QUOTA_STATUS_STOP_BOOKING_AT_IS_READWRITE: Defines whether the value of the 'stopBookingAt' field can be modified. Also, this field is not returned when its value is equal to 0.</li><p>It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"intervals":{
"description":"The array of quota limits within the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
-
count:
integer
The number of booked activities.
-
intervals:
array intervals
The array of quota limits within the booking intervals.
-
label:
string
Minimum Length: 1
Maximum Length: 40
The label of the capacity category.
-
maxAvailable:
integer
The maximum available capacity in the particular capacity category.
-
maxAvailableByPlans:
integer
The maximum available capacity in the particular capacity category based on plans.
-
minQuota:
integer
The minimum quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
plan:
integer
The planned workload obtained from the Forecasting module.
-
quota:
integer
The quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quotaPercentCategory:
number(float)
The quota value defined as a percent of the Max Available value of the capacity category.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quotaPercentDay:
number(float)
The quota value defined as a percent of the daily quota value of the capacity category.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
status:
integer
The bitmask parameter that defines the status of the quota cell. The following flags are available:
-
stopBookingAt:
integer
The percent at which the booking of activities stops for the timeslot-based quota.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
used:
integer
The amount of existing capacity consumed in minutes.
-
usedQuotaPercent:
number(float)
The quota percentage of the capacity category currently used for booked activities.
{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"maxAvailable":{
"description":"The maximum available capacity in the particular capacity category.",
"type":"integer"
},
"maxAvailableByPlans":{
"description":"The maximum available capacity in the particular capacity category based on plans.",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"usedQuotaPercent":{
"description":"The quota percentage of the capacity category currently used for booked activities.",
"type":"number",
"format":"float"
},
"count":{
"description":"The number of booked activities.",
"type":"integer"
},
"plan":{
"description":"The planned workload obtained from the Forecasting module.",
"type":"integer"
},
"status":{
"description":"The bitmask parameter that defines the status of the quota cell. The following flags are available:<ul><li>(1 << 0): QUOTA_STATUS_AUTO_ADJUSTMENT_OF_QUOTA_IS_BLOCKED: Defines whether the \"Locked\" option is set for the cell in the Quota view.</li><li>(1 << 1): QUOTA_STATUS_QUOTA_IS_READWRITE: Defines whether the value of the 'quota' field can be modified.</li><li>(1 << 2) - QUOTA_STATUS_MIN_QUOTA_IS_READWRITE: Defines whether the value of the 'minQuota' field can be modified.</li><li>(1 << 4) - QUOTA_STATUS_QUOTA_PERCENT_DAY_IS_READWRITE: Defines whether the value of the 'quotaPercent Day' field can be modified.</li><li>(1 << 5) - QUOTA_STATUS_QUOTA_PERCENT_CATEGORY_IS_READWRITE: Defines whether the value of the 'quotaPercentCategory' field can be modified.</li><li>(1 << 6) - QUOTA_STATUS_STOP_BOOKING_AT_IS_READWRITE: Defines whether the value of the 'stopBookingAt' field can be modified. Also, this field is not returned when its value is equal to 0.</li><p>It is a regular mode for past days and the 'aggregate' mode when all fields are read-only.</p>",
"type":"integer"
},
"intervals":{
"description":"The array of quota limits within the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
Nested Schema : intervals
Type: array
The array of quota limits within the booking intervals.
Show Source
{
"description":"The array of quota limits within the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
Nested Schema : items
Type: object
Show Source
-
quota:
integer
The quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
status:
integer
The status of the quota value.
It has the following modes:
- Regular: Populates quota values from the past days.
- Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.
-
timeFrom:
string
The start time of the time interval in HH:MM format.
Example: 12:30
-
timeTo:
string
The end time of the time interval in HH:MM format.
Example: 14:00
-
used:
integer
The amount of existing capacity consumed in minutes.
{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}