API

System APIs

POST system/jobs/output-jobs/excel-export-jobs

Exports all resource data to Excel

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

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
<ExcelExportJob>
2
     <ApiUrl
ApiUrl

Required/mandatory field

Defines the RamBase API url to extract data from

>{String}</ApiUrl>
3
     <Columns
Columns

This field is optional.

>
4
          <Column
Column

This field is optional.

>
5
               <Title
Title

Sets a list of header titles for exported columns

This field is optional.

>{String}</Title>
6
               <Path
Path

Defines the resource path of the exported columns.

This field is optional.

>{String}</Path>
7
          </Column>
8
     </Columns>
9
</ExcelExportJob>
1
{
2
     "excelExportJob": {
3
          "apiUrl
ApiUrl

Required/mandatory field

Defines the RamBase API url to extract data from

": "{String}",
4
          "columns
Columns

This field is optional.

": [
5
               {
6
                    "title
Title

Sets a list of header titles for exported columns

This field is optional.

": "{String}",
7
                    "path
Path

Defines the resource path of the exported columns.

This field is optional.

": "{String}"
8
               }
9
          ]
10
     }
11
}

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
<ExcelExportJob>
2
     <ExcelExportJobId
ExcelExportJobId

Excel export identifier.

>{Integer}</ExcelExportJobId>
3
     <ApiUrl
ApiUrl

Defines the RamBase API url to extract data from

>{String}</ApiUrl>
4
     <Columns>
5
          <Column>
6
               <Title
Title

Sets a list of header titles for exported columns

>{String}</Title>
7
               <Path
Path

Defines the resource path of the exported columns.

>{String}</Path>
8
          </Column>
9
     </Columns>
10
</ExcelExportJob>
1
{
2
     "excelExportJob": {
3
          "excelExportJobId
ExcelExportJobId

Excel export identifier.

": "{Integer}",
4
          "apiUrl
ApiUrl

Defines the RamBase API url to extract data from

": "{String}",
5
          "columns": [
6
               {
7
                    "title
Title

Sets a list of header titles for exported columns

": "{String}",
8
                    "path
Path

Defines the resource path of the exported columns.

": "{String}"
9
               }
10
          ]
11
     }
12
}

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