Ruby / Salesforce Platform APIs / Opportunities Closing Soon (Explicit AND)
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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 opportunitiesClosingSoonExplicitAND($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n and: [\n { StageName: { eq: \"Negotiation/Review\" } }\n { CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } } }\n ]\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}"
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("query","query opportunitiesClosingSoonExplicitAND($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n and: [\n { StageName: { eq: \"Negotiation/Review\" } }\n { CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } } }\n ]\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}")
json.UpdateString("variables","{\n \"month\": 10\n}")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("X-Chatter-Entity-Encoding","false")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/graphql","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
count_i = jResp.SizeOfArray("data.uiapi.query.Opportunity.edges")
while i < count_i
jResp.put_I(i)
Id = jResp.stringOf("data.uiapi.query.Opportunity.edges[i].node.Id")
Value = jResp.stringOf("data.uiapi.query.Opportunity.edges[i].node.Name.value")
StageNameValue = jResp.stringOf("data.uiapi.query.Opportunity.edges[i].node.StageName.value")
CloseDateValue = jResp.stringOf("data.uiapi.query.Opportunity.edges[i].node.CloseDate.value")
DisplayValue = jResp.stringOf("data.uiapi.query.Opportunity.edges[i].node.CloseDate.displayValue")
DescriptionValue = jResp.stringOf("data.uiapi.query.Opportunity.edges[i].node.Description.value")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("errors")
while i < count_i
jResp.put_I(i)
i = i + 1
end
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-Chatter-Entity-Encoding: false"
--data-raw '{"query":"query opportunitiesClosingSoonExplicitAND($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n and: [\n { StageName: { eq: \"Negotiation/Review\" } }\n { CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } } }\n ]\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 (Explicit AND)",
"request": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false",
"type": "text"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosingSoonExplicitAND($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n and: [\n { StageName: { eq: \"Negotiation/Review\" } }\n { CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } } }\n ]\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 (Explicit AND)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-Chatter-Entity-Encoding",
"value": "false"
}
],
"body": {
"mode": "graphql",
"graphql": {
"query": "query opportunitiesClosingSoonExplicitAND($month: Long) {\n uiapi {\n query {\n Opportunity(\n where: {\n and: [\n { StageName: { eq: \"Negotiation/Review\" } }\n { CloseDate: { CALENDAR_MONTH: { value: { eq: $month } } } }\n ]\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:20:51 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}"
}
]
}
