Chilkat Online Tools

PowerBuilder / Salesforce Platform APIs / SOAP DescribeValueType

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Xml
oleobject loo_SbRequestBody
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_XmlResponse
string ls_Soapenv_Envelope_xmlns_soapenv
string ls_Soapenv_Envelope_xmlns
string ls_ApiCreatable
string ls_ApiDeletable
string ls_ApiReadable
string ls_ApiUpdatable

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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>
// 

loo_Xml = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

loo_Xml.Tag = "soapenv:Envelope"
loo_Xml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
loo_Xml.AddAttribute("xmlns:tns","http://soap.sforce.com/2006/04/metadata")
loo_Xml.UpdateChildContent("soapenv:Header|tns:SessionHeader|tns:sessionId","{{_accessToken}}")
loo_Xml.UpdateChildContent("soapenv:Body|tns:describeValueType|type","{http://soap.sforce.com/2006/04/metadata}INSERT_METADATA_TYPE_NAME")

loo_Http.SetRequestHeader("Content-Type","text/xml")
loo_Http.SetRequestHeader("SOAPAction","login")
loo_Http.SetRequestHeader("Accept","text/xml")
loo_Http.SetRequestHeader("charset","UTF-8")

loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Xml.GetXmlSb(loo_SbRequestBody)

loo_Resp = loo_Http.PTextSb("POST","https://domain.com/services/Soap/m/{{version}}",loo_SbRequestBody,"utf-8","text/xml",0,0)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Xml
    destroy loo_SbRequestBody
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)
destroy loo_Resp

loo_XmlResponse = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_XmlResponse.ConnectToNewObject("Chilkat.Xml")

loo_XmlResponse.LoadSb(loo_SbResponseBody,1)
Write-Debug loo_XmlResponse.GetXml()

// 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

ls_Soapenv_Envelope_xmlns_soapenv = loo_XmlResponse.GetAttrValue("xmlns:soapenv")
ls_Soapenv_Envelope_xmlns = loo_XmlResponse.GetAttrValue("xmlns")
ls_ApiCreatable = loo_XmlResponse.GetChildContent("soapenv:Body|describeValueTypeResponse|result|apiCreatable")
ls_ApiDeletable = loo_XmlResponse.GetChildContent("soapenv:Body|describeValueTypeResponse|result|apiDeletable")
ls_ApiReadable = loo_XmlResponse.GetChildContent("soapenv:Body|describeValueTypeResponse|result|apiReadable")
ls_ApiUpdatable = loo_XmlResponse.GetChildContent("soapenv:Body|describeValueTypeResponse|result|apiUpdatable")


destroy loo_Http
destroy loo_Xml
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_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>"
    }
  ]
}