API

System APIs

GET system/report-jobs

List of report jobs

HTTP method GET
URI https://api.rambase.net/system/report-jobs
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 579, version 7

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
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

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

IsRecurring() Named filter Show only recurring report jobs
NotRecurring() Named filter Show report jobs that are only executed once. Typically jobs created for print or email which are not scheduled.
OutputType String Output type of the report job.
ReportId Integer Report definition identifier.
ReportJobId Integer Report job identifier.
RequestedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
RequestedBy Integer User identifier.
Status Integer Status of report job.

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

OutputType String Output type of the report job
ReportId Integer Report definition identifier
ReportJobId Integer Report job identifier
RequestedAt Datetime Date and time of creation
RequestedBy Integer User identifier
Status Integer Status of report job

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

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

Format:
1
<ReportJobs>
2
     <ReportJob>
3
          <ReportJobId
ReportJobId

Report job identifier

>{Integer}</ReportJobId>
4
          <Status
Status

Status of report job

Possible domain values can be found here

>{Integer}</Status>
5
          <OutputType
OutputType

Output type of the report job

Possible domain values can be found here

>{String}</OutputType>
6
          <RequestedAt
RequestedAt

Date and time of creation

>{Datetime}</RequestedAt>
7
          <IsRecurring
IsRecurring

Report job is recurring, e.g. at the end of each month. Is configured by scheduling the job and selecting interval of recurrence.

>{Boolean}</IsRecurring>
8
          <StartAt
StartAt

Date and time the report job started or will start

>{Datetime}</StartAt>
9
          <RequestedBy
RequestedBy

The user that requested the output of the report

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

>
10
               <UserId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

>{Integer}</UserId>
11
               <Name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

>{String}</Name>
12
               <FirstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

>{String}</FirstName>
13
               <UserLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

>{String}</UserLink>
14
          </RequestedBy>
15
          <Report
Report

Report Definition (RPD) that RPQ has been set up for

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>
16
               <ReportId
ReportId

Report definition identifier

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>{Integer}</ReportId>
17
               <Status
Status

Status of report definition

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>{Integer}</Status>
18
               <Name
Name

Name of report definition

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>{String}</Name>
19
               <Description
Description

Description of the report definition

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>{String}</Description>
20
               <TranslatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>{String}</TranslatedName>
21
               <TranslatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>{String}</TranslatedDescription>
22
               <ReportLink
ReportLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

>{String}</ReportLink>
23
          </Report>
24
          <OutputJob
OutputJob

Reference to the output job executed for the report job

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

>
25
               <OutputJobId
OutputJobId

Output job identifier

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

>{Integer}</OutputJobId>
26
               <Status
Status

Status of output job

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

>{Integer}</Status>
27
               <StartedAt
StartedAt

Date and time the output job started

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

>{Datetime}</StartedAt>
28
               <FinishedAt
FinishedAt

Date and time the output job finished

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

>{Datetime}</FinishedAt>
29
               <Message
Message

Message for the output job. Typically an error message. Always specified if external process has failed.

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

>{String}</Message>
30
               <OutputJobLink
OutputJobLink

Output job reference

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

>{String}</OutputJobLink>
31
          </OutputJob>
32
          <ReportJobLink
ReportJobLink

Report job reference

>{String}</ReportJobLink>
33
     </ReportJob>
34
     <Paging
Paging

Detailed paging information for this list.

>
35
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
36
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
37
          <Page
Page

Page index

>{Integer}</Page>
38
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
39
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
40
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
41
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
42
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
43
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
44
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
45
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
46
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
47
     </Paging>
48
</ReportJobs>
1
{
2
     "reportJobs": [
3
          {
4
               "reportJobId
ReportJobId

Report job identifier

": "{Integer}",
5
               "status
Status

Status of report job

Possible domain values can be found here

": "{Integer}",
6
               "outputType
OutputType

Output type of the report job

Possible domain values can be found here

": "{String}",
7
               "requestedAt
RequestedAt

Date and time of creation

": "{Datetime}",
8
               "isRecurring
IsRecurring

Report job is recurring, e.g. at the end of each month. Is configured by scheduling the job and selecting interval of recurrence.

": "{Boolean}",
9
               "startAt
StartAt

Date and time the report job started or will start

": "{Datetime}",
10
               "requestedBy
RequestedBy

The user that requested the output of the report

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

": {
11
                    "userId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

": "{Integer}",
12
                    "name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

": "{String}",
13
                    "firstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

": "{String}",
14
                    "userLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.RequestedBy in your request URI to get this field

": "{String}"
15
               },
16
               "report
Report

Report Definition (RPD) that RPQ has been set up for

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": {
17
                    "reportId
ReportId

Report definition identifier

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": "{Integer}",
18
                    "status
Status

Status of report definition

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": "{Integer}",
19
                    "name
Name

Name of report definition

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": "{String}",
20
                    "description
Description

Description of the report definition

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": "{String}",
21
                    "translatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": "{String}",
22
                    "translatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": "{String}",
23
                    "reportLink
ReportLink

API reference to the object

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.Report in your request URI to get this field

": "{String}"
24
               },
25
               "outputJob
OutputJob

Reference to the output job executed for the report job

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

": {
26
                    "outputJobId
OutputJobId

Output job identifier

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

": "{Integer}",
27
                    "status
Status

Status of output job

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

": "{Integer}",
28
                    "startedAt
StartedAt

Date and time the output job started

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

": "{Datetime}",
29
                    "finishedAt
FinishedAt

Date and time the output job finished

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

": "{Datetime}",
30
                    "message
Message

Message for the output job. Typically an error message. Always specified if external process has failed.

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

": "{String}",
31
                    "outputJobLink
OutputJobLink

Output job reference

This field is greyed out because it is an expandable field. You have to add $expand=ReportJob.OutputJob in your request URI to get this field

": "{String}"
32
               },
33
               "reportJobLink
ReportJobLink

Report job reference

": "{String}"
34
          }
35
     ],
36
     "paging
Paging

Detailed paging information for this list.

": {
37
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
38
          "position
Position

Position of the first element in the list

": "{Integer}",
39
          "page
Page

Page index

": "{Integer}",
40
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
41
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
42
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
43
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
44
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
45
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
46
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
47
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
48
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
49
     }
50
}

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 101013 HTTP 404 Sub-module not found
Error 100219 HTTP 404 Report definition not found