Listing all Automatic Imports
The ListAutoImport function returns a list of all automatic imports. If the optional account parameter is used, only automatic imports for the specified account will be returned.
GET/Remote/ListAutoImport
REQUEST PARAMETERS
Parameter | Type | Description | Required |
---|---|---|---|
mluser | string | Username - always in email form. | |
mltoken -or- mlpass | string | MapLarge generated auth token -or- the password for the mluser account. | |
account | string | Response value will only contain autoimports from the specified account. |
EXAMPLE REQUEST
https://my.maplarge.com/Remote/ListAutoImport?mluser=user@domain.com&mltoken=token
*Either a token or password can be used in any request where authentication is required.
RETURNS
{ "id": "f31800cac9764e6abac6ac587431158a", "hash": null, "success": true, "isCached": false, "authorized": true, "errors": [], "timestamp": 1420568625, "data": null, "autoimports": [ { "id": 2, "account": "test", "name": "import3741", "tablename": "Icons", "description": "", "frequency": 50, "remoteurl": "http://www.google.com", "authurl": "", "authpostdata": "", "status": "[Failure] The specified path, file name, or both are too long. The fully qualified file name must be less than 260 characters, and the directory name must be less than 248 characters.", "lastrun": "2015-01-06 13:07:09Z", "keepversions": 0 }, { "id": 4, "account": "test", "name": "import3741", "tablename": "Icons", "description": "", "frequency": 50, "remoteurl": "http://www.google.com", "authurl": "", "authpostdata": "", "status": "[Success]", "lastrun": "2015-01-06 13:07:09Z", "keepversions": 0 }, { "id": 7, "account": "test", "name": "import4506", "tablename": "Icons", "description": "", "frequency": 50, "remoteurl": "http://www.google.com", "authurl": "", "authpostdata": "", "status": "Pending", "lastrun": "2015-01-06 13:23:45Z", "keepversions": 0 } ] }
ACTION SPECIFIC RESPONSE VALUES
Parameter | Type | Description |
---|---|---|
autoimports | mixed[] | A list of all automatic imports in this account. |
autoimports[].id | long | The id of the auto import. |
autoimports[].account | string | Account that owns table created by auto import. |
autoimports[].name | alphanumeric string | The name of the automated import. |
autoimports[].tableName | alphanumeric string | Name of table imported with auto import. |
autoimports[].description | string | Description of the table. |
autoimports[].frequency | int | The frequency to run auto import for this table. Value is in minutes, and must be a minimum of 5. Import runs every x minutes based on last time auto import ran. |
autoimports[].remoteurl | string | A remote URL that includes file name and location. |
autoimports[].authurl | string | URL to send authentication requests to before downloading files from remoterurl. |
autoimports[].authpostdata | string | Data that will be sent with the authentication request. Data will be sent as a POST request. |
autoimports[].status | string | Outcome of the last run. Will include [Success] or [Failure] and any error messages |
autoimports[].lastrun | datetime | The last time the auto import ran. |
autoimports[].keepversions | int | The number of previous versions of the table to keep. Defaults to 0 if not provided and will keep 3 most recent versions. |