Chilkat Online Tools

Swift3 / Cognite API v1 / Get icon

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

    http.setRequestHeader("api-key", value: "{{api-key}}")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://domain.com/api/v1/projects/{{project}}/files/icon", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("Response status code = \(http.lastStatus.intValue)")
    print("\(sbResponseBody.getAsString()!)")

}

Curl Command

curl -X GET
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/files/icon?

Postman Collection Item JSON

{
  "id": "getIcon",
  "name": "Get icon",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "files",
        "icon"
      ],
      "query": [
        {
          "key": "id",
          "description": "A server-generated ID for the object.",
          "disabled": true
        },
        {
          "key": "externalId",
          "description": "The external ID provided by the client. Must be unique for the resource type.",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "The GET /files/icon operation can be used to get an image representation of a file.\n\nEither id or externalId must be provided as a query parameter (but not both).\nSupported file formats:\n- Normal jpeg and png files are currently fully supported.\n- Other image file formats might work, but continued support for these are not guaranteed.\n- Currently only supporting thumbnails for image files.\nAttempts to get icon for unsupported files will result in status 400."
  }
}