Skip to main content

Modify Salesforce Organization​

Select

SaaS
Customer Managed

This operation is used to Modify salesforce organization

Path Parameters
  • ClientId integer required

    Client Id of the salesforce organization

Query Parameters
  • instanceId integer required

    Salesforce pseudo client instance Id

  • backupsetId integer required

    Salesforce pseudo client backupset Id

Request Body
  • endpoint string

    Salesforce endpoint

  • entity object

    Salesforce pseudo client details

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

    For Salesforce use 134

  • backupFileObjects boolean

    Enable backup for Files

  • backupArchivedandDeletedRecs boolean

    Enable backup for archived and deleted records

  • backupSFMetadata boolean

    Enable backup for metadata

  • filesPerBackup integer

    File download limit

  • noOfBackupStreams integer

    Number of data streams

  • downloadCachePath string

    Download cache path

  • accessNodes object[]

    Access Node details

  • client object
  • _type_ integer
  • clientId integer
  • clientName string
  • clientGroupId integer
  • clientGroupName string
  • syncDatabase object

    Sync DB details

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

    Base64 encoded DB user's password

  • salesforceAccount object

    Salesforce account details

  • authenticationType integer
  • consumerId string
  • consumerSecret string

    Base64 encoded consumer secret

  • endpoint string
  • environmentType integer
  • token string
  • userCredentials object
  • password string
  • userName string

    Base64 encoded salesforce user's password

  • ignoreObjs string[]

    Exclude objects

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
POST /salesforce/organization/:clientid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
ClientId — path required
instanceId — query required
backupsetId — query required
Body
{

  "endpoint": "string",

  "entity": {

    "clientName": "string",

    "instanceName": "string",

    "displayName": "string",

    "backupsetId": 0,

    "instanceId": 0,

    "instanceGUID": "string",

    "subclientId": 0,

    "clientId": 0,

    "appName": "string",

    "applicationId": 0

  },

  "backupFileObjects": true,

  "backupArchivedandDeletedRecs": true,

  "backupSFMetadata": true,

  "filesPerBackup": 0,

  "noOfBackupStreams": 0,

  "downloadCachePath": "string",

  "accessNodes": [

    {

      "client": {

        "_type_": 0,

        "clientId": 0,

        "clientName": "string",

        "clientGroupId": 0,

        "clientGroupName": "string"

      }

    }

  ],

  "syncDatabase": {

    "dbEnabled": true,

    "dbHost": "string",

    "dbInstance": "string",

    "dbName": "string",

    "dbPort": "string",

    "dbType": "string",

    "dbUserPassword": {

      "password": "string",

      "userName": "string"

    }

  },

  "salesforceAccount": {

    "authenticationType": 0,

    "consumerId": "string",

    "consumerSecret": "string",

    "endpoint": "string",

    "environmentType": 0,

    "token": "string",

    "userCredentials": {

      "password": "string",

      "userName": "string"

    }

  },

  "ignoreObjs": [

    "string"

  ]

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "endpoint": "string",
  "entity": {
    "clientName": "string",
    "instanceName": "string",
    "displayName": "string",
    "backupsetId": 0,
    "instanceId": 0,
    "instanceGUID": "string",
    "subclientId": 0,
    "clientId": 0,
    "appName": "string",
    "applicationId": 0
  },
  "backupFileObjects": true,
  "backupArchivedandDeletedRecs": true,
  "backupSFMetadata": true,
  "filesPerBackup": 0,
  "noOfBackupStreams": 0,
  "downloadCachePath": "string",
  "accessNodes": [
    {
      "client": {
        "_type_": 0,
        "clientId": 0,
        "clientName": "string",
        "clientGroupId": 0,
        "clientGroupName": "string"
      }
    }
  ],
  "syncDatabase": {
    "dbEnabled": true,
    "dbHost": "string",
    "dbInstance": "string",
    "dbName": "string",
    "dbPort": "string",
    "dbType": "string",
    "dbUserPassword": {
      "password": "string",
      "userName": "string"
    }
  },
  "salesforceAccount": {
    "authenticationType": 0,
    "consumerId": "string",
    "consumerSecret": "string",
    "endpoint": "string",
    "environmentType": 0,
    "token": "string",
    "userCredentials": {
      "password": "string",
      "userName": "string"
    }
  },
  "ignoreObjs": [
    "string"
  ]
}'