Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

LimitAllocationPerApp

Represents a connected app quota for an API limit. This object is available in API version 30.0 and later.

LimitAllocationPerApp is currently available through a pilot program. For information on enabling LimitAllocationPerApp for your organization, contact salesforce.com.

Note

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field Name Details
ConnectedAppName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the connected app.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the MasterLabel.
LimitType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description

The type of API limit for which you’re setting a quota. The available values are:

  • TotalRequests—Total API requests per 24-hour period
  • ApiBatchItems—Number of Bulk API batches per 24-hour period 
  • StreamEventsPerDay—Number of Streaming API events per 24–hour period
  • GenStreamingEventsPerDay—Number of generic streaming events per 24–hour period

    Generic streaming is currently available through a pilot program. For information on enabling generic streaming for your organization, contact salesforce.com.

    Note
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Master label for the API limit quota. This is the internal label that does not get translated.
Percentage
Type
int
Properties
Create, Filter, Group, Sort, Update
Description

The percentage of the API limit reserved for the connected app. The app can’t consume more than this percentage of the API limit.

You can find the available percentage for each limit type through the user interface or by using the query() call.

Usage

App quotas for API limits enable you to reserve API capacity for mission-critical connected apps or set a ceiling for API usage of non-critical connected apps.