Endpoints to Download and Modify Files

post

Returns an asset's file list.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

Body

application/json

pathstringOptional

Returns the list of files in this path. Use either this key or "filters", but not both together.

Example: /documentation

filtersobjectOptional

Possible filters that can be applied to the request. Use either this key or "path", but not both together.

Example: '{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'

Responses

200

OK

application/json

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

post

/files/{assetId}

HTTPcURLJavaScriptPython

POST /files/{assetId} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "path": "/documentation",
  "filters": "'{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'"
}

[]

get

Returns the specified file. If filePath does not represent a file, it returns the list of files at that location.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

filePathstringRequired

Path of the desired file, it includes the file name.

Example: /rawData/aggr_2m/123_124.npz

Responses

200

OK

application/octect-stream

Responsestring · binary

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

get

/files/{assetId}/{filePath}

HTTPcURLJavaScriptPython

GET /files/{assetId}/{filePath} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

binary

put

Updates the specified file. If it doesn't exists, it creates it.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

filePathstringRequired

Path of the desired file, it includes the file name.

Example: /rawData/aggr_2m/123_124.npz

Body

application/octet-stream

objectOptional

Responses

201

OK

application/octect-stream

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

put

/files/{assetId}/{filePath}

HTTPcURLJavaScriptPython

PUT /files/{assetId}/{filePath} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/octet-stream
Accept: */*
Content-Length: 2

{}

binary

delete

Deletes the specified file.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

filePathstringRequired

Path of the desired file, it includes the file name.

Example: /rawData/aggr_2m/123_124.npz

Responses

204

No response.

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

delete

/files/{assetId}/{filePath}

HTTPcURLJavaScriptPython

DELETE /files/{assetId}/{filePath} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

post

Returns the list of all configuration files both globals and specific for every project asset.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Query parameters

filterstringOptional

Filtro basato sui campi supportati.

orderbooleanOptional

Sort based on supported fields - see order syntax for more details. (name, path, type, size, timestamp, created, updated)

Body

application/json

pathstringOptional

Returns the list of files in this path. Use either this key or "filters", but not both together.

Example: /documentation

filtersobjectOptional

Possible filters that can be applied to the request. Use either this key or "path", but not both together.

Example: '{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'

Responses

200

OK

application/json

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

post

/configs/globals

HTTPcURLJavaScriptPython

POST /configs/globals HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "path": "/documentation",
  "filters": "'{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'"
}

[]

get

Returns the specified configuration file.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

filePathstringRequired

Path of the desired file, it includes the file name.

Example: /rawData/aggr_2m/123_124.npz

Responses

200

OK

application/json

Responseany of

objectOptional

or

arrayOptional

get

/configs/globals/{filePath}

HTTPcURLJavaScriptPython

GET /configs/globals/{filePath} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{}

post

This resource returns the list of all configuration files for the specified asset. Global configuration files are not included.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

Query parameters

filterstringOptional

Filtro basato sui campi supportati.

orderbooleanOptional

Sort based on supported fields - see order syntax for more details. (name, path, type, size, timestamp, created, updated)

Body

application/json

pathstringOptional

Returns the list of files in this path. Use either this key or "filters", but not both together.

Example: /documentation

filtersobjectOptional

Possible filters that can be applied to the request. Use either this key or "path", but not both together.

Example: '{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'

Responses

200

OK

application/json

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

post

/configs/{assetId}

HTTPcURLJavaScriptPython

POST /configs/{assetId} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "path": "/documentation",
  "filters": "'{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'"
}

[]

get

Returns the specified configuration file.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

filePathstringRequired

Path of the desired file, it includes the file name.

Example: /rawData/aggr_2m/123_124.npz

Responses

200

OK

application/json

get

/configs/{assetId}/{filePath}

HTTPcURLJavaScriptPython

GET /configs/{assetId}/{filePath} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "fileName": "123_456.npz",
  "size": 1024,
  "measureUnit": "B",
  "content": "text"
}

post

Returns the list of shared files

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

Body

application/json

pathstringOptional

Returns the list of files in this path. Use either this key or "filters", but not both together.

Example: /documentation

filtersobjectOptional

Possible filters that can be applied to the request. Use either this key or "path", but not both together.

Example: '{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'

Responses

200

success

application/json

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

post

/sharedFiles/{assetId}

HTTPcURLJavaScriptPython

POST /sharedFiles/{assetId} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "path": "/documentation",
  "filters": "'{'and' : [{'size' :{'>' : 0}}, {'fileExt' : '.txt'}]}'"
}

[]

get

Returns the content of the file found at the specified filepath.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

filePathstringRequired

In this case, filepath can be a composition of levels, e.g. /something/somethingelse/filename.ext .

Example: /rawData/aggr_2m/123_124.npz

Responses

200

Success

application/json

get

/sharedFiles/{assetId}/{filePath}

HTTPcURLJavaScriptPython

GET /sharedFiles/{assetId}/{filePath} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Success

{
  "fileName": "123_456.npz",
  "size": 1024,
  "measureUnit": "B",
  "content": "text"
}

put

Updates the specified file.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

filePathstringRequired

In this case, filepath can be a composition of levels, e.g. /something/somethingelse/filename.ext .

Example: /rawData/aggr_2m/123_124.npz

Body

application/octet-stream

objectOptional

Responses

200

Success

application/json

put

/sharedFiles/{assetId}/{filePath}

HTTPcURLJavaScriptPython

PUT /sharedFiles/{assetId}/{filePath} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/octet-stream
Accept: */*
Content-Length: 2

{}

200

Success

{
  "fileName": "123_456.npz",
  "size": 1024
}