...
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/export-job/<export-job-configuration-id>'
Example
...
Datameer v6.3 and prior version responses
response
Code Block |
---|
{ "version": "62.0.30.84", "className": "datameer.dap.common.entity.FileDataSinkImpl", "file": { "uuid": "cd7613ff-ce0a-4a6b-ae06-c7d09d65bc70", "path": "/Data/ExportJobsAdmin/REST_API_TestExportJob.exp", "description": "", "namedescription": "REST_API_TestExportJob112" }, "pullType": "MANUALLY", "minKeepCount": 1, "properties": {}, "hadoopProperties": "",Test Export Job" }, "connectionpullType": "/Data/Connections/Datameer server filesystem", "sheet": {MANUALLY", "nameminKeepCount": "status"1, "sheetId": "2228a24d-87fc-4bf5-bc40-3b7486c33a49", "workbook": { "path": "/Analytics/Workbooks/apache_log_wb.wbk", "uuid": "1a552255-3f2a-407d-9270-2813af4c1a74" } }, "mappings": [ { "properties": {}, "namehadoopProperties": "A", "srcColumnIndex": 0, "nullable": true }, { "name": "B", "srcColumnIndex": 1, "nullable": true } ], "errorHandlingMode": "DROP_RECORD", "notificationAddresses": "", "notificationSuccessAddresses": "", "fileName": "/Users/Rob/desktop/REST_API_TestExportJob", "confirmOverwrite": false, "clearTargetDirectory": false, "includeHeader": true, "delimiterString": ",", "quoteString": "\"", "escapeString": "\\", "characterEncoding": "UTF-8", "exportFileType": "datameer.dap.common.csv.CsvExportFileType" } |
Datameer v6.4 response
Code Block |
---|
{ "version": "6.4.6", "className": "datameer.dap.common.entity.FileDataSinkImpl", "file": { "uuid": "28583776-7798-495f-9aca-a1b78bad5406", "path": "/Data/ExportJobs/REST_API_TestExportJob.exp", "description": "", "name": "REST_API_TestExportJob" }, "pullType": "MANUALLY", "minKeepCount": 1, "properties": { "filename": [ "/Users/Rob/desktop/REST_API_TestExportJob" ], "replace_data": [ "false" ], "max_filesize_in_mb": [connection": "/Admin/DFS_DataStore", "sheet": { "name": "Sheet1", "workbook": "/Admin/ExplodeRange.wbk" }, "mappings": [ { "name": "A", "srcColumnIndex": ]0, "consecutive_numbering": [ "" ], "header": [ "true"nullable": true ], "delimiter": [ ","} ], "quoteCharacter": [ "\"" ], "escapeCharacter": [ "\\" ], "character_encoding": [ "UTF-8" ] }, "hadoopProperties": "", "connection": "/Data/Connections/Datameer server filesystem", "sheet": {"errorHandlingMode": "DROP_RECORD", "fullDataPermission": 63, "namenotificationAddresses": "status", "sheetIdnotificationSuccessAddresses": "2228a24d-87fc-4bf5-bc40-3b7486c33a49", "workbook": { "path"fileName": "/Analytics/Workbooks/apache_log_wb.wbkTestExport", "uuidconfirmOverwrite": "1a552255-3f2a-407d-9270-2813af4c1a74" } }, "mappings": [ { false, "nameclearTargetDirectory": "A"false, "srcColumnIndexincludeHeader": 0, "nullable": true }, { "namedelimiterString": "B", "srcColumnIndex": 1, "nullablequoteString": true } ], "errorHandlingMode": "DROP_RECORD"\"", "notificationAddresses": "", "notificationSuccessAddressesescapeString": "\\", "confirmOverwrite": false, "exportFileTypecharacterEncoding": "datameer.dap.common.csv.CsvExportFileTypeISO-8859-1" } |
Anchor | ||||
---|---|---|---|---|
|
...
curl -u '<username>:<password>' -X POST -d @<job-payload>.json 'http://<Datameer-serverIP>:<port-number>/rest/export-job'
Example response
Code Block |
---|
{ "configuration-id": 480, "status": "success" } |
...
curl -u '<username>:<password>' -X PUT -d @<job-payload>.json 'http://<Datameer-serverIP>:<port-number>/rest/export-job/<export-job-configuration-id>'
Example response
Code Block |
---|
{"status": "success"} |
...
curl -u '<username>:<password>' -X DELETE 'http://<Datameer-serverIP>:<port-number>/rest/export-job/<export-job-configuration-id>'
Example response
Code Block |
---|
{"status": "success"} |
...
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/export-job'
Example response
Code Block |
---|
[ { "description": "", "id": 272, "name": "exp_kp0705_oracle", "path": "/ExportJobs/exp_kp0705_oracle.exp" }, { "description": "", "id": 427, "name": "exp hdfs", "path": "/ExportJobs/tester/exp hdfs.exp" }, { "description": "", "id": 428, "name": "exp hdfs 2", "path": "/ExportJobs/tester/exp hdfs 2.exp" }, { "description": "", "id": 429, "name": "exp mysql", "path": "/ExportJobs/exp mysql.exp" } ] |
...
curl -u '<username>:<password>' -X POST 'http://<Datameer-serverIP>:<port-number>/rest/job-execution?configuration=<export-job-configuration-id>'
Example response
Code Block |
---|
{ "job-execution-id": 1, "job-execution-trigger": "RESTAPI", "job-execution-user": "admin", "status": "success" } |
...
curl -u '<username>:<password>' -X POST 'http://<Datameer-serverIP>:<port-number>/rest/job-execution/job-kill/<export-job-execution-id>'
Example response
This command doesn't return a response.
...
Anchor | ||||
---|---|---|---|---|
|
Note |
---|
The following API is available in the Advanced Governance moduleThis API requires enablingĀ Datameer's Advanced Governance plug-in. |
Request method - GET
Description
...
curl -u '<username>:<password>' -X GET 'http://<server>:<port>/api/export-job/[configurationID]/dependencies[?direction=<upstream | downstream>][&level=<number>]'
Example response
Code Block |
---|
{ "dependencies": [ { "id": 23, "file": { "path": "/Users/admin/Workbook", "name": "Workbook", "type": "wbk", "description": "", "uuid": "db942d97-4785-436d-938b-45053e12bb75" } }, { "id": 22, "file": { "path": "/Users/admin/ImportJob", "name": "ImportJob", "type": "imp", "description": "", "uuid": "b8f258f5-90c9-451d-9058-9d3a8c9b2c5d" } }, { "id": 2, "file": { "path": "/Data/Connections/Datameer server filesystem", "name": "Datameer server filesystem", "type": "dst", "description": "A data store for the local filesystem where Datameer is running. Note, this works ONLY for Datameer Personal, Workgroup, and Trial editions.\n", "uuid": "78a2fb59-375e-4eae-b338-956ef806f7b1" } } ], "fileCountWithNoReadPermission": 0, "_links": { "self": { "href": "http://localhost:8088/api/export-job/24/dependencies" } } |
...