Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Introspection Query

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "query": "query IntrospectionQuery {\n  __schema {\n    queryType {\n      name\n    }\n    mutationType {\n      name\n    }\n    subscriptionType {\n      name\n    }\n    types {\n      ...FullType\n    }\n    directives {\n      name\n      description\n      args {\n        ...InputValue\n      }\n      onOperation\n      onFragment\n      onField\n      locations\n    }\n  }\n}\nfragment FullType on __Type {\n  kind\n  name\n  description\n  fields(includeDeprecated: true) {\n    name\n    description\n    args {\n      ...InputValue\n    }\n    type {\n      ...TypeRef\n    }\n    isDeprecated\n    deprecationReason\n  }\n  inputFields {\n    ...InputValue\n  }\n  interfaces {\n    ...TypeRef\n  }\n  enumValues(includeDeprecated: true) {\n    name\n    description\n    isDeprecated\n    deprecationReason\n  }\n  possibleTypes {\n    ...TypeRef\n  }\n}\nfragment InputValue on __InputValue {\n  name\n  description\n  type {\n    ...TypeRef\n  }\n  defaultValue\n}\nfragment TypeRef on __Type {\n  kind\n  name\n  ofType {\n    kind\n    name\n    ofType {\n      kind\n      name\n      ofType {\n        kind\n        name\n      }\n    }\n  }\n}\n",
    ;   "variables": ""
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"query","query IntrospectionQuery {" + Chr(10) + "  __schema {" + Chr(10) + "    queryType {" + Chr(10) + "      name" + Chr(10) + "    }" + Chr(10) + "    mutationType {" + Chr(10) + "      name" + Chr(10) + "    }" + Chr(10) + "    subscriptionType {" + Chr(10) + "      name" + Chr(10) + "    }" + Chr(10) + "    types {" + Chr(10) + "      ...FullType" + Chr(10) + "    }" + Chr(10) + "    directives {" + Chr(10) + "      name" + Chr(10) + "      description" + Chr(10) + "      args {" + Chr(10) + "        ...InputValue" + Chr(10) + "      }" + Chr(10) + "      onOperation" + Chr(10) + "      onFragment" + Chr(10) + "      onField" + Chr(10) + "      locations" + Chr(10) + "    }" + Chr(10) + "  }" + Chr(10) + "}" + Chr(10) + "fragment FullType on __Type {" + Chr(10) + "  kind" + Chr(10) + "  name" + Chr(10) + "  description" + Chr(10) + "  fields(includeDeprecated: true) {" + Chr(10) + "    name" + Chr(10) + "    description" + Chr(10) + "    args {" + Chr(10) + "      ...InputValue" + Chr(10) + "    }" + Chr(10) + "    type {" + Chr(10) + "      ...TypeRef" + Chr(10) + "    }" + Chr(10) + "    isDeprecated" + Chr(10) + "    deprecationReason" + Chr(10) + "  }" + Chr(10) + "  inputFields {" + Chr(10) + "    ...InputValue" + Chr(10) + "  }" + Chr(10) + "  interfaces {" + Chr(10) + "    ...TypeRef" + Chr(10) + "  }" + Chr(10) + "  enumValues(includeDeprecated: true) {" + Chr(10) + "    name" + Chr(10) + "    description" + Chr(10) + "    isDeprecated" + Chr(10) + "    deprecationReason" + Chr(10) + "  }" + Chr(10) + "  possibleTypes {" + Chr(10) + "    ...TypeRef" + Chr(10) + "  }" + Chr(10) + "}" + Chr(10) + "fragment InputValue on __InputValue {" + Chr(10) + "  name" + Chr(10) + "  description" + Chr(10) + "  type {" + Chr(10) + "    ...TypeRef" + Chr(10) + "  }" + Chr(10) + "  defaultValue" + Chr(10) + "}" + Chr(10) + "fragment TypeRef on __Type {" + Chr(10) + "  kind" + Chr(10) + "  name" + Chr(10) + "  ofType {" + Chr(10) + "    kind" + Chr(10) + "    name" + Chr(10) + "    ofType {" + Chr(10) + "      kind" + Chr(10) + "      name" + Chr(10) + "      ofType {" + Chr(10) + "        kind" + Chr(10) + "        name" + Chr(10) + "      }" + Chr(10) + "    }" + Chr(10) + "  }" + Chr(10) + "}" + Chr(10))
    CkJsonObject::ckUpdateString(json,"variables","")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"X-Chatter-Entity-Encoding","false")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/graphql","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-Chatter-Entity-Encoding: false"
	--data-raw '{"query":"query IntrospectionQuery {\n  __schema {\n    queryType {\n      name\n    }\n    mutationType {\n      name\n    }\n    subscriptionType {\n      name\n    }\n    types {\n      ...FullType\n    }\n    directives {\n      name\n      description\n      args {\n        ...InputValue\n      }\n      onOperation\n      onFragment\n      onField\n      locations\n    }\n  }\n}\nfragment FullType on __Type {\n  kind\n  name\n  description\n  fields(includeDeprecated: true) {\n    name\n    description\n    args {\n      ...InputValue\n    }\n    type {\n      ...TypeRef\n    }\n    isDeprecated\n    deprecationReason\n  }\n  inputFields {\n    ...InputValue\n  }\n  interfaces {\n    ...TypeRef\n  }\n  enumValues(includeDeprecated: true) {\n    name\n    description\n    isDeprecated\n    deprecationReason\n  }\n  possibleTypes {\n    ...TypeRef\n  }\n}\nfragment InputValue on __InputValue {\n  name\n  description\n  type {\n    ...TypeRef\n  }\n  defaultValue\n}\nfragment TypeRef on __Type {\n  kind\n  name\n  ofType {\n    kind\n    name\n    ofType {\n      kind\n      name\n      ofType {\n        kind\n        name\n      }\n    }\n  }\n}\n","variables":""}'
https://domain.com/services/data/v{{version}}/graphql

Postman Collection Item JSON

{
  "name": "Introspection Query",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-Chatter-Entity-Encoding",
        "value": "false",
        "type": "text"
      }
    ],
    "body": {
      "mode": "graphql",
      "graphql": {
        "query": "query IntrospectionQuery {\n  __schema {\n    queryType {\n      name\n    }\n    mutationType {\n      name\n    }\n    subscriptionType {\n      name\n    }\n    types {\n      ...FullType\n    }\n    directives {\n      name\n      description\n      args {\n        ...InputValue\n      }\n      onOperation\n      onFragment\n      onField\n      locations\n    }\n  }\n}\nfragment FullType on __Type {\n  kind\n  name\n  description\n  fields(includeDeprecated: true) {\n    name\n    description\n    args {\n      ...InputValue\n    }\n    type {\n      ...TypeRef\n    }\n    isDeprecated\n    deprecationReason\n  }\n  inputFields {\n    ...InputValue\n  }\n  interfaces {\n    ...TypeRef\n  }\n  enumValues(includeDeprecated: true) {\n    name\n    description\n    isDeprecated\n    deprecationReason\n  }\n  possibleTypes {\n    ...TypeRef\n  }\n}\nfragment InputValue on __InputValue {\n  name\n  description\n  type {\n    ...TypeRef\n  }\n  defaultValue\n}\nfragment TypeRef on __Type {\n  kind\n  name\n  ofType {\n    kind\n    name\n    ofType {\n      kind\n      name\n      ofType {\n        kind\n        name\n      }\n    }\n  }\n}\n",
        "variables": ""
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "graphql"
      ]
    }
  },
  "response": [
  ]
}