POST api/GetObjectFieldDetail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
login	clsLoginDetail	None.
objectNames	Collection of string	None.
GetSampleData	boolean	None.
GetFieldForQuery	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "login": {
    "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
  },
  "objectNames": [
    "sample string 1",
    "sample string 2"
  ],
  "GetSampleData": true,
  "GetFieldForQuery": true
}

application/xml, text/xml

Sample:

<DSMSalesforceFieldRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DSMTMetaAPI.Models">
  <GetFieldForQuery>true</GetFieldForQuery>
  <GetSampleData>true</GetSampleData>
  <login>
    <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>
  </login>
  <objectNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </objectNames>
</DSMSalesforceFieldRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DSMSalesforceFieldListResult

Name	Type	Additional information
error	string	None.
success	boolean	None.
fieldDetail	Collection of DSMSalesforceFieldDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "error": "sample string 1",
  "success": true,
  "fieldDetail": [
    {
      "objectName": "sample string 1",
      "fields": [
        {
          "objectName": "sample string 1",
          "fieldName": "sample string 2",
          "fieldAPIName": "sample string 3",
          "dataType": "sample string 4",
          "sampleValue": "sample string 5",
          "referenceObjectName": [
            "sample string 1",
            "sample string 2"
          ],
          "childRelationShipName": "sample string 6"
        },
        {
          "objectName": "sample string 1",
          "fieldName": "sample string 2",
          "fieldAPIName": "sample string 3",
          "dataType": "sample string 4",
          "sampleValue": "sample string 5",
          "referenceObjectName": [
            "sample string 1",
            "sample string 2"
          ],
          "childRelationShipName": "sample string 6"
        }
      ]
    },
    {
      "objectName": "sample string 1",
      "fields": [
        {
          "objectName": "sample string 1",
          "fieldName": "sample string 2",
          "fieldAPIName": "sample string 3",
          "dataType": "sample string 4",
          "sampleValue": "sample string 5",
          "referenceObjectName": [
            "sample string 1",
            "sample string 2"
          ],
          "childRelationShipName": "sample string 6"
        },
        {
          "objectName": "sample string 1",
          "fieldName": "sample string 2",
          "fieldAPIName": "sample string 3",
          "dataType": "sample string 4",
          "sampleValue": "sample string 5",
          "referenceObjectName": [
            "sample string 1",
            "sample string 2"
          ],
          "childRelationShipName": "sample string 6"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<DSMSalesforceFieldListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DSMTMetaAPI.Models">
  <error>sample string 1</error>
  <fieldDetail>
    <DSMSalesforceFieldDetail>
      <fields>
        <DSMSalesforceFieldList>
          <childRelationShipName>sample string 6</childRelationShipName>
          <dataType>sample string 4</dataType>
          <fieldAPIName>sample string 3</fieldAPIName>
          <fieldName>sample string 2</fieldName>
          <objectName>sample string 1</objectName>
          <referenceObjectName xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </referenceObjectName>
          <sampleValue>sample string 5</sampleValue>
        </DSMSalesforceFieldList>
        <DSMSalesforceFieldList>
          <childRelationShipName>sample string 6</childRelationShipName>
          <dataType>sample string 4</dataType>
          <fieldAPIName>sample string 3</fieldAPIName>
          <fieldName>sample string 2</fieldName>
          <objectName>sample string 1</objectName>
          <referenceObjectName xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </referenceObjectName>
          <sampleValue>sample string 5</sampleValue>
        </DSMSalesforceFieldList>
      </fields>
      <objectName>sample string 1</objectName>
    </DSMSalesforceFieldDetail>
    <DSMSalesforceFieldDetail>
      <fields>
        <DSMSalesforceFieldList>
          <childRelationShipName>sample string 6</childRelationShipName>
          <dataType>sample string 4</dataType>
          <fieldAPIName>sample string 3</fieldAPIName>
          <fieldName>sample string 2</fieldName>
          <objectName>sample string 1</objectName>
          <referenceObjectName xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </referenceObjectName>
          <sampleValue>sample string 5</sampleValue>
        </DSMSalesforceFieldList>
        <DSMSalesforceFieldList>
          <childRelationShipName>sample string 6</childRelationShipName>
          <dataType>sample string 4</dataType>
          <fieldAPIName>sample string 3</fieldAPIName>
          <fieldName>sample string 2</fieldName>
          <objectName>sample string 1</objectName>
          <referenceObjectName xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </referenceObjectName>
          <sampleValue>sample string 5</sampleValue>
        </DSMSalesforceFieldList>
      </fields>
      <objectName>sample string 1</objectName>
    </DSMSalesforceFieldDetail>
  </fieldDetail>
  <success>true</success>
</DSMSalesforceFieldListResult>