API Reference for tool/BulkLoad

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.

as UUID. For example: 6t0ggef2c0deab00hb595101
in dot notation. E.g. ProviderName.CustomerName.LocationName

GET http://[host-proxy]/api/tool/BulkLoad/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "type": "object",
     "properties": {
          "bulkload_file": {
               "title": "Bulk Load File",
               "type": "string",
               "format": "file",
               "required": true
          },
          "bulkload_file_id": {
               "title": "Bulk Load File Id",
               "type": "string",
               "required": false
          },
          "execute_immediately": {
               "title": "Execute Immediately",
               "type": "boolean",
               "default": true
          },
          "execute_date": {
               "title": "Execution Date (YYYY-MM-DD. Local date)",
               "type": "string",
               "format": "date"
          },
          "execute_time": {
               "title": "Execution Time (HH:MM:SS. Local time)",
               "type": "string",
               "format": "time"
          },
          "execute_timezone": {
               "title": "Execution Timezone (Local Timezone)",
               "type": "string",
               "format": "uri",
               "target": "data/TimeZone",
               "target_attr": "zone_name"
          }
     }
}

Task	Call	URL	Parameters	Payload
Load the Bulk Load spreadsheet	POST	/api/tool/BulkLoad/?hierarchy=[hierarchy]&method=bulkload_spreadsheet&nowait=true	hierarchy=[hierarchy] modeltype=tool/BulkLoad	Example: {'bulkload_file': '<filename>', 'execute_immediately': true} or {'bulkload_file': '<filename>', 'execute_immediately': false, 'execute_date': '2013-06-20', 'execute_time': '12:00:00', 'execute_timezone': '0'}

Task

Call

URL

Parameters

Payload

Load the Bulk Load spreadsheet

POST

/api/tool/BulkLoad/?hierarchy=[hierarchy]&method=bulkload_spreadsheet&nowait=true

hierarchy=[hierarchy]
modeltype=tool/BulkLoad

Example:

 {'bulkload_file': '<filename>',
                     'execute_immediately': true}

 {'bulkload_file': '<filename>',
                          'execute_immediately': false,
                          'execute_date': '2013-06-20',
                          'execute_time': '12:00:00',
                          'execute_timezone': '0'}

Task	Call	URL	Parameters	Response
Get the on-line Help for tool/BulkLoad.	GET	/api/tool/BulkLoad/help/?hierarchy=[hierarchy]	hierarchy=[hierarchy]	On-line help of Model ref.: tool/BulkLoad as HTML

API Reference for tool/BulkLoad

GET http://[host-proxy]/api/tool/BulkLoad/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Load File

Help