API

System APIs

POST system/jobs/import-jobs

Creates an import job. The new job will get different object statuses depending on the import job definition and parameters sent.

HTTP method POST
URI https://api.rambase.net/system/jobs/import-jobs
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 1786, version 8

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ImportJob>
2
     <Database
Database

Database of the object

This field is optional.

>{String}</Database>
3
     <SkipEmptyCells
SkipEmptyCells

Set to True if empty cells should be skipped (parsed as NULL).

Default value: False

This field is optional.

>{Boolean}</SkipEmptyCells>
4
     <ImportJobDefinition
ImportJobDefinition

This field is optional.

>
5
          <ImportJobDefinitionId
ImportJobDefinitionId

Import job definition identifier

This field is optional.

>{Integer}</ImportJobDefinitionId>
6
     </ImportJobDefinition>
7
     <RamBaseServer>
8
          <RamBaseServerId
RamBaseServerId

Required/mandatory field

RamBase server the input file was sent from

>{Integer}</RamBaseServerId>
9
     </RamBaseServer>
10
     <ImportFile>
11
          <OriginalFilename
OriginalFilename

Original filename

This field is optional.

>{String}</OriginalFilename>
12
          <AbsoluteFilePath
AbsoluteFilePath

Required/mandatory field

The absolute/full file path of the import file on the RamBase server. The absolute path includes both directory and filename. Ex. "C:/Data/file.txt".

>{String}</AbsoluteFilePath>
13
          <FileSize
FileSize

Required/mandatory field

Size of the file

>{Integer}</FileSize>
14
          <FileLines
FileLines

Number of rows with data the file contains (excluding header)

This field is optional.

>{Integer}</FileLines>
15
     </ImportFile>
16
</ImportJob>
1
{
2
     "importJob": {
3
          "database
Database

Database of the object

This field is optional.

": "{String}",
4
          "skipEmptyCells
SkipEmptyCells

Set to True if empty cells should be skipped (parsed as NULL).

Default value: False

This field is optional.

": "{Boolean}",
5
          "importJobDefinition
ImportJobDefinition

This field is optional.

": {
6
               "importJobDefinitionId
ImportJobDefinitionId

Import job definition identifier

This field is optional.

": "{Integer}"
7
          },
8
          "ramBaseServer": {
9
               "ramBaseServerId
RamBaseServerId

Required/mandatory field

RamBase server the input file was sent from

": "{Integer}"
10
          },
11
          "importFile": {
12
               "originalFilename
OriginalFilename

Original filename

This field is optional.

": "{String}",
13
               "absoluteFilePath
AbsoluteFilePath

Required/mandatory field

The absolute/full file path of the import file on the RamBase server. The absolute path includes both directory and filename. Ex. "C:/Data/file.txt".

": "{String}",
14
               "fileSize
FileSize

Required/mandatory field

Size of the file

": "{Integer}",
15
               "fileLines
FileLines

Number of rows with data the file contains (excluding header)

This field is optional.

": "{Integer}"
16
          }
17
     }
18
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ImportJob>
2
     <ImportJobId
ImportJobId

Import job identifier

>{Integer}</ImportJobId>
3
</ImportJob>
1
{
2
     "importJob": {
3
          "importJobId
ImportJobId

Import job identifier

": "{Integer}"
4
     }
5
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found