Secured Content Storage Service¶

Summary¶

File storage management, upload and retrieval service.

This service is natively used by: - TSDB (timeseries database) service to export archived files. - Device2 (device connectivity) to save file uploaded by devices.

In IoT-connector, content service files are also available for device to be securely downloaded.

Operations

Events

Configuration parameters¶

Operations¶

archive¶

Description

Append a line of time series data to the next archive file.

Arguments

Responses

• Returns nil for The provided time series data has been successfully buffered for archival.

• Returns {object} when The provided time series data is invalid.

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

clear¶

Description

Deletes all the content for the given context/solution

Responses

• Returns {[ object ]} for An array of the ids of the deleted content items

  Name	Type	Description
  id	string	The id of the content item

• Returns {object} when An error occurred

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

Example

response.message = Content.clear()

delete¶

Description

Delete the given content item

Arguments

Responses

• Returns {object} when The content item was deleted

  The content item id {object}

  Name	Type	Description
  id	string	The id of the content item

• Returns {object} when An error occurred

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

Example

response.message = Content.delete({
  id = 'image.png',
})

deleteMulti¶

Description

Delete multiple files in a solution

Arguments

Responses

• Returns nil for Files deleted

Example

return Content.deleteMulti({"file1", "file2"})

download¶

Description

Get the download URL for the specified content item

Arguments

Responses

• Returns {object} when The download URL

  HTTP information for client-side content downloads {object}

  Name	Type	Description
  id	string	The id of the content item
  url	string	The URL to use
  method	"GET"	The HTTP method to use with this URL

• Returns {object} when An error occurred

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

Example

local filename = "image.png" local file_type = "image/png" local expires_in = 600
local presigned_download = Content.download({
  id = filename,
  type = file_type,
  expires_in = expires_in,
})
-- Create curl download command local curl_command = "curl --output " .. filename .. " "
curl_command = curl_command .. presigned_download.url
return curl_command

downloadAll¶

Description

Get the download URL list for this context

Arguments

Responses

• Returns {[ object ]} for The download URL list

  Name	Type	Description
  id	string	The id of the content item
  url	string	The URL to use
  method	"GET"	The HTTP method to use with this URL

• Returns {object} when An error occurred

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

Example

local opts = {
  cursor = nil, -- specify the file id to start with
  limit = 5,
  expires_in = 600
}
-- This will return download urls for all files return Content.downloadAll(opts)

info¶

Description

Retrieve metadata and tags associated with uploaded content

Arguments

Responses

• Returns {object} when The content info

  A content item's metadata and tags {object}

  Name	Type	Description
  id	string	The id of the content item
  tags	object	Tags and their values for the content item
  tags.*	string	Tag value
  type	string	The mime type of the content item
  length	integer	The content item's length in bytes
  last_modified	string(dateTime)	Last modified timestamp (formatted as ISO 8601)

• Returns {object} when An error occurred

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

Example

response.message = Content.info({
  id = 'image.png',
})

list¶

Description

Get the list of content items for the solution

Arguments

Responses

• Returns {[ object ]} for An array of content items

  Name	Type	Description
  id	string	The id of the content item
  tags	object	Tags and their values for the content item
  tags.*	string	Tag value
  type	string	The mime type of the content item
  length	integer	The content item's length in bytes
  last_modified	string(dateTime)	Last modified timestamp (formatted as ISO 8601)

• Returns {object} when An error occurred

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

Example

response.message = Content.list({
  full = true
})
-- or
response.message = Content.list({
  tags = to_json({mykey = "myvalue"})
})
-- or
response.message = Content.list({
  tags = to_json({mykey = "myvalue", mykey2 = "myvalue2"}),
  op = "OR"
})

upload¶

Description

Get the upload URL for the specified content item. The content ID will be generated if not supplied, and can be generated using the key, if provided

Arguments

Responses

• Returns {object} when The upload URL

  HTTP information for client-side content uploads {object}

  Name	Type	Description
  id	string	The id of the content item
  url	string	The URL to use
  field	string	The name of the part containing upload data (must be LAST)
  inputs	object	Additional parts expected with the upload
  method	"POST"	The HTTP method to use with this URL
  enctype	string	The expected form-data encoding to use

• Returns {object} when An error occurred

  Error information {object}

  Name	Type	Description
  type	string	The error message's type
  message	string	The associated error message

Example

local filename = "image.png" local file_type = "image/png" local expires_in = 600
local presigned_upload = Content.upload({
  id = filename,
  type = file_type,
  expires_in = expires_in,
})
-- Create curl upload command local curl_command = "curl"
for k, v in pairs(presigned_upload.inputs) do
  curl_command = curl_command .. " -F \"" .. k .. "=" .. v .."\""
end -- This assumes the file exist in the same directory as curl is being called from. curl_command = curl_command .. " -F file=@" .. filename .. " " .. presigned_upload.url
return curl_command

Events¶

event¶

Description

Notification indicating that files have been changed

Arguments

Example

for _,id in ipairs(event.ids) do
  print("File " .. id .. " was " .. event.action )
end