Chilkat Online Tools

lianja / Salesforce Platform APIs / Opportunities Early Stage

Back to Collection Items

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

loHttp = createobject("CkHttp")

// 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 opportunitiesClosed {\n  uiapi {\n    query {\n      Opportunity(\n        where: {\n          or: [\n            { StageName: { eq: \"Prospecting\" } }\n            { StageName: { eq: \"Needs Analysis\" } }\n          ]\n        }\n      ) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n            CloseDate {\n              value\n              displayValue\n            }\n            Description {\n              value\n            }\n            StageName {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}",
//   "variables": ""
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("query",'query opportunitiesClosed {' + Chr(10) + '  uiapi {' + Chr(10) + '    query {' + Chr(10) + '      Opportunity(' + Chr(10) + '        where: {' + Chr(10) + '          or: [' + Chr(10) + '            { StageName: { eq: "Prospecting" } }' + Chr(10) + '            { StageName: { eq: "Needs Analysis" } }' + Chr(10) + '          ]' + Chr(10) + '        }' + Chr(10) + '      ) {' + Chr(10) + '        edges {' + Chr(10) + '          node {' + Chr(10) + '            Id' + Chr(10) + '            Name {' + Chr(10) + '              value' + Chr(10) + '            }' + Chr(10) + '            CloseDate {' + Chr(10) + '              value' + Chr(10) + '              displayValue' + Chr(10) + '            }' + Chr(10) + '            Description {' + Chr(10) + '              value' + Chr(10) + '            }' + Chr(10) + '            StageName {' + Chr(10) + '              value' + Chr(10) + '            }' + Chr(10) + '          }' + Chr(10) + '        }' + Chr(10) + '      }' + Chr(10) + '    }' + Chr(10) + '  }' + Chr(10) + '}')
loJson.UpdateString("variables","")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("X-Chatter-Entity-Encoding","false")

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/graphql","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": {
//     "uiapi": {
//       "query": {
//         "Opportunity": {
//           "edges": [
//             {
//               "node": {
//                 "Id": "00658000003cegEAAQ",
//                 "Name": {
//                   "value": "Pyramid Emergency Generators"
//                 },
//                 "CloseDate": {
//                   "value": "2014-04-19",
//                   "displayValue": "19/04/2014"
//                 },
//                 "Description": {
//                   "value": "This is a sample description"
//                 },
//                 "StageName": {
//                   "value": "Prospecting"
//                 }
//               }
//             },
//             {
//               "node": {
//                 "Id": "00658000003cegXAAQ",
//                 "Name": {
//                   "value": "United Oil Plant Standby Generators"
//                 },
//                 "CloseDate": {
//                   "value": "2014-04-19",
//                   "displayValue": "19/04/2014"
//                 },
//                 "Description": {
//                   "value": "00658000003cegXAAQ"
//                 },
//                 "StageName": {
//                   "value": "Needs Analysis"
//                 }
//               }
//             }
//           ]
//         }
//       }
//     }
//   },
//   "errors": [
//   ]
// }

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

i = 0
lnCount_i = loJResp.SizeOfArray("data.uiapi.query.Opportunity.edges")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data.uiapi.query.Opportunity.edges[i].node.Id")
    lcValue = loJResp.StringOf("data.uiapi.query.Opportunity.edges[i].node.Name.value")
    lcCloseDateValue = loJResp.StringOf("data.uiapi.query.Opportunity.edges[i].node.CloseDate.value")
    lcDisplayValue = loJResp.StringOf("data.uiapi.query.Opportunity.edges[i].node.CloseDate.displayValue")
    lcDescriptionValue = loJResp.StringOf("data.uiapi.query.Opportunity.edges[i].node.Description.value")
    lcStageNameValue = loJResp.StringOf("data.uiapi.query.Opportunity.edges[i].node.StageName.value")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("errors")
do while i < lnCount_i
    loJResp.I = i
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "X-Chatter-Entity-Encoding: false"
	--data-raw '{"query":"query opportunitiesClosed {\n  uiapi {\n    query {\n      Opportunity(\n        where: {\n          or: [\n            { StageName: { eq: \"Prospecting\" } }\n            { StageName: { eq: \"Needs Analysis\" } }\n          ]\n        }\n      ) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n            CloseDate {\n              value\n              displayValue\n            }\n            Description {\n              value\n            }\n            StageName {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}","variables":""}'
https://domain.com/services/data/v{{version}}/graphql

Postman Collection Item JSON

{
  "name": "Opportunities Early Stage",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-Chatter-Entity-Encoding",
        "value": "false",
        "type": "text"
      }
    ],
    "body": {
      "mode": "graphql",
      "graphql": {
        "query": "query opportunitiesClosed {\n  uiapi {\n    query {\n      Opportunity(\n        where: {\n          or: [\n            { StageName: { eq: \"Prospecting\" } }\n            { StageName: { eq: \"Needs Analysis\" } }\n          ]\n        }\n      ) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n            CloseDate {\n              value\n              displayValue\n            }\n            Description {\n              value\n            }\n            StageName {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}",
        "variables": ""
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "graphql"
      ]
    }
  },
  "response": [
    {
      "name": "Opportunities Early Stage",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "X-Chatter-Entity-Encoding",
            "value": "false"
          }
        ],
        "body": {
          "mode": "graphql",
          "graphql": {
            "query": "query opportunitiesClosed {\n  uiapi {\n    query {\n      Opportunity(\n        where: {\n          or: [\n            { StageName: { eq: \"Prospecting\" } }\n            { StageName: { eq: \"Needs Analysis\" } }\n          ]\n        }\n      ) {\n        edges {\n          node {\n            Id\n            Name {\n              value\n            }\n            CloseDate {\n              value\n              displayValue\n            }\n            Description {\n              value\n            }\n            StageName {\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n}",
            "variables": ""
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "graphql"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 06 Oct 2023 09:22:21 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": {\n        \"uiapi\": {\n            \"query\": {\n                \"Opportunity\": {\n                    \"edges\": [\n                        {\n                            \"node\": {\n                                \"Id\": \"00658000003cegEAAQ\",\n                                \"Name\": {\n                                    \"value\": \"Pyramid Emergency Generators\"\n                                },\n                                \"CloseDate\": {\n                                    \"value\": \"2014-04-19\",\n                                    \"displayValue\": \"19/04/2014\"\n                                },\n                                \"Description\": {\n                                    \"value\": \"This is a sample description\"\n                                },\n                                \"StageName\": {\n                                    \"value\": \"Prospecting\"\n                                }\n                            }\n                        },\n                        {\n                            \"node\": {\n                                \"Id\": \"00658000003cegXAAQ\",\n                                \"Name\": {\n                                    \"value\": \"United Oil Plant Standby Generators\"\n                                },\n                                \"CloseDate\": {\n                                    \"value\": \"2014-04-19\",\n                                    \"displayValue\": \"19/04/2014\"\n                                },\n                                \"Description\": {\n                                    \"value\": \"00658000003cegXAAQ\"\n                                },\n                                \"StageName\": {\n                                    \"value\": \"Needs Analysis\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        }\n    },\n    \"errors\": []\n}"
    }
  ]
}