Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcValue
LOCAL lcStageNameValue
LOCAL lcCloseDateValue
LOCAL lcDisplayValue
LOCAL lcDescriptionValue
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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 opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}",
* "variables": "{\n \"month\": 10\n}"
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("query",'query opportunitiesClosingSoon($month: Long) {' + CHR(10) + ' uiapi {' + CHR(10) + ' query {' + CHR(10) + ' Opportunity(' + CHR(10) + ' where: {' + CHR(10) + ' StageName: { eq: "Negotiation/Review" }' + CHR(10) + ' CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }' + CHR(10) + ' }' + CHR(10) + ' ) {' + CHR(10) + ' edges {' + CHR(10) + ' node {' + CHR(10) + ' Id' + CHR(10) + ' Name {' + CHR(10) + ' value' + CHR(10) + ' }' + CHR(10) + ' StageName {' + 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) + ' }' + CHR(10) + ' }' + CHR(10) + ' }' + CHR(10) + ' }' + CHR(10) + ' }' + CHR(10) + '}')
loJson.UpdateString("variables",'{' + CHR(10) + ' "month": 10' + CHR(10) + '}')
* 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 = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "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
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "data": {
* "uiapi": {
* "query": {
* "Opportunity": {
* "edges": [
* {
* "node": {
* "Id": "00658000003ceg9AAA",
* "Name": {
* "value": "United Oil Refinery Generators"
* },
* "StageName": {
* "value": "Negotiation/Review"
* },
* "CloseDate": {
* "value": "2023-10-25",
* "displayValue": "25/10/2023"
* },
* "Description": {
* "value": "This is a sample opportunity."
* }
* }
* }
* ]
* }
* }
* }
* },
* "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")
lcStageNameValue = loJResp.StringOf("data.uiapi.query.Opportunity.edges[i].node.StageName.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")
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 opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}","variables":"{\n \"month\": 10\n}"}'
https://domain.com/services/data/v{{version}}/graphql
Postman Collection Item JSON
{
"name": "Opportunities Closing Soon",
"request": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}",
"variables": "{\n \"month\": 10\n}"
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/graphql",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"graphql"
]
}
},
"response": [
{
"name": "Opportunities Closing Soon",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosingSoon($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n StageName: { eq: \"Negotiation/Review\" }\n CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } }\n }\n ) {\n edges {\n node {\n Id\n Name {\n value\n }\n StageName {\n value\n }\n CloseDate {\n value\n displayValue\n }\n Description {\n value\n }\n }\n }\n }\n }\n }\n}",
"variables": "{\n \"month\": 10\n}"
}
},
"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:19:42 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\": \"00658000003ceg9AAA\",\n \"Name\": {\n \"value\": \"United Oil Refinery Generators\"\n },\n \"StageName\": {\n \"value\": \"Negotiation/Review\"\n },\n \"CloseDate\": {\n \"value\": \"2023-10-25\",\n \"displayValue\": \"25/10/2023\"\n },\n \"Description\": {\n \"value\": \"This is a sample opportunity.\"\n }\n }\n }\n ]\n }\n }\n }\n },\n \"errors\": []\n}"
}
]
}
