Salesforce Clone API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Clone API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Clone
paths:
  /data/v64.0/ui-api/record-defaults/clone/{RECORD_ID}:
    parameters: []
    get:
      tags:
      - Clone
      summary: Salesforce Get Default Values to Clone a Record
      description: 'Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.

        The response contains the default field values for a record cloned from the record specified in <RECORD_ID>, optionally of the specified recordTypeId.


        It also contains the corresponding layout information for edit mode. In the Salesforce user interface, an admin with “Customize Application” permission can mark a field as required in a layout. When you’re building UI, to determine which fields to mark as required in a layout for edit mode, use the RecordLayoutItem.required property.


        The response contains object metadata for the object type of the record specified in <RECORD_ID> and for any nested objects. For example, /ui-api/record-defaults/clone/001d000000AtfRIAAZ is a request to clone an Account record. It returns object metadata for Account and User, because the OwnerId field on the Account object contains a reference to the User object.'
      operationId: GetDefaultValuestoCloneaRecord
      parameters:
      - name: RECORD_ID
        in: path
        description: Record ID
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 27 Sep 2023 16:01:45 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetDefaultValuestoCloneaRecord'
              examples:
                Getdefaultvaluestoclonearecord200Example:
                  summary: Default GetDefaultValuestoCloneaRecord 200 response
                  x-microcks-default: true
                  value:
                    layout:
                      eTag: example_value
                      id: abc123
                      layoutType: example_value
                      mode: example_value
                      objectApiName: example_value
                      recordTypeId: '500123'
                      saveOptions:
                      - {}
                      sections:
                      - {}
                    objectInfos: {}
                    record:
                      apiName: example_value
                      childRelationships: example_value
                      eTag: example_value
                      id: abc123
                      lastModifiedById: '500123'
                      lastModifiedDate: example_value
                      recordTypeId: '500123'
                      recordTypeInfo: example_value
                      systemModstamp: example_value
                      weakEtag: 10
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    BadgeText:
      title: BadgeText
      required:
      - apiName
      - calculated
      - compound
      - compoundComponentName
      - compoundFieldName
      - controllerName
      - controllingFields
      - createable
      - custom
      - dataType
      - extraTypeInfo
      - filterable
      - filteredLookupInfo
      - highScaleNumber
      - htmlFormatted
      - inlineHelpText
      - label
      - length
      - nameField
      - polymorphicForeignKey
      - precision
      - reference
      - referenceTargetField
      - referenceToInfos
      - relationshipName
      - required
      - scale
      - searchPrefilterable
      - sortable
      - unique
      - updateable
      type: object
      properties:
        apiName:
          type: string
          example: example_value
        calculated:
          type: boolean
          example: true
        compound:
          type: boolean
          example: true
        compoundComponentName:
          type:
          - string
          - 'null'
          example: example_value
        compoundFieldName:
          type:
          - string
          - 'null'
          example: example_value
        controllerName:
          type:
          - string
          - 'null'
          example: example_value
        controllingFields:
          type: array
          items:
            type: string
          description: ''
          example: []
        createable:
          type: boolean
          example: true
        custom:
          type: boolean
          example: true
        dataType:
          type: string
          example: example_value
        extraTypeInfo:
          type:
          - string
          - 'null'
          example: example_value
        filterable:
          type: boolean
          example: true
        filteredLookupInfo:
          type:
          - string
          - 'null'
          example: example_value
        highScaleNumber:
          type: boolean
          example: true
        htmlFormatted:
          type: boolean
          example: true
        inlineHelpText:
          type:
          - string
          - 'null'
          example: example_value
        label:
          type: string
          example: Example Title
        length:
          type: integer
          contentEncoding: int32
          example: 10
        nameField:
          type: boolean
          example: true
        polymorphicForeignKey:
          type: boolean
          example: true
        precision:
          type: integer
          contentEncoding: int32
          example: 10
        reference:
          type: boolean
          example: true
        referenceTargetField:
          type:
          - string
          - 'null'
          example: example_value
        referenceToInfos:
          type: array
          items:
            type: string
          description: ''
          example: []
        relationshipName:
          type:
          - string
          - 'null'
          example: example_value
        required:
          type: boolean
          example: true
        scale:
          type: integer
          contentEncoding: int32
          example: 10
        searchPrefilterable:
          type: boolean
          example: true
        sortable:
          type: boolean
          example: true
        unique:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
      examples:
      - apiName: BadgeText
        calculated: false
        compound: false
        compoundComponentName: null
        compoundFieldName: null
        controllerName: null
        controllingFields: []
        createable: false
        custom: false
        dataType: String
        extraTypeInfo: null
        filterable: true
        filteredLookupInfo: null
        highScaleNumber: false
        htmlFormatted: false
        inlineHelpText: null
        label: User Photo badge text overlay
        length: 80
        nameField: false
        polymorphicForeignKey: false
        precision: 0
        reference: false
        referenceTargetField: null
        referenceToInfos: []
        relationshipName: null
        required: false
        scale: 0
        searchPrefilterable: false
        sortable: true
        unique: false
        updateable: false
    SicDesc1:
      title: SicDesc1
      required:
      - apiName
      - calculated
      - compound
      - compoundComponentName
      - compoundFieldName
      - controllerName
      - controllingFields
      - createable
      - custom
      - dataType
      - extraTypeInfo
      - filterable
      - filteredLookupInfo
      - highScaleNumber
      - htmlFormatted
      - inlineHelpText
      - label
      - length
      - nameField
      - polymorphicForeignKey
      - precision
      - reference
      - referenceTargetField
      - referenceToInfos
      - relationshipName
      - required
      - scale
      - searchPrefilterable
      - sortable
      - unique
      - updateable
      type: object
      properties:
        apiName:
          type: string
          example: example_value
        calculated:
          type: boolean
          example: true
        compound:
          type: boolean
          example: true
        compoundComponentName:
          type:
          - string
          - 'null'
          example: example_value
        compoundFieldName:
          type:
          - string
          - 'null'
          example: example_value
        controllerName:
          type:
          - string
          - 'null'
          example: example_value
        controllingFields:
          type: array
          items:
            type: string
          description: ''
          example: []
        createable:
          type: boolean
          example: true
        custom:
          type: boolean
          example: true
        dataType:
          type: string
          example: example_value
        extraTypeInfo:
          type:
          - string
          - 'null'
          example: example_value
        filterable:
          type: boolean
          example: true
        filteredLookupInfo:
          type:
          - string
          - 'null'
          example: example_value
        highScaleNumber:
          type: boolean
          example: true
        htmlFormatted:
          type: boolean
          example: true
        inlineHelpText:
          type:
          - string
          - 'null'
          example: example_value
        label:
          type: string
          example: Example Title
        length:
          type: integer
          contentEncoding: int32
          example: 10
        nameField:
          type: boolean
          example: true
        polymorphicForeignKey:
          type: boolean
          example: true
        precision:
          type: integer
          contentEncoding: int32
          example: 10
        reference:
          type: boolean
          example: true
        referenceTargetField:
          type:
          - string
          - 'null'
          example: example_value
        referenceToInfos:
          type: array
          items:
            type: string
          description: ''
          example: []
        relationshipName:
          type:
          - string
          - 'null'
          example: example_value
        required:
          type: boolean
          example: true
        scale:
          type: integer
          contentEncoding: int32
          example: 10
        searchPrefilterable:
          type: boolean
          example: true
        sortable:
          type: boolean
          example: true
        unique:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
      examples:
      - apiName: SicDesc
        calculated: false
        compound: false
        compoundComponentName: null
        compoundFieldName: null
        controllerName: null
        controllingFields: []
        createable: true
        custom: false
        dataType: String
        extraTypeInfo: null
        filterable: true
        filteredLookupInfo: null
        highScaleNumber: false
        htmlFormatted: false
        inlineHelpText: null
        label: SIC Description
        length: 80
        nameField: false
        polymorphicForeignKey: false
        precision: 0
        reference: false
        referenceTargetField: null
        referenceToInfos: []
        relationshipName: null
        required: false
        scale: 0
        searchPrefilterable: false
        sortable: true
        unique: false
        updateable: true
    UserPreferencesLightningExperiencePreferred:
      title: UserPreferencesLightningExperiencePreferred
      required:
      - apiName
      - calculated
      - compound
      - compoundComponentName
      - compoundFieldName
      - controllerName
      - controllingFields
      - createable
      - custom
      - dataType
      - extraTypeInfo
      - filterable
      - filteredLookupInfo
      - highScaleNumber
      - htmlFormatted
      - inlineHelpText
      - label
      - length
      - nameField
      - polymorphicForeignKey
      - precision
      - reference
      - referenceTargetField
      - referenceToInfos
      - relationshipName
      - required
      - scale
      - searchPrefilterable
      - sortable
      - unique
      - updateable
      type: object
      properties:
        apiName:
          type: string
          example: example_value
        calculated:
          type: boolean
          example: true
        compound:
          type: boolean
          example: true
        compoundComponentName:
          type:
          - string
          - 'null'
          example: example_value
        compoundFieldName:
          type:
          - string
          - 'null'
          example: example_value
        controllerName:
          type:
          - string
          - 'null'
          example: example_value
        controllingFields:
          type: array
          items:
            type: string
          description: ''
          example: []
        createable:
          type: boolean
          example: true
        custom:
          type: boolean
          example: true
        dataType:
          type: string
          example: example_value
        extraTypeInfo:
          type:
          - string
          - 'null'
          example: example_value
        filterable:
          type: boolean
          example: true
        filteredLookupInfo:
          type:
          - string
          - 'null'
          example: example_value
        highScaleNumber:
          type: boolean
          example: true
        htmlFormatted:
          type: boolean
          example: true
        inlineHelpText:
          type:
          - string
          - 'null'
          example: example_value
        label:
          type: string
          example: Example Title
        length:
          type: integer
          contentEncoding: int32
          example: 10
        nameField:
          type: boolean
          example: true
        polymorphicForeignKey:
          type: boolean
          example: true
        precision:
          type: integer
          contentEncoding: int32
          example: 10
        reference:
          type: boolean
          example: true
        referenceTargetField:
          type:
          - string
          - 'null'
          example: example_value
        referenceToInfos:
          type: array
          items:
            type: string
          description: ''
          example: []
        relationshipName:
          type:
          - string
          - 'null'
          example: example_value
        required:
          type: boolean
          example: true
        scale:
          type: integer
          contentEncoding: int32
          example: 10
        searchPrefilterable:
          type: boolean
          example: true
        sortable:
          type: boolean
          example: true
        unique:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
      examples:
      - apiName: UserPreferencesLightningExperiencePreferred
        calculated: false
        compound: false
        compoundComponentName: null
        compoundFieldName: null
        controllerName: null
        controllingFields: []
        createable: true
        custom: false
        dataType: Boolean
        extraTypeInfo: null
        filterable: true
        filteredLookupInfo: null
        highScaleNumber: false
        htmlFormatted: false
        inlineHelpText: null
        label: LightningExperiencePreferred
        length: 0
        nameField: false
        polymorphicForeignKey: false
        precision: 0
        reference: false
        referenceTargetField: null
        referenceToInfos: []
        relationshipName: null
        required: true
        scale: 0
        searchPrefilterable: false
        sortable: false
        unique: false
        updateable: true
    UserPreferencesShowProfilePicToGuestUsers:
      title: UserPreferencesShowProfilePicToGuestUsers
      required:
      - apiName
      - calculated
      - compound
      - compoundComponentName
      - compoundFieldName
      - controllerName
      - controllingFields
      - createable
      - custom
      - dataType
      - extraTypeInfo
      - filterable
      - filteredLookupInfo
      - highScaleNumber
      - htmlFormatted
      - inlineHelpText
      - label
      - length
      - nameField
      - polymorphicForeignKey
      - precision
      - reference
      - referenceTargetField
      - referenceToInfos
      - relationshipName
      - required
      - scale
      - searchPrefilterable
      - sortable
      - unique
      - updateable
      type: object
      properties:
        apiName:
          type: string
          example: example_value
        calculated:
          type: boolean
          example: true
        compound:
          type: boolean
          example: true
        compoundComponentName:
          type:
          - string
          - 'null'
          example: example_value
        compoundFieldName:
          type:
          - string
          - 'null'
          example: example_value
        controllerName:
          type:
          - string
          - 'null'
          example: example_value
        controllingFields:
          type: array
          items:
            type: string
          description: ''
          example: []
        createable:
          type: boolean
          example: true
        custom:
          type: boolean
          example: true
        dataType:
          type: string
          example: example_value
        extraTypeInfo:
          type:
          - string
          - 'null'
          example: example_value
        filterable:
          type: boolean
          example: true
        filteredLookupInfo:
          type:
          - string
          - 'null'
          example: example_value
        highScaleNumber:
          type: boolean
          example: true
        htmlFormatted:
          type: boolean
          example: true
        inlineHelpText:
          type:
          - string
          - 'null'
          example: example_value
        label:
          type: string
          example: Example Title
        length:
          type: integer
          contentEncoding: int32
          example: 10
        nameField:
          type: boolean
          example: true
        polymorphicForeignKey:
          type: boolean
          example: true
        precision:
          type: integer
          contentEncoding: int32
          example: 10
        reference:
          type: boolean
          example: true
        referenceTargetField:
          type:
          - string
          - 'null'
          example: example_value
        referenceToInfos:
          type: array
          items:
            type: string
          description: ''
          example: []
        relationshipName:
          type:
          - string
          - 'null'
          example: example_value
        required:
          type: boolean
          example: true
        scale:
          type: integer
          contentEncoding: int32
          example: 10
        searchPrefilterable:
          type: boolean
          example: true
        sortable:
          type: boolean
          example: true
        unique:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
      examples:
      - apiName: UserPreferencesShowProfilePicToGuestUsers
        calculated: false
        compound: false
        compoundComponentName: null
        compoundFieldName: null
        controllerName: null
        controllingFields: []
        createable: true
        custom: false
        dataType: Boolean
        extraTypeInfo: null
        filterable: true
        filteredLookupInfo: null
        highScaleNumber: false
        htmlFormatted: false
        inlineHelpText: null
        label: ShowProfilePicToGuestUsers
        length: 0
        nameField: false
        polymorphicForeignKey: false
        precision: 0
        reference: false
        referenceTargetField: null
        referenceToInfos: []
        relationshipName: null
        required: true
        scale: 0
        searchPrefilterable: false
        sortable: false
        unique: false
        updateable: true
    Sic4:
      title: Sic4
      required:
      - displayValue
      - value
      type: object
      properties:
        displayValue:
          type:
          - string
          - 'null'
          example: example_value
        value:
          type: string
          example: example_value
      examples:
      - displayValue: null
        value: '6752'
    DefaultGroupNotificationFrequency:
      title: DefaultGroupNotificationFrequency
      required:
      - apiName
      - calculated
      - compound
      - compoundComponentName
      - compoundFieldName
      - controllerName
      - controllingFields
      - createable
      - custom
      - dataType
      - extraTypeInfo
      - filterable
      - filteredLookupInfo
      - highScaleNumber
      - htmlFormatted
      - inlineHelpText
      - label
      - length
      - nameField
      - polymorphicForeignKey
      - precision
      - reference
      - referenceTargetField
      - referenceToInfos
      - relationshipName
      - required
      - scale
      - searchPrefilterable
      - sortable
      - unique
      - updateable
      type: object
      properties:
        apiName:
          type: string
          example: example_value
        calculated:
          type: boolean
          example: true
        compound:
          type: boolean
          example: true
        compoundComponentName:
          type:
          - string
          - 'null'
          example: example_value
        compoundFieldName:
          type:
          - string
          - 'null'
          example: example_value
        controllerName:
          type:
          - string
          - 'null'
          example: example_value
        controllingFields:
          type: array
          items:
            type: string
          description: ''
          example: []
        createable:
          type: boolean
          example: true
        custom:
          type: boolean
          example: true
        dataType:
          type: string
          example: example_value
        extraTypeInfo:
          type:
          - string
          - 'null'
          example: example_value
        filterable:
          type: boolean
          example: true
        filteredLookupInfo:
          type:
          - string
          - 'null'
          example: example_value
        highScaleNumber:
          type: boolean
          example: true
        htmlFormatted:
          type: boolean
          example: true
        inlineHelpText:
          type:
          - string
          - 'null'
          example: example_value
        label:
          type: string
          example: Example Title
        length:
          type: integer
          contentEncoding: int32
          example: 10
        nameField:
          type: boolean
          example: true
        polymorphicForeignKey:
          type: boolean
          example: true
        precision:
          type: integer
          contentEncoding: int32
          example: 10
        reference:
          type: boolean
          example: true
        referenceTargetField:
          type:
          - string
          - 'null'
          example: example_value
        referenceToInfos:
          type: array
          items:
            type: string
          description: ''
          example: []
        relationshipName:
          type:
          - string
          - 'null'
          example: example_value
        required:
          type: boolean
          example: true
        scale:
          type: integer
          contentEncoding: int32
          example: 10
        searchPrefilterable:
          type: boolean
          example: true
        sortable:
          type: boolean
          example: true
        unique:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
      examples:
      - apiName: DefaultGroupNotificationFrequency
        calculated: false
        compound: false
        compoundComponentName: null
        compoundFieldName: null
        controllerName: null
        controllingFields: []
        createable: true
        custom: false
        dataType: Picklist
        extraTypeInfo: null
        filterable: true
        filteredLookupInfo: null
        highScaleNumber: false
        htmlFormatted: false
        inlineHelpText: null
        label: Default Notification Frequency when Joining Groups
        length: 40
        nameField: false
        polymorphicForeignKey: false
        precision: 0
        reference: false
        referenceTargetField: null
        referenceToInfos: []
        relationshipName: null
        required: true
        scale: 0
        searchPrefilterable: false
        sortable: true
        unique: false
        updateable: true
    CommunityNickname:
      title: CommunityNickname
      required:
      - apiName
      - calculated
      - compound
      - compoundComponentName
      - compoundFieldName
      - controllerName
      - controllingFields
      - createable
      - custom
      - dataType
      - extraTypeInfo
      - filterable
      - filteredLookupInfo
      - highScaleNumber
      - htmlFormatted
      - inlineHelpText
      - label
      - length
      - nameField
      - polymorphicForeignKey
      - precision
      - reference
      - referenceTargetField
      - referenceToInfos
      - relationshipName
      - required
      - scale
      - searchPrefilterable
      - sortable
      - unique
      - updateable
      type: object
      properties:
        apiName:
          type: string
          example: example_value
        calculated:
          type: boolean
          example: true
        compound:
          type: boolean
          example: true
        compoundComponentName:
          type:
          - string
          - 'null'
          example: example_value
        compoundFieldName:
          type:
          - string
          - 'null'
          example: example_value
        controllerName:
          type:
          - string
          - 'null'
          example: example_value
        controllingFields:
          type: array
          items:
            type: string
          description: ''
          example: []
        createable:
          type: boolean
          example: true
        custom:
          type: boolean
          example: true
        dataType:
          type: string
          example: example_value
        extraTypeInfo:
          type:
          - string
          - 'null'
          example: example_value
        filterable:
          type: boolean
          example: true
        filteredLookupInfo:
          type:
          - string
          - 'null'
          example: example_value
        highScaleNumber:
          type: boolean
          example: true
        htmlFormatted:
          type: boolean
          example: true
        inlineHelpText:
          type:
          - string
          - 'null'
          example: example_value
        label:
          type: string
          example: Example Title
        length:
          type: integer
          contentEncoding: int32
          example: 10
        nameField:
          type: boolean
          example: true
        polymorphicForeignKey:
          type: boolean
          example: true
        precision:
          type: integer
          contentEncoding: int32
          example: 10
        reference:
          type: boolean
          example: true
        referenceTargetField:
          type:
          - string
          - 'null'
          example: example_value
        referenceToInfos:
          type: array
          items:
            type: string
          description: ''
          example: []
        relationshipName:
          type:
          - string
          - 'null'
          example: example_value
        required:
          type: boolean
          example: true
        scale:
          type: integer
          contentEncoding: int32
          example: 10
        searchPrefilterable:
          type: boolean
          example: true
        sortable:
          type: boolean
          example: true
        unique:
          type: boolean
          example: true
        updateable:
          type: boolean
          example: true
      examples:
      - apiName: CommunityNickname
        calculated: false
        compound: false
        compoundComponentName: null
        compoundFieldName: null
        controllerName: null
        controllingFields: []
        createable: false
        custom: false
        dataType: String
        extraTypeInfo: null
        filterable: true
        filteredLookupInfo: null
        highScaleNumber: false
        htmlFormatted: false
        inlineHelpText: null
        label: Nickname
        length: 40
        nameField: false
    

# --- truncated at 32 KB (2023 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-clone-api-openapi.yml