Quota API Reference
API Reference/Quota

Quota

For authentication instructions, see API overview.

Endpoints

get/api/v2//quota-plans
post/api/v2//quota-plans
get/api/v2/quota-plans/:id
put/api/v2/quota-plans/:id
patch/api/v2/quota-plans/:id
delete/api/v2/quota-plans/deleted/:id
get

List all quota plans

Returns a list of quota plans. The quota plans are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2//quota-plans

Response

No response schema
post

Create quota plans

Create quota plans. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • planNamestring
  • planUomstring
  • uomColumnstring
  • uomObjectstring
  • quotaPeriodSetupstring
  • salesQuotasPlanningarray
  • membersarray
  • quotaplanNumbernumber
  • deletedboolean
  • realmIdstring
  • incentiveplanIdstring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2//quota-plans \
	-d 'planName="string"' \
	-d 'planUom="string"' \
	-d 'uomColumn="string"' \
	-d 'uomObject="string"' \
	-d 'quotaPeriodSetup="string"' \
	-d 'salesQuotasPlanning="array"' \
	-d 'members="array"' \
	-d 'quotaplanNumber="number"' \
	-d 'deleted="boolean"' \
	-d 'realmId="string"' \
	-d 'incentiveplanId="string"'

Response

No response schema
get

Retrieve quota plans

Returns a single quota plan, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the quota plan

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/quota-plans/:id

Response

No response schema
put

Update quota plans

Path parameters

  • idstring

    ID of the quota plan

Request body

  • planNamestring
  • planUomstring
  • uomColumnstring
  • uomObjectstring
  • quotaPeriodSetupstring
  • salesQuotasPlanningarray
  • membersarray
  • quotaplanNumbernumber
  • deletedboolean
  • realmIdstring
  • incentiveplanIdstring

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/quota-plans/:id \
	-d 'planName="string"' \
	-d 'planUom="string"' \
	-d 'uomColumn="string"' \
	-d 'uomObject="string"' \
	-d 'quotaPeriodSetup="string"' \
	-d 'salesQuotasPlanning="array"' \
	-d 'members="array"' \
	-d 'quotaplanNumber="number"' \
	-d 'deleted="boolean"' \
	-d 'realmId="string"' \
	-d 'incentiveplanId="string"'

Response

No response schema
patch

Update quota plans soft

Update quota plans soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the quota plan

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/quota-plans/:id

Response

No response schema
delete

Delete quota plans

Path parameters

  • idstring

    ID of the quota plan

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/quota-plans/deleted/:id

Response

No response schema