API

System APIs

GET system/report-jobs/{reportJobId}

Report job details for provided identifier

HTTP method GET
URI https://api.rambase.net/system/report-jobs/{reportJobId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {reportJobId} Report job identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 581, version 3

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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. 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
<ReportJob>
2
     <ReportJobId
ReportJobId

Report job identifier

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

Status of report job

Possible domain values can be found here

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

Output type of the report job

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</RequestedAt>
6
     <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>
7
     <StartAt
StartAt

Date and time the report job started or will start

>{Datetime}</StartAt>
8
     <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=RequestedBy in your request URI to get this field

>
9
          <UserId
UserId

User identifier

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

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

Name of the user

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

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

First name of the user

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

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

User reference

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

>{String}</UserLink>
13
     </RequestedBy>
14
     <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=Report in your request URI to get this field

>
15
          <ReportId
ReportId

Report definition identifier

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

>{Integer}</ReportId>
16
          <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=Report in your request URI to get this field

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

Name of report definition

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

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

Description of the report definition

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

>{String}</Description>
19
          <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=Report in your request URI to get this field

>{String}</TranslatedName>
20
          <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=Report in your request URI to get this field

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

API reference to the object

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

>{String}</ReportLink>
22
     </Report>
23
     <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=OutputJob in your request URI to get this field

>
24
          <OutputJobId
OutputJobId

Output job identifier

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

>{Integer}</OutputJobId>
25
          <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=OutputJob in your request URI to get this field

>{Integer}</Status>
26
          <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=OutputJob in your request URI to get this field

>{Datetime}</StartedAt>
27
          <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=OutputJob in your request URI to get this field

>{Datetime}</FinishedAt>
28
          <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=OutputJob in your request URI to get this field

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

Output job reference

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

>{String}</OutputJobLink>
30
     </OutputJob>
31
</ReportJob>
1
{
2
     "reportJob": {
3
          "reportJobId
ReportJobId

Report job identifier

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

Status of report job

Possible domain values can be found here

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

Output type of the report job

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
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}",
8
          "startAt
StartAt

Date and time the report job started or will start

": "{Datetime}",
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=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=RequestedBy in your request URI to get this field

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

Name of the user

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

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

First name of the user

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

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

User reference

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

": "{String}"
14
          },
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=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=Report in your request URI to get this field

": "{Integer}",
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=Report in your request URI to get this field

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

Name of report definition

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

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

Description of the report definition

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

": "{String}",
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=Report in your request URI to get this field

": "{String}",
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=Report in your request URI to get this field

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

API reference to the object

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

": "{String}"
23
          },
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=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=OutputJob in your request URI to get this field

": "{Integer}",
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=OutputJob in your request URI to get this field

": "{Integer}",
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=OutputJob in your request URI to get this field

": "{Datetime}",
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=OutputJob in your request URI to get this field

": "{Datetime}",
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=OutputJob in your request URI to get this field

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

Output job reference

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

": "{String}"
31
          }
32
     }
33
}

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