Chilkat Online Tools

delphiAx / Cognite API v1 / Retrieve files

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "items": [
//     {
//       "id": 8647257624772522
//     },
//     {
//       "externalId": "reprehenderit Excep"
//     }
//   ],
//   "ignoreUnknownIds": false
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateInt('items[0].id',123);
json.UpdateString('items[1].externalId','reprehenderit Excep');
json.UpdateBool('ignoreUnknownIds',0);

http.SetRequestHeader('content-type','application/json');
http.SetRequestHeader('api-key','{{api-key}}');

resp := http.PostJson3('https://domain.com/api/v1/projects/{{project}}/files/byids','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "id": 8647257624772522
        },
        {
            "externalId": "reprehenderit Excep"
        }
    ],
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/files/byids

Postman Collection Item JSON

{
  "id": "byIdsFiles",
  "name": "Retrieve files",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "files",
        "byids"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "Retrieves metadata information about multiple specific files in the same project. \nResults are returned in the same order as in the request. This operation does not return the file contents.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"id\": 8647257624772522\n        },\n        {\n            \"externalId\": \"reprehenderit Excep\"\n        }\n    ],\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}