Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

Read Import/ Link/ Upload

Request Method GET
Description

Returns information on a specified file imported/linked/uploaded within Datameer X including version number, class name, file information (uuid, path, description, name), run schedule, iterations set to keep, properties information, custom properties, and field data.

URI Syntax


No Format
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/rest/import-job/<job-configuration-id>'


Example Response


No Format
{
  "version": "2.1.1",
  "className": "datameer.dap.common.entity.DataSourceConfigurationImpl",
  "file": {
    "uuid": "2d5d3741-9f5d-42e1-9d54-e38c849f3a5a",
    "path": "/Data/ImportJobs/URLS.imp",
    "description": "",
    "name": "URLS"
  },
  "pullType": "MANUALLY",
  "minKeepCount": 1,
  "properties": {
    "GenericConfigurationImpl.temp-file-store": [
      "f4cf6037-042a-4c56-99e3-74b59753729c"
    ],
    "fileType": [
      "CSV"
    ],
    "filter.page.does.split.creation": [
      "false"
    ],
    "external.store": [
      "false"
    ],
    "delimiter": [
      ","
    ],
    "csv.max-lines-per-record": [
      "1"
    ],
    "file": [
      "/Users/charlesbishop/Desktop/URLTEST.csv"
    ],
    "detectColumnDefinition": [
      "SELECT_PARSE_AUTO"
    ],
    "quoteCharacter": [
      "\""
    ],
    "escapeCharacter": [
      ""
    ],
    "recordSampleSize": [
      "1000"
    ],
    "data.includes.header": [
      "true"
    ],
    "characterEncoding": [
      "UTF-8"
    ],
    "filter.maxAge": [
      ""
    ],
    "filter.minAge": [
      ""
    ],
    "fileNameTimeRange_startDate": [
      ""
    ],
    "fileNameTimeRange_mode": [
      "OFF"
    ],
    "collectAdditionalFields": [
      "false"
    ],
    "strictQuotes": [
      "false"
    ],
    "TextFileFormat": [
      "TEXT"
    ],
    "histogram.generation": [
      "false"
    ],
    "incrementalMode": [
      "false"
    ]
  },
  "hadoopProperties": "",
  "dataStore": {
    "path": "/Data/Connections/Datameer X server filesystem.dst",
    "uuid": "5875432e-da74-4947-8f81-7ba13347bdde"
  },
  "validationStrategy": "DROP_RECORD",
  "maxLogErrors": 1000,
  "maxPreviewRecords": 5000,
  "fields": [
    {
      "id": 31,
      "pattern": "",
      "acceptEmpty": true,
      "name": "URL",
      "origin": "0",
      "valueType": "{\"type\":\"STRING\"}",
      "include": true,
      "version": 3
    },
    {
      "id": 32,
      "pattern": "",
      "acceptEmpty": false,
      "name": "dasFileName",
      "origin": "fileInfo.fileName",
      "valueType": "{\"type\":\"STRING\"}",
      "include": false,
      "version": 3
    },
    {
      "id": 33,
      "pattern": "",
      "acceptEmpty": false,
      "name": "dasFilePath",
      "origin": "fileInfo.filePath",
      "valueType": "{\"type\":\"STRING\"}",
      "include": false,
      "version": 3
    },
    {
      "id": 34,
      "pattern": "",
      "acceptEmpty": false,
      "name": "dasLastModified",
      "origin": "fileInfo.lastModified",
      "valueType": "{\"type\":\"DATE\"}",
      "include": false,
      "version": 3
    }
  ]
} 




Section
Upload

Update Import/ Link/ Upload

Request Method PUT
Description

Edits an existing import/ link/ upload fileĀ in Datameer.

URI Syntax


No Format
curl -u '<username>:<password>' -X PUT -d @<job-payload>.json 'http://<Datameer-serverIP>:<port-number>/rest/import-job/<job-configuration-id>'


Example Response


No Format
{"status": "success"} 


Additional Notes

<job-payload>.json

  • The payload is a JSON representation of all information entered during the creation process using the web interface.
  • An easy method of creating a payload is to use REST to read an import job, data link, or workbook and change the JSON that is returned.
Verification


...