Salesforce Docs Portal

ProviderSampleLimitTemplate

Contains definition and rules of sample limits templates.
Important

Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

DeveloperName

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The unique name of the object in the API. The name:
    • must be 40 characters or fewer
    • must begin with a letter
    • can contain only underscores and alphanumeric characters
    • can't include spaces
    • can't end with an underscore
    • can’t contain 2 consecutive underscores
    In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

DiscrepancyAlertType

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specify whether a rule violation in the template is flagged as an error or a warning.
  • Default value: Error
  • Possible values:
    • Error
    • Warning

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether this template is active or not.
  • Default value: false

IsAdvanced

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates the type of custom template. Defines whether or not the template is advanced.
  • Default value: false

IsCloned

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the template is a cloned generic template or not. Cloned generic templates and advanced templates not flagged as IsLawBased are flagged as True.
  • Default value: false

IsLawBased

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether an advanced template is a country regulation or not. (If the template is law-based, the DiscrepancyAlertType setting is Error.)
  • Default value: false

ManageableState

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Indicates the manageable state of the specified component that is contained in a package.
  • Possible values:
    • beta
    • deleted
    • deprecated
    • deprecatedEditable
    • installed
    • installedEditable
    • released
    • unmanaged

MasterLabel

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Label for this provider sample limit template value. This display value is the internal label that doesn't get translated.

NamespacePrefix

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the NAMESPACE_PREFIX__COMPONENT_NAME notation. Replace NAMESPACE_PREFIX with the namespace prefix, and replace COMPONENT_NAME with the component name. The namespace prefix can have one of the following values.
    • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
    • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

PriorityNumber

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Priority order of the cloned generic template to be applied to a product.

RuleCondition

  • Type: textarea
  • Properties: Create, Update
  • Description: Required. The rules that establish the limits for this template.

RuleExpression

  • Type: textarea
  • Properties: Create, Update
  • Description: Required. Specifies the rules to be evaluated and the boolean operation (AND/OR) for combining multiple rules.