GET /api/v3/datonis_files
List all datonis_files

Returns a list of all datonis_files belonging to an account as per the specified criteria. This API is paginated and returns 20 groups by default. A datonis_file is uniquely identified by a 'datonis_file_key'. This key should be used in all the other API referencing a particular datonis_file.

Params

Param name Description
page
optional

Page number of results to be fetched, Default 1


Value: Must be Integer.
per
optional

Number of datonis_file records to be returned in one page, Default 20


Value: Must be Integer.
order_by
optional

Field on which results should be sorted


Value: Must be a String
order
optional

Order, “asc” or “desc”, in which results should be sorted.


Value: Must be a String
timestamp_format
optional

Format, “str” or “int”, in which timestamps should be returned, Default “int”


Value: Must be a String
search
optional

Keywords based on which datonis_files should be searched. Currently you can search datonis_files on - datonis_file_key or name or type


Value: Must be a String
scope
optional

Matching condition if multiple keywords are specified for search. Valid values are “all” or “any”. Default is “all”


Value: Must be a String
pretty
optional

Return a pretty formatted response if true, Default is false


Value: Must be a Boolean
field_list
optional

List of fields required in the result.


Value: Must be an array of any type

GET /api/v3/datonis_files/:datonis_file_key
Fetch details of a specific datonis_file

Returns details of the datonis_file specified

Params

Param name Description
pretty
optional

Return a pretty formatted response if true, Default is false


Value: Must be a Boolean

Examples

Request - get details of the specified datonis_file (datonis_file_key specified as a part of the url)
  curl -X GET -H "Content-Type:application/json" -H "X-Auth-Token:DarTKU-eUJ7md2vS-lFroA" https://datonis.altizon.com/api/v3/datonis_files/1aat34a531

Response (details of the datonis_file requested)
{
  "datonis_file": {
    "created_at": 1453961408,
    "datonis_file_key": "1aat34a531",
    "description": "",
    "driver_class": "",
    "name": "scala-statistics_2.10-1.0.0.jar",
    "type": "jar",
    "updated_at": 1453961408
  }
}

POST /api/v3/datonis_files/:datonis_file_key/create_datonis_file.html
creates an datonis_file object and upload file.

creates an datonis_file object and upload file.

Params

Param name Description
pretty
optional

Return a pretty formatted response if true, Default is false


Value: Must be a Boolean

Examples

Request
  curl -X POST -H "Content-Type:multipart/form-data" -H "X-Auth-Token:Ko2rILQPWNxzFj1zudWx7g"  -F "type=file" -F "analytics_engine_key=2ef837f53e" -F "payload=@algo/app-log4j.properties" https://datonis.altizon.com/api/v3/datonis_files/create_datonis_file.html

Response
{
  "datonis_file_key": "2ef837f53e",
  "datonis_file_name": "app-log4j.properties",
  "datonis_file_type": "file",
  "created_at": 1441102263,
  "description": null,
  "driver_class": null,
  "updated_at": 1441102263
}

DELETE /api/v3/datonis_files/:datonis_file_key
Deletes the specified datonis_file

Deletes the specified datonis_file from the system

Params

Param name Description
pretty
optional

Return a pretty formatted response if true, Default is false


Value: Must be a Boolean

Examples

Request
  curl -X DELETE -H "Content-Type:application/json" -H "X-Auth-Token:Ko2rILQPWNxzFj1zudWx7g"  https://datonis.altizon.com/api/v3/datonis_files/89a6t97t4c

Response
{
}