API

System APIs

GET system/jobs/batch-jobs/{batchJobId}

Batch job details for provided identifier

HTTP method GET
URI https://api.rambase.net/system/jobs/batch-jobs/{batchJobId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {batchJobId} Batch job identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 564, 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
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
<BatchJob>
2
     <BatchJobId
BatchJobId

Batch job identifier

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

Status of batch job

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <StartedAt
StartedAt

Date and time of the batch job start

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

Enddate and endtime of the batch job

>{Datetime}</FinishedAt>
7
     <Note
Note

Information written to the batch job during processing

>{String}</Note>
8
     <SystemJobDefinition>
9
          <SystemJobDefinitionId
SystemJobDefinitionId

System job definition reference

>{Integer}</SystemJobDefinitionId>
10
          <Severity
Severity

Severity/impact of the job

Possible domain values can be found here

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

Name of system job definition

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

System job definition reference

>{String}</SystemJobDefinitionLink>
13
     </SystemJobDefinition>
14
     <RamBaseServer>
15
          <RamBaseServerId
RamBaseServerId

RamBase server reference

>{Integer}</RamBaseServerId>
16
          <Description
Description

Description of RamBase server

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

>{String}</Description>
17
          <RamBaseServerLink
RamBaseServerLink

RamBase server reference

>{String}</RamBaseServerLink>
18
     </RamBaseServer>
19
</BatchJob>
1
{
2
     "batchJob": {
3
          "batchJobId
BatchJobId

Batch job identifier

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

Status of batch job

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "startedAt
StartedAt

Date and time of the batch job start

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

Enddate and endtime of the batch job

": "{Datetime}",
8
          "note
Note

Information written to the batch job during processing

": "{String}",
9
          "systemJobDefinition": {
10
               "systemJobDefinitionId
SystemJobDefinitionId

System job definition reference

": "{Integer}",
11
               "severity
Severity

Severity/impact of the job

Possible domain values can be found here

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

Name of system job definition

": "{String}",
13
               "systemJobDefinitionLink
SystemJobDefinitionLink

System job definition reference

": "{String}"
14
          },
15
          "ramBaseServer": {
16
               "ramBaseServerId
RamBaseServerId

RamBase server reference

": "{Integer}",
17
               "description
Description

Description of RamBase server

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

": "{String}",
18
               "ramBaseServerLink
RamBaseServerLink

RamBase server reference

": "{String}"
19
          }
20
     }
21
}

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 100229 HTTP 404 Batch job not found