Chilkat Online Tools

TCL / Salesforce Platform APIs / SOAP DescribeValueType

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample XML: Generate Code to Create XML

# The following XML is sent in the request body.

# <?xml version="1.0" encoding="utf-8"?>
# <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://soap.sforce.com/2006/04/metadata">
#     <soapenv:Header>
#         <tns:SessionHeader>
#             <tns:sessionId>{{_accessToken}}</tns:sessionId>
#         </tns:SessionHeader>
#     </soapenv:Header>
#     <soapenv:Body>
#         <tns:describeValueType>
#             <type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>
#         </tns:describeValueType>
#     </soapenv:Body>
# </soapenv:Envelope>
# 

set xml [new_CkXml]

CkXml_put_Tag $xml "soapenv:Envelope"
CkXml_AddAttribute $xml "xmlns:soapenv" "http://schemas.xmlsoap.org/soap/envelope/"
CkXml_AddAttribute $xml "xmlns:tns" "http://soap.sforce.com/2006/04/metadata"
CkXml_UpdateChildContent $xml "soapenv:Header|tns:SessionHeader|tns:sessionId" "{{_accessToken}}"
CkXml_UpdateChildContent $xml "soapenv:Body|tns:describeValueType|type" "{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME"

CkHttp_SetRequestHeader $http "Content-Type" "text/xml"
CkHttp_SetRequestHeader $http "SOAPAction" "login"
CkHttp_SetRequestHeader $http "Accept" "text/xml"
CkHttp_SetRequestHeader $http "charset" "UTF-8"

set sbRequestBody [new_CkStringBuilder]

CkXml_GetXmlSb $xml $sbRequestBody

set resp [new_CkHttpResponse]

set success [CkHttp_HttpSb $http "POST" "https://domain.com/services/Soap/m/{{version}}" $sbRequestBody "utf-8" "text/xml" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkXml $xml
    delete_CkStringBuilder $sbRequestBody
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set xmlResponse [new_CkXml]

CkXml_LoadSb $xmlResponse $sbResponseBody 1
puts [CkXml_getXml $xmlResponse]

# Sample XML response:
# (Sample code for parsing the XML response is shown below)

# <?xml version="1.0" encoding="UTF-8"?>
# <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/2006/04/metadata">
#     <soapenv:Body>
#         <describeValueTypeResponse>
#             <result>
#                 <apiCreatable>false</apiCreatable>
#                 <apiDeletable>false</apiDeletable>
#                 <apiReadable>false</apiReadable>
#                 <apiUpdatable>false</apiUpdatable>
#             </result>
#         </describeValueTypeResponse>
#     </soapenv:Body>
# </soapenv:Envelope>

# Sample code for parsing the XML response...
# Use this online tool to generate parsing code from sample XML: Generate XML Parsing Code

set soapenv_Envelope_xmlns_soapenv [CkXml_getAttrValue $xmlResponse "xmlns:soapenv"]
set soapenv_Envelope_xmlns [CkXml_getAttrValue $xmlResponse "xmlns"]
set apiCreatable [CkXml_getChildContent $xmlResponse "soapenv:Body|describeValueTypeResponse|result|apiCreatable"]
set apiDeletable [CkXml_getChildContent $xmlResponse "soapenv:Body|describeValueTypeResponse|result|apiDeletable"]
set apiReadable [CkXml_getChildContent $xmlResponse "soapenv:Body|describeValueTypeResponse|result|apiReadable"]
set apiUpdatable [CkXml_getChildContent $xmlResponse "soapenv:Body|describeValueTypeResponse|result|apiUpdatable"]

delete_CkHttp $http
delete_CkXml $xml
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkXml $xmlResponse

Curl Command

curl -X POST
	-H "Content-Type: text/xml"
	-H "charset: UTF-8"
	-H "SOAPAction: login"
	-H "Accept: text/xml"
	-d '<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://soap.sforce.com/2006/04/metadata">
	<soapenv:Header>
	<tns:SessionHeader>
		<tns:sessionId>{{_accessToken}}</tns:sessionId>
	</tns:SessionHeader>
	</soapenv:Header>
	<soapenv:Body>
		<tns:describeValueType>
			<type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>
		</tns:describeValueType>
	</soapenv:Body>
</soapenv:Envelope>'
https://domain.com/services/Soap/m/{{version}}

Postman Collection Item JSON

{
  "name": "SOAP DescribeValueType",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "text/xml",
        "type": "text"
      },
      {
        "key": "charset",
        "value": "UTF-8"
      },
      {
        "key": "SOAPAction",
        "value": "login"
      },
      {
        "key": "Accept",
        "value": "text/xml",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:tns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<soapenv:Header>\n\t<tns:SessionHeader>\n\t\t<tns:sessionId>{{_accessToken}}</tns:sessionId>\n\t</tns:SessionHeader>\n\t</soapenv:Header>\n\t<soapenv:Body>\n\t\t<tns:describeValueType>\n\t\t\t<type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>\n\t\t</tns:describeValueType>\n\t</soapenv:Body>\n</soapenv:Envelope>"
    },
    "url": {
      "raw": "{{_endpoint}}/services/Soap/m/{{version}}",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "Soap",
        "m",
        "{{version}}"
      ]
    }
  },
  "response": [
    {
      "name": "Status200-Success",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "text/xml"
          },
          {
            "key": "charset",
            "value": "UTF-8"
          },
          {
            "key": "SOAPAction",
            "value": "login"
          },
          {
            "key": "Accept",
            "value": "text/xml"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:tns=\"http://soap.sforce.com/2006/04/metadata\">\n\t<soapenv:Header>\n\t<tns:SessionHeader>\n\t\t<tns:sessionId>{{_accessToken}}</tns:sessionId>\n\t</tns:SessionHeader>\n\t</soapenv:Header>\n\t<soapenv:Body>\n\t\t<tns:describeValueType>\n\t\t\t<type>{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME</type>\n\t\t</tns:describeValueType>\n\t</soapenv:Body>\n</soapenv:Envelope>"
        },
        "url": {
          "raw": "{{_endpoint}}/services/Soap/m/{{version}}",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "Soap",
            "m",
            "{{version}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "xml",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 07 Sep 2023 09:25:45 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "text/xml; charset=utf-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <soapenv:Body>\n        <describeValueTypeResponse>\n            <result>\n                <apiCreatable>false</apiCreatable>\n                <apiDeletable>false</apiDeletable>\n                <apiReadable>false</apiReadable>\n                <apiUpdatable>false</apiUpdatable>\n            </result>\n        </describeValueTypeResponse>\n    </soapenv:Body>\n</soapenv:Envelope>"
    }
  ]
}