Skip to main content

Salesforce Restores​

Select

SaaS
Customer Managed

This operation is used to perform Salesforce restores.

Request Body
  • taskInfo object
  • task object
  • policyType string
  • taskType string required
  • initiatedFrom string
  • associations object[]

    Salesforce source organization details

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer required
  • instanceId integer required
  • instanceGUID string
  • clientId integer required
  • appName string
  • applicationId integer required

    For Salesforce use 134

  • subTasks object[]
  • subTask object
  • subTaskType string required
  • operationType string required
  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • timeRange object

    Browse time range

  • fromTime integer
  • toTime integer
  • noImage boolean

    Set true when restoring an item marked as deleted

  • includeMetaData boolean

    Set true for Metadata restore

  • fileOption object
  • sourceItem string[] required

    Source item for Restore

  • commonOptions object
  • validateOnly boolean

    Default value: false

    Set true for Metadata Restore with Validation only

  • cloudAppsRestoreOptions object
  • instanceType string required
  • salesforceRestoreOptions object
  • restoreToFileSystem boolean

    Default value: false

    Set to true for restore to File system

  • restoreToSalesforce boolean

    Set to true for restore to Salesforce

  • isRecordLevelRestore boolean

    Default value: false

    Set to true for Record level restore

  • isSeeding boolean

    Default value: false

    Set to true for sandbox seeding job

  • isMetadataRestore boolean

    Default value: false

    Set to true for Metadata restore

  • pathToStoreCsv string

    Staging path for intermediate CSVs

  • restoreFromDatabase boolean

    Set true to restore using Sync DB data

  • fieldMappingType integer

    Field mapping to use Ex: Skip mapping fields-0, Use destination field mappings-1, Use source field mappings-2, Use CVExternalId to map all objects-3

  • dependentRestoreLevel integer

    Dependent level Ex: No children-0, Immediate children only-1, All children- -1

  • isSaaSRestore boolean
  • disableTriggers boolean

    Default value: false

    Set to true for Disabling triggers and rules

  • restoreParentType string

    Restore parent level Ex: All parents-"ALL", No parents-"NONE"

  • restoreOnlyModifedAndDeletedRecords boolean

    Default value: false

    Set true to restore only changed and deleted records

  • insertNullValues boolean

    Default value: false

    Set true to restore empty fields

  • overrideTable boolean

    Set true to override DB table when restore to Database

  • excludeObject boolean

    Set true to Exclude child object

  • excludedObjects string[]

    Child objects to exclude

  • enableMasking boolean

    Default value: false

    Set true to use Data masking

  • userSelectedMaskingPolicy object

    Data masking policy details

  • policy object
  • policyId integer

    Data masking policy Id

  • policyName string

    Data masking policy name

  • restoreCatalogDatabase boolean

    Set false to Restore only latest version for Restore to DB

  • syncDatabase object

    Destination Database details for Restore to DB

  • dbEnabled boolean
  • dbHost string
  • dbInstance string
  • dbName string
  • dbPort string
  • dbType string
  • dbUserPassword object
  • password string

    Base64 Encoded DB user's password

  • userName string
  • associateOwnershipToLoggedInUser boolean

    Set true to Associate ownership to the logged-in user for cross org restore

  • selectedRecords object[]

    Provide record details for Record Level Restore

  • modTimeStamp string
  • recordId string
  • objectConfigs object[]

    Fields to Restore for Record Level Restore, if not passed all fields are restored

  • includeFields undefined[]
  • objectName string
  • userSelectedSeedingPolicy object

    Sandbox seeding template details for Seeding job

  • policy object
  • policyId integer

    Sandbox seeding template Id

  • policyName string

    Sandbox seeding template name

  • seedingOptions object[]

    Configure field filters

  • dependentRestoreLevel integer

    Children restore level Ex: All- -1, No- 0, Immediate- 1

  • excludeObject boolean

    Set true to exclude children from restore

  • objectName string

    Object name

  • query string

    SQL query to use with where clause

  • queryBlock object

    Query block to build SQL query

  • blocks object[]

    List of rule groups

  • isAnd boolean

    Set true to perform AND between rules of the group otherwise OR will be used

  • rules object[]
  • column string

    Column name for rule

  • columnType integer

    Column Type Ex: STRING-0, INTEGER-1, DOUBLE-2, DATE-3, BOOLEAN-4, ENUM-5, DATETIME-6, TIME-7

  • condition integer

    Condition Ex: equals to-0, does not equal to-1, contains-2, does not contain-3, less than-4, less than or equal to-5, greater than-6, greater than or equal to-7, between-8, starts with-12, ends with-13, is null-14, is not null-15, not between-18

  • stringParam1 string

    Provide first parameter if required with operation

  • stringParam2 string

    Provide second parameter if required with operation

  • isAnd boolean

    Set true to perform AND between Rule Groups otherwise OR will be used

  • restoreParentType string

    Parent restore level Ex: No parents- 0, All parents- 1

  • type number
  • destination object
  • destClient object required

    Destination client details

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • instanceId integer
  • instanceGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • applicationId integer

    For Salesforce use 134

  • destinationInstance object

    Destination instance details

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • instanceId integer
  • instanceGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • applicationId integer

    For Salesforce use 134

  • destinationBackupset object

    Destination backupset details

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • instanceId integer
  • instanceGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • applicationId integer

    For Salesforce use 134

  • noOfStreams integer

    Default value: 2

    Number of data streams to use

  • commonOpts object
  • notifyUserOnJobCompletion boolean

    Default value: false

Responses

OK

Schema
  • taskId integer
  • jobIds string[]

    Restore job Id

POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "task": {

      "policyType": "DATA_PROTECTION",

      "taskType": "IMMEDIATE",

      "initiatedFrom": "GUI"

    },

    "associations": [

      {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "instanceGUID": "string",

        "clientId": 0,

        "appName": "string",

        "applicationId": 0

      }

    ],

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "RESTORE",

          "operationType": "RESTORE"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              },

              "noImage": true,

              "includeMetaData": true

            },

            "fileOption": {

              "sourceItem": [

                "[\"/Objects/Account\", \"/Objects/Contact\"]"

              ]

            },

            "commonOptions": {

              "validateOnly": false

            },

            "cloudAppsRestoreOptions": {

              "instanceType": "SALESFORCE",

              "salesforceRestoreOptions": {

                "restoreToFileSystem": false,

                "restoreToSalesforce": true,

                "isRecordLevelRestore": false,

                "isSeeding": false,

                "isMetadataRestore": false,

                "pathToStoreCsv": "string",

                "restoreFromDatabase": true,

                "fieldMappingType": 0,

                "dependentRestoreLevel": 0,

                "isSaaSRestore": true,

                "disableTriggers": false,

                "restoreParentType": "string",

                "restoreOnlyModifedAndDeletedRecords": false,

                "insertNullValues": false,

                "overrideTable": true,

                "excludeObject": true,

                "excludedObjects": [

                  "string"

                ],

                "enableMasking": false,

                "userSelectedMaskingPolicy": {

                  "policy": {

                    "policyId": 0,

                    "policyName": "string"

                  }

                },

                "restoreCatalogDatabase": true,

                "syncDatabase": {

                  "dbEnabled": true,

                  "dbHost": "string",

                  "dbInstance": "string",

                  "dbName": "string",

                  "dbPort": "string",

                  "dbType": "string",

                  "dbUserPassword": {

                    "password": "string",

                    "userName": "string"

                  }

                },

                "associateOwnershipToLoggedInUser": true,

                "selectedRecords": [

                  {

                    "modTimeStamp": "string",

                    "recordId": "string"

                  }

                ],

                "objectConfigs": [

                  {

                    "includeFields": [

                      null

                    ],

                    "objectName": "string"

                  }

                ],

                "userSelectedSeedingPolicy": {

                  "policy": {

                    "policyId": 0,

                    "policyName": "string"

                  }

                },

                "seedingOptions": [

                  {

                    "dependentRestoreLevel": 0,

                    "excludeObject": true,

                    "objectName": "string",

                    "query": "string",

                    "queryBlock": {

                      "blocks": [

                        {

                          "isAnd": true,

                          "rules": [

                            {

                              "column": "string",

                              "columnType": 0,

                              "condition": 0,

                              "stringParam1": "string",

                              "stringParam2": "string"

                            }

                          ]

                        }

                      ],

                      "isAnd": true

                    },

                    "restoreParentType": "string",

                    "type": 0

                  }

                ]

              }

            },

            "destination": {

              "destClient": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "backupsetId": 0,

                "instanceId": 0,

                "instanceGUID": "string",

                "subclientId": 0,

                "clientId": 0,

                "appName": "string",

                "applicationId": 0

              },

              "destinationInstance": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "backupsetId": 0,

                "instanceId": 0,

                "instanceGUID": "string",

                "subclientId": 0,

                "clientId": 0,

                "appName": "string",

                "applicationId": 0

              },

              "destinationBackupset": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "backupsetId": 0,

                "instanceId": 0,

                "instanceGUID": "string",

                "subclientId": 0,

                "clientId": 0,

                "appName": "string",

                "applicationId": 0

              },

              "noOfStreams": 2

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": false

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "policyType": "DATA_PROTECTION",
      "taskType": "IMMEDIATE",
      "initiatedFrom": "GUI"
    },
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "instanceGUID": "string",
        "clientId": 0,
        "appName": "string",
        "applicationId": 0
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "RESTORE",
          "operationType": "RESTORE"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              },
              "noImage": true,
              "includeMetaData": true
            },
            "fileOption": {
              "sourceItem": [
                "[\"/Objects/Account\", \"/Objects/Contact\"]"
              ]
            },
            "commonOptions": {
              "validateOnly": false
            },
            "cloudAppsRestoreOptions": {
              "instanceType": "SALESFORCE",
              "salesforceRestoreOptions": {
                "restoreToFileSystem": false,
                "restoreToSalesforce": true,
                "isRecordLevelRestore": false,
                "isSeeding": false,
                "isMetadataRestore": false,
                "pathToStoreCsv": "string",
                "restoreFromDatabase": true,
                "fieldMappingType": 0,
                "dependentRestoreLevel": 0,
                "isSaaSRestore": true,
                "disableTriggers": false,
                "restoreParentType": "string",
                "restoreOnlyModifedAndDeletedRecords": false,
                "insertNullValues": false,
                "overrideTable": true,
                "excludeObject": true,
                "excludedObjects": [
                  "string"
                ],
                "enableMasking": false,
                "userSelectedMaskingPolicy": {
                  "policy": {
                    "policyId": 0,
                    "policyName": "string"
                  }
                },
                "restoreCatalogDatabase": true,
                "syncDatabase": {
                  "dbEnabled": true,
                  "dbHost": "string",
                  "dbInstance": "string",
                  "dbName": "string",
                  "dbPort": "string",
                  "dbType": "string",
                  "dbUserPassword": {
                    "password": "string",
                    "userName": "string"
                  }
                },
                "associateOwnershipToLoggedInUser": true,
                "selectedRecords": [
                  {
                    "modTimeStamp": "string",
                    "recordId": "string"
                  }
                ],
                "objectConfigs": [
                  {
                    "includeFields": [
                      null
                    ],
                    "objectName": "string"
                  }
                ],
                "userSelectedSeedingPolicy": {
                  "policy": {
                    "policyId": 0,
                    "policyName": "string"
                  }
                },
                "seedingOptions": [
                  {
                    "dependentRestoreLevel": 0,
                    "excludeObject": true,
                    "objectName": "string",
                    "query": "string",
                    "queryBlock": {
                      "blocks": [
                        {
                          "isAnd": true,
                          "rules": [
                            {
                              "column": "string",
                              "columnType": 0,
                              "condition": 0,
                              "stringParam1": "string",
                              "stringParam2": "string"
                            }
                          ]
                        }
                      ],
                      "isAnd": true
                    },
                    "restoreParentType": "string",
                    "type": 0
                  }
                ]
              }
            },
            "destination": {
              "destClient": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "backupsetId": 0,
                "instanceId": 0,
                "instanceGUID": "string",
                "subclientId": 0,
                "clientId": 0,
                "appName": "string",
                "applicationId": 0
              },
              "destinationInstance": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "backupsetId": 0,
                "instanceId": 0,
                "instanceGUID": "string",
                "subclientId": 0,
                "clientId": 0,
                "appName": "string",
                "applicationId": 0
              },
              "destinationBackupset": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "backupsetId": 0,
                "instanceId": 0,
                "instanceGUID": "string",
                "subclientId": 0,
                "clientId": 0,
                "appName": "string",
                "applicationId": 0
              },
              "noOfStreams": 2
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'