ContextAttribute

Represents information about an attribute used to describe a context node. Each node can have one or many attributes associated with it. This object is available in API version 59.0 and later.

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

ContextNodeId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The context node record that's associated with the context attribute.

    This field is a relationship field.

  • Relationship Name: ContextNode
  • Relationship Type: Lookup
  • Refers To: ContextNode

DataType

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies the type of data that's stored in the context attribute.
  • Default value: string
  • Possible values:
    • booleanBoolean
    • currency—Currency
    • date—Date
    • datetime—Datetime
    • lookup—Lookup
    • number—Number
    • percent—Percent
    • picklist—Picklist
    • reference—Reference
    • string—String

DomainSet

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The list of node references to show a parent-child relationship between nodes in a definition.

FieldType

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: List of node references to depict parent/child relation between the nodes in a definition
  • Default value: input
  • Possible values:
    • input—INPUT
    • inputoutput—INPUTOUTPUT
    • output—OUTPUT

IsKey

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the attribute is a key attribute in the node (true) or not (false).
  • Default value: false

IsLocalizationDisabled

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the context attribute is to be localized or not

    This field is available in API version 68.0 and later.

  • Default value: false

IsTransient

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates if an attribute must be skipped in context persistence.
  • Default value: false

IsValue

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates the attribute that identifies as a value in a node.
  • 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—Managed-Beta
    • deleted—Managed-Proposed-Deleted
    • deprecated—Managed-Proposed-Deprecated
    • deprecatedEditable—SecondGen-Installed-Deprecated
    • installed—Managed-Installed
    • installedEditable—SecondGen-Installed-Editable
    • released—Managed-Released
    • unmanaged—Unmanaged

Title

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The name of the context attribute.

InheritedFrom

  • Type: string
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The name of the parent attribute that's used to derive the current attribute. This field is available in API version 60.0 and later.