DisclosureDefinitionVersion

Represents the version information about the disclosure definition. This object is available in API version 57.0 and later.

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

DELETE, GET, HEAD, PATCH, POST, Query

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Specifies the authoring mode used to launch the disclosure authoring experience.

  • Possible values:

    • Microsoft365Word—Microsoft 365 Word
    • OmniScriptAndMcrsft365Wrd—OmniScript and Microsoft 365 Word
    • OmniScriptForm—OmniScript Form
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The description of the disclosure definition version.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The unique name for the DisclosureDefinitionVersion object. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two 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. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description: The name of the disclosure definition associated with the version. This field is a relationship field.

  • Possible values:

    • SFTemplateForCsrd—Salesforce Template for CSRD
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The document template global key associated with the DOCX template for the disclosure definition version.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the disclosure definition version is an active version (true) or not (false).
  • Default value: false
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether this is the current version of the disclosure definition (true) or not (false).
  • Default value: false

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: The language of the DisclosureDefinitionVersion.

  • Possible values:

    • da—Danish
    • de—German
    • en_US—English
    • es—Spanish
    • es_MX—Spanish (Mexico)
    • fi—Finnish
    • fr—French
    • it—Italian
    • ja—Japanese
    • ko—Korean
    • nl_NL—Dutch
    • no—Norwegian
    • pt_BR—Portuguese (Brazil)
    • ru—Russian
    • sv—Swedish
    • th—Thai
    • zh_CN—Chinese (Simplified)
    • zh_TW—Chinese (Traditional)

  • Type: ManageableState enumerated list

  • Properties: Filter, Group, Nillable, Restricted picklist, Sort

  • Description: Indicates the manageable state of the specified component that is contained in a package:

    • beta
    • deleted
    • deprecated
    • deprecatedEditable
    • installed
    • installedEditable
    • released
    • unmanaged
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Label for the DisclosureDefinitionVersion.

  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Description: The namespace prefix associated with this object. Each Developer Edition organization 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.

    The namespace prefix can have one of the following values:

    • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if 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 organization of the package developer.
    • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The API name of the OmniScript configuration that’s associated with the disclosure definition version.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: The OmniScript configuration that’s associated with the disclosure definition version.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The version of the disclosure definition published by the author.