Chilkat Online Tools

Swift / Salesforce Platform APIs / Opportunities Closing Soon

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("query", value: "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}")
    json.UpdateString("variables", value: "{\n    \"month\": 10\n}")

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

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/services/data/v{{version}}/graphql", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var Id: String?
    var Value: String?
    var StageNameValue: String?
    var CloseDateValue: String?
    var DisplayValue: String?
    var DescriptionValue: String?

    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("data.uiapi.query.Opportunity.edges").intValue
    while i < count_i {
        jResp.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
    }

    i = 0
    count_i = jResp.SizeOfArray("errors").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }


}

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}"
    }
  ]
}