POST api/MigrateSalesforceMetaData

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
sourceLogin	clsLoginDetail	None.
targetLogin	clsLoginDetail	None.
migrationDetail	MigrationDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "sourceLogin": {
    "sessionID": "sample string 1",
    "serverURL": "sample string 2",
    "orgID": "sample string 3",
    "userName": "sample string 4",
    "password": "sample string 5",
    "securityToken": "sample string 6",
    "connectionString": "sample string 7",
    "MetadataServerURL": "sample string 8",
    "sessionCheck": true
  },
  "targetLogin": {
    "sessionID": "sample string 1",
    "serverURL": "sample string 2",
    "orgID": "sample string 3",
    "userName": "sample string 4",
    "password": "sample string 5",
    "securityToken": "sample string 6",
    "connectionString": "sample string 7",
    "MetadataServerURL": "sample string 8",
    "sessionCheck": true
  },
  "migrationDetail": {
    "metadataList": [
      "sample string 1",
      "sample string 2"
    ],
    "checkOnly": true,
    "metadataType": "sample string 2",
    "packageXMLFilePath": "sample string 3",
    "extractOnly": true,
    "managePackage": true,
    "packageNamespacePrefix": "sample string 6"
  }
}

application/xml, text/xml

Sample:

<MigrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DSMTMetaAPI.Models">
  <migrationDetail>
    <checkOnly>true</checkOnly>
    <extractOnly>true</extractOnly>
    <managePackage>true</managePackage>
    <metadataList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </metadataList>
    <metadataType>sample string 2</metadataType>
    <packageNamespacePrefix>sample string 6</packageNamespacePrefix>
    <packageXMLFilePath>sample string 3</packageXMLFilePath>
  </migrationDetail>
  <sourceLogin>
    <MetadataServerURL>sample string 8</MetadataServerURL>
    <connectionString>sample string 7</connectionString>
    <orgID>sample string 3</orgID>
    <password>sample string 5</password>
    <securityToken>sample string 6</securityToken>
    <serverURL>sample string 2</serverURL>
    <sessionCheck>true</sessionCheck>
    <sessionID>sample string 1</sessionID>
    <userName>sample string 4</userName>
  </sourceLogin>
  <targetLogin>
    <MetadataServerURL>sample string 8</MetadataServerURL>
    <connectionString>sample string 7</connectionString>
    <orgID>sample string 3</orgID>
    <password>sample string 5</password>
    <securityToken>sample string 6</securityToken>
    <serverURL>sample string 2</serverURL>
    <sessionCheck>true</sessionCheck>
    <sessionID>sample string 1</sessionID>
    <userName>sample string 4</userName>
  </targetLogin>
</MigrationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DSMMetaAPIProcessResult

Name	Type	Additional information
error	string	None.
id	string	None.
success	boolean	None.
salesforceFieldsProcess	DSMSalesforceFieldProcess	None.
salesforceField	DSMMetaSalesForceFieldDetail	None.
recordType	DSMRecordType	None.
pagelayout	DSMApexPageLayout	None.

Response Formats

application/json, text/json

Sample:

{
  "error": "sample string 1",
  "id": "sample string 2",
  "success": true,
  "salesforceFieldsProcess": {
    "salesforceFields": [
      {
        "fieldName": "sample string 1",
        "fieldLabel": "sample string 2",
        "dataType": "sample string 3",
        "defaultValue": "sample string 4",
        "description": "sample string 5",
        "helpText": "sample string 6",
        "displayFormat": "sample string 7",
        "formulaReturnType": "sample string 8",
        "fieldFormulaValue": "sample string 9",
        "relatedToObject": "sample string 10",
        "childRelationShipName": "sample string 11",
        "maskType": "sample string 12",
        "maskCharcter": "sample string 13",
        "pickListValue": [
          "sample string 1",
          "sample string 2"
        ],
        "picklistControllingField": "sample string 14",
        "dependentPickListValueDetail": [
          {
            "picklistvalue": "sample string 1",
            "controlingvalue": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "picklistvalue": "sample string 1",
            "controlingvalue": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "isRequired": true,
        "isAutonumberForExistingRecord": true,
        "isUnique": true,
        "isUniqueCase": true,
        "isExternalID": true,
        "isSortPickListAlpha": true,
        "isPickListFirstValueDefault": true,
        "isAllowDeletionofLookUpValue": true,
        "isRestrictedPickList": true,
        "startingNumber": 24,
        "fieldlength": 25,
        "decimalPlaces": 26,
        "visibleLines": 27,
        "precision": 28,
        "DeletePassedField": true
      },
      {
        "fieldName": "sample string 1",
        "fieldLabel": "sample string 2",
        "dataType": "sample string 3",
        "defaultValue": "sample string 4",
        "description": "sample string 5",
        "helpText": "sample string 6",
        "displayFormat": "sample string 7",
        "formulaReturnType": "sample string 8",
        "fieldFormulaValue": "sample string 9",
        "relatedToObject": "sample string 10",
        "childRelationShipName": "sample string 11",
        "maskType": "sample string 12",
        "maskCharcter": "sample string 13",
        "pickListValue": [
          "sample string 1",
          "sample string 2"
        ],
        "picklistControllingField": "sample string 14",
        "dependentPickListValueDetail": [
          {
            "picklistvalue": "sample string 1",
            "controlingvalue": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "picklistvalue": "sample string 1",
            "controlingvalue": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ],
        "isRequired": true,
        "isAutonumberForExistingRecord": true,
        "isUnique": true,
        "isUniqueCase": true,
        "isExternalID": true,
        "isSortPickListAlpha": true,
        "isPickListFirstValueDefault": true,
        "isAllowDeletionofLookUpValue": true,
        "isRestrictedPickList": true,
        "startingNumber": 24,
        "fieldlength": 25,
        "decimalPlaces": 26,
        "visibleLines": 27,
        "precision": 28,
        "DeletePassedField": true
      }
    ],
    "SalesforceObjectAPIName": "sample string 1",
    "checkOnly": true
  },
  "salesforceField": {
    "fieldName": "sample string 1",
    "fieldLabel": "sample string 2",
    "dataType": "sample string 3",
    "defaultValue": "sample string 4",
    "description": "sample string 5",
    "helpText": "sample string 6",
    "displayFormat": "sample string 7",
    "formulaReturnType": "sample string 8",
    "fieldFormulaValue": "sample string 9",
    "relatedToObject": "sample string 10",
    "childRelationShipName": "sample string 11",
    "maskType": "sample string 12",
    "maskCharcter": "sample string 13",
    "pickListValue": [
      "sample string 1",
      "sample string 2"
    ],
    "picklistControllingField": "sample string 14",
    "dependentPickListValueDetail": [
      {
        "picklistvalue": "sample string 1",
        "controlingvalue": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "picklistvalue": "sample string 1",
        "controlingvalue": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "isRequired": true,
    "isAutonumberForExistingRecord": true,
    "isUnique": true,
    "isUniqueCase": true,
    "isExternalID": true,
    "isSortPickListAlpha": true,
    "isPickListFirstValueDefault": true,
    "isAllowDeletionofLookUpValue": true,
    "isRestrictedPickList": true,
    "startingNumber": 24,
    "fieldlength": 25,
    "decimalPlaces": 26,
    "visibleLines": 27,
    "precision": 28,
    "DeletePassedField": true
  },
  "recordType": {
    "RecordTypeId": "sample string 1",
    "RecordTypeName": "sample string 2",
    "RecordTypeObject": "sample string 3",
    "Description": "sample string 4"
  },
  "pagelayout": {
    "RecordTypeName": "sample string 1",
    "RecordTypeId": "sample string 2",
    "SourceApexLayoutName": "sample string 3",
    "NewApexLayoutName": "sample string 4",
    "SalesForceObjectAPIName": "sample string 5",
    "SalesforceProfileList": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<DSMMetaAPIProcessResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DSMTMetaAPI.Models">
  <error>sample string 1</error>
  <id>sample string 2</id>
  <pagelayout>
    <NewApexLayoutName>sample string 4</NewApexLayoutName>
    <RecordTypeId>sample string 2</RecordTypeId>
    <RecordTypeName>sample string 1</RecordTypeName>
    <SalesForceObjectAPIName>sample string 5</SalesForceObjectAPIName>
    <SalesforceProfileList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SalesforceProfileList>
    <SourceApexLayoutName>sample string 3</SourceApexLayoutName>
  </pagelayout>
  <recordType>
    <Description>sample string 4</Description>
    <RecordTypeId>sample string 1</RecordTypeId>
    <RecordTypeName>sample string 2</RecordTypeName>
    <RecordTypeObject>sample string 3</RecordTypeObject>
  </recordType>
  <salesforceField>
    <DeletePassedField>true</DeletePassedField>
    <childRelationShipName>sample string 11</childRelationShipName>
    <dataType>sample string 3</dataType>
    <decimalPlaces>26</decimalPlaces>
    <defaultValue>sample string 4</defaultValue>
    <dependentPickListValueDetail>
      <DependentPicklistValues>
        <controlingvalue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </controlingvalue>
        <picklistvalue>sample string 1</picklistvalue>
      </DependentPicklistValues>
      <DependentPicklistValues>
        <controlingvalue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </controlingvalue>
        <picklistvalue>sample string 1</picklistvalue>
      </DependentPicklistValues>
    </dependentPickListValueDetail>
    <description>sample string 5</description>
    <displayFormat>sample string 7</displayFormat>
    <fieldFormulaValue>sample string 9</fieldFormulaValue>
    <fieldLabel>sample string 2</fieldLabel>
    <fieldName>sample string 1</fieldName>
    <fieldlength>25</fieldlength>
    <formulaReturnType>sample string 8</formulaReturnType>
    <helpText>sample string 6</helpText>
    <isAllowDeletionofLookUpValue>true</isAllowDeletionofLookUpValue>
    <isAutonumberForExistingRecord>true</isAutonumberForExistingRecord>
    <isExternalID>true</isExternalID>
    <isPickListFirstValueDefault>true</isPickListFirstValueDefault>
    <isRequired>true</isRequired>
    <isRestrictedPickList>true</isRestrictedPickList>
    <isSortPickListAlpha>true</isSortPickListAlpha>
    <isUnique>true</isUnique>
    <isUniqueCase>true</isUniqueCase>
    <maskCharcter>sample string 13</maskCharcter>
    <maskType>sample string 12</maskType>
    <pickListValue xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </pickListValue>
    <picklistControllingField>sample string 14</picklistControllingField>
    <precision>28</precision>
    <relatedToObject>sample string 10</relatedToObject>
    <startingNumber>24</startingNumber>
    <visibleLines>27</visibleLines>
  </salesforceField>
  <salesforceFieldsProcess>
    <SalesforceObjectAPIName>sample string 1</SalesforceObjectAPIName>
    <checkOnly>true</checkOnly>
    <salesforceFields>
      <DSMMetaSalesForceFieldDetail>
        <DeletePassedField>true</DeletePassedField>
        <childRelationShipName>sample string 11</childRelationShipName>
        <dataType>sample string 3</dataType>
        <decimalPlaces>26</decimalPlaces>
        <defaultValue>sample string 4</defaultValue>
        <dependentPickListValueDetail>
          <DependentPicklistValues>
            <controlingvalue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </controlingvalue>
            <picklistvalue>sample string 1</picklistvalue>
          </DependentPicklistValues>
          <DependentPicklistValues>
            <controlingvalue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </controlingvalue>
            <picklistvalue>sample string 1</picklistvalue>
          </DependentPicklistValues>
        </dependentPickListValueDetail>
        <description>sample string 5</description>
        <displayFormat>sample string 7</displayFormat>
        <fieldFormulaValue>sample string 9</fieldFormulaValue>
        <fieldLabel>sample string 2</fieldLabel>
        <fieldName>sample string 1</fieldName>
        <fieldlength>25</fieldlength>
        <formulaReturnType>sample string 8</formulaReturnType>
        <helpText>sample string 6</helpText>
        <isAllowDeletionofLookUpValue>true</isAllowDeletionofLookUpValue>
        <isAutonumberForExistingRecord>true</isAutonumberForExistingRecord>
        <isExternalID>true</isExternalID>
        <isPickListFirstValueDefault>true</isPickListFirstValueDefault>
        <isRequired>true</isRequired>
        <isRestrictedPickList>true</isRestrictedPickList>
        <isSortPickListAlpha>true</isSortPickListAlpha>
        <isUnique>true</isUnique>
        <isUniqueCase>true</isUniqueCase>
        <maskCharcter>sample string 13</maskCharcter>
        <maskType>sample string 12</maskType>
        <pickListValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </pickListValue>
        <picklistControllingField>sample string 14</picklistControllingField>
        <precision>28</precision>
        <relatedToObject>sample string 10</relatedToObject>
        <startingNumber>24</startingNumber>
        <visibleLines>27</visibleLines>
      </DSMMetaSalesForceFieldDetail>
      <DSMMetaSalesForceFieldDetail>
        <DeletePassedField>true</DeletePassedField>
        <childRelationShipName>sample string 11</childRelationShipName>
        <dataType>sample string 3</dataType>
        <decimalPlaces>26</decimalPlaces>
        <defaultValue>sample string 4</defaultValue>
        <dependentPickListValueDetail>
          <DependentPicklistValues>
            <controlingvalue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </controlingvalue>
            <picklistvalue>sample string 1</picklistvalue>
          </DependentPicklistValues>
          <DependentPicklistValues>
            <controlingvalue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </controlingvalue>
            <picklistvalue>sample string 1</picklistvalue>
          </DependentPicklistValues>
        </dependentPickListValueDetail>
        <description>sample string 5</description>
        <displayFormat>sample string 7</displayFormat>
        <fieldFormulaValue>sample string 9</fieldFormulaValue>
        <fieldLabel>sample string 2</fieldLabel>
        <fieldName>sample string 1</fieldName>
        <fieldlength>25</fieldlength>
        <formulaReturnType>sample string 8</formulaReturnType>
        <helpText>sample string 6</helpText>
        <isAllowDeletionofLookUpValue>true</isAllowDeletionofLookUpValue>
        <isAutonumberForExistingRecord>true</isAutonumberForExistingRecord>
        <isExternalID>true</isExternalID>
        <isPickListFirstValueDefault>true</isPickListFirstValueDefault>
        <isRequired>true</isRequired>
        <isRestrictedPickList>true</isRestrictedPickList>
        <isSortPickListAlpha>true</isSortPickListAlpha>
        <isUnique>true</isUnique>
        <isUniqueCase>true</isUniqueCase>
        <maskCharcter>sample string 13</maskCharcter>
        <maskType>sample string 12</maskType>
        <pickListValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </pickListValue>
        <picklistControllingField>sample string 14</picklistControllingField>
        <precision>28</precision>
        <relatedToObject>sample string 10</relatedToObject>
        <startingNumber>24</startingNumber>
        <visibleLines>27</visibleLines>
      </DSMMetaSalesForceFieldDetail>
    </salesforceFields>
  </salesforceFieldsProcess>
  <success>true</success>
</DSMMetaAPIProcessResult>