Fetch Salesforce Organization properties
This operation is used to Fetch Salesforce Organization properties.
Path Parameters
- ClientId integer required
Client Id of the salesforce organization
Responses
- 200
- application/json
- Schema
- Example (from schema)
- Salesforce org details
Schema
- filesPerBackup integer
File download limit for backup
- organizationName string
Organization name
- downloadCachePath string
Cache path
- backupArchivedandDeletedRecs boolean
Backup Archived and Deleted records
- backupFileObjects boolean
Backup files
- backupSFMetadata boolean
Backup metadata
- lastBackupTime integer
Last backup time
- backupSfObjects boolean
Backup objects
- lastBackupSize integer
Last Backup size
- hasResourcePoolAttached boolean
- enableAlerts boolean
Smart alerts
- noOfBackupStreams integer
Number of data streams
accessNodes object[]
userPermissions object
salesforceAccount object
salesforceStats object
- ignoreObjs string[]
List of excluded objects
syncDatabase object
plan object
entity object
{
"filesPerBackup": 0,
"organizationName": "string",
"downloadCachePath": "string",
"backupArchivedandDeletedRecs": true,
"backupFileObjects": true,
"backupSFMetadata": true,
"lastBackupTime": 0,
"backupSfObjects": true,
"lastBackupSize": 0,
"hasResourcePoolAttached": true,
"enableAlerts": true,
"noOfBackupStreams": 0,
"accessNodes": [
{
"client": {
"clientGroupName": "string",
"clientGroupId": 0,
"_type_": 0,
"clientId": 0
}
}
],
"userPermissions": {
"profileName": "string",
"hasQueryAllFilesPermission": true,
"hasModifyAllDataPermission": true,
"hasModifyMetadataPermission": true,
"hasDownloadAppExchangePackagesPermission": true,
"hasManageEncryptionKeysPermission": true,
"hasViewAllDataPermission": true
},
"salesforceAccount": {
"organizationId": "string",
"endpoint": "string",
"environmentType": 0,
"consumerId": "string",
"authenticationType": 0,
"userCredentials": {
"userName": "string"
},
"connectedAppCredentials": {
"credentialId": 0,
"credentialName": "string"
}
},
"salesforceStats": {
"metadata": "string",
"objects": "string",
"files": "string",
"syncDbSize": "string",
"totalFilesToBackup": "string"
},
"ignoreObjs": [
"string"
],
"syncDatabase": {
"dbPort": "string",
"dbInstance": "string",
"dbEnabled": true,
"dbName": "string",
"dbType": 0,
"dbHost": "string",
"dbUserPassword": {
"userName": "string"
}
},
"plan": {
"planName": "string",
"planId": 0
},
"entity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"instanceId": 0,
"instanceGUID": "string",
"subclientId": 0,
"clientId": 0,
"appName": "string",
"applicationId": 0
}
}
{
"filesPerBackup": 50,
"organizationName": "test",
"downloadCachePath": "/tmp",
"backupArchivedandDeletedRecs": true,
"backupFileObjects": true,
"backupSFMetadata": true,
"lastBackupTime": 0,
"backupSfObjects": true,
"hasResourcePoolAttached": false,
"enableAlerts": true,
"noOfBackupStreams": 2,
"accessNodes": [
{
"client": {
"clientId": 4,
"_type_": 3
}
}
],
"salesforceAccount": {
"endpoint": "https://login.salesforce.com/",
"environmentType": 0,
"consumerId": "string",
"authenticationType": 2,
"userCredentials": {
"userName": "string"
},
"connectedAppCredentials": {
"credentialId": 0
}
},
"salesforceStats": {},
"ignoreObjs": [
"contact",
"account"
],
"syncDatabase": {
"dbPort": "5432",
"dbInstance": "sql",
"dbEnabled": true,
"dbName": "string",
"dbType": 3,
"dbHost": "string",
"dbUserPassword": {
"userName": "string"
}
},
"plan": {
"planName": "varun-sf-nonrpool",
"planId": 2
},
"entity": {
"clientName": "test",
"instanceName": "test",
"displayName": "test",
"backupsetId": 107,
"instanceId": 104,
"instanceGUID": "FF9C71DA-2DAF-4A14-XXXXXXXXXXXXXX",
"subclientId": 107,
"clientId": 113,
"appName": "Cloud Apps",
"applicationId": 134
}
}
GET /salesforce/organization/:clientid
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Salesforce/Organization/:ClientId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'