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.
# {
# "name": "officia nisi",
# "externalId": "in",
# "directory": "et dolor",
# "source": "pariatur dolor aliqua nostrud",
# "mimeType": "occaecat est",
# "metadata": {},
# "assetIds": [
# 4034774287403938,
# 2425651827249892
# ],
# "dataSetId": 53722416444006,
# "sourceCreatedTime": 77683565,
# "sourceModifiedTime": 68614962,
# "securityCategories": [
# 1979707127020012,
# 747443067645264
# ],
# "labels": [
# {
# "externalId": "officia reprehenderit Ut"
# },
# {
# "externalId": "consectetur exercitation ipsum"
# }
# ],
# "geoLocation": {
# "type": "Feature",
# "geometry": {
# "type": "MultiPoint",
# "coordinates": [
# ]
# },
# "properties": {}
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("name","officia nisi")
json.UpdateString("externalId","in")
json.UpdateString("directory","et dolor")
json.UpdateString("source","pariatur dolor aliqua nostrud")
json.UpdateString("mimeType","occaecat est")
json.UpdateNewObject("metadata")
json.UpdateInt("assetIds[0]",4034774287403938)
json.UpdateInt("assetIds[1]",2425651827249892)
json.UpdateInt("dataSetId",123)
json.UpdateInt("sourceCreatedTime",77683565)
json.UpdateInt("sourceModifiedTime",68614962)
json.UpdateInt("securityCategories[0]",1979707127020012)
json.UpdateInt("securityCategories[1]",747443067645264)
json.UpdateString("labels[0].externalId","officia reprehenderit Ut")
json.UpdateString("labels[1].externalId","consectetur exercitation ipsum")
json.UpdateString("geoLocation.type","Feature")
json.UpdateString("geoLocation.geometry.type","MultiPoint")
json.UpdateNewArray("geoLocation.geometry.coordinates")
json.UpdateNewObject("geoLocation.properties")
http.SetRequestHeader("content-type","application/json")
http.SetRequestHeader("api-key","{{api-key}}")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/files?overwrite=false","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
Curl Command
curl -X POST
-H "api-key: {{api-key}}"
-H "content-type: application/json"
-d '{
"name": "officia nisi",
"externalId": "in",
"directory": "et dolor",
"source": "pariatur dolor aliqua nostrud",
"mimeType": "occaecat est",
"metadata": {},
"assetIds": [
4034774287403938,
2425651827249892
],
"dataSetId": 53722416444006,
"sourceCreatedTime": 77683565,
"sourceModifiedTime": 68614962,
"securityCategories": [
1979707127020012,
747443067645264
],
"labels": [
{
"externalId": "officia reprehenderit Ut"
},
{
"externalId": "consectetur exercitation ipsum"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "MultiPoint",
"coordinates": []
},
"properties": {}
}
}'
https://domain.com/api/v1/projects/{{project}}/files?overwrite=false
Postman Collection Item JSON
{
"id": "initFileUpload",
"name": "Upload file",
"request": {
"url": {
"host": "{{baseUrl}}",
"path": [
"api",
"v1",
"projects",
"{{project}}",
"files"
],
"query": [
{
"key": "overwrite",
"description": "If 'overwrite' is set to true, and the POST body content specifies a 'externalId' field, fields for the file found for externalId can be overwritten. The default setting is false. \n\nIf metadata is included in the request body, all of the original metadata will be overwritten.\nThe actual file will be overwritten after a successful upload with the uploadUrl from the response. \nIf there is no successful upload, the current file contents will be kept. \n\nFile-Asset mappings only change if explicitly stated in the assetIds field of the POST json body. \nDo not set assetIds in request body if you want to keep the current file-asset mappings.",
"value": "false",
"disabled": true
}
],
"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": "Create metadata information and get an upload link for a file.\n\nTo upload the file, use the uploadUrl link in the response in a separate request. \nTo upload a file, send an HTTP PUT request to the uploadUrl with the relevant 'Content-Type' and 'Content-Length' headers.\n\nIf the uploadUrl contains the string '/v1/files/gcs_proxy/', you can make a Google Cloud Storage (GCS) resumable upload request\nas documented in https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload.\n\nThe uploadUrl expires after one week. \nAny file info entry that does not have the actual file uploaded within one week will be automatically deleted.",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"officia nisi\",\n \"externalId\": \"in\",\n \"directory\": \"et dolor\",\n \"source\": \"pariatur dolor aliqua nostrud\",\n \"mimeType\": \"occaecat est\",\n \"metadata\": {},\n \"assetIds\": [\n 4034774287403938,\n 2425651827249892\n ],\n \"dataSetId\": 53722416444006,\n \"sourceCreatedTime\": 77683565,\n \"sourceModifiedTime\": 68614962,\n \"securityCategories\": [\n 1979707127020012,\n 747443067645264\n ],\n \"labels\": [\n {\n \"externalId\": \"officia reprehenderit Ut\"\n },\n {\n \"externalId\": \"consectetur exercitation ipsum\"\n }\n ],\n \"geoLocation\": {\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"MultiPoint\",\n \"coordinates\": []\n },\n \"properties\": {}\n }\n}"
}
}
}
