API

Production APIs

GET production/scheduled-jobs/{jobId}

Get the scheduled production job by it's identifier

HTTP method GET
URI https://api.rambase.net/production/scheduled-jobs/{jobId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {jobId} Scheduled production job identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 5440, 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
$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.

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
<ScheduledJob>
2
     <ScheduledJobId
ScheduledJobId

Scheduled production job identifier

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

Scheduled production job status

Possible domain values can be found here

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

Scheduled production job name

>
{String}</Name>
5
     <Type>
6
          <ScheduledJobTypeId
ScheduledJobTypeId

Scheduled production job type identifier

>
{Integer}</ScheduledJobTypeId>
7
          <Name
Name

Scheduled job type name

Possible domain values can be found here

>
{String}</Name>
8
          <ScheduledJobTypeLink
ScheduledJobTypeLink

Scheduled production job type link

>
{String}</ScheduledJobTypeLink>
9
     </Type>
10
     <ScheduledAt
ScheduledAt

Data and time the job is sheduled to be executed

>
{Datetime}</ScheduledAt>
11
     <ExecutedAt
ExecutedAt

Date and time the job execution was started

>
{Datetime}</ExecutedAt>
12
     <Description
Description

Scheduled production job description

>
{String}</Description>
13
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
14
     <CreatedBy
CreatedBy

The user that created this object

>
15
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>
{String}</UserLink>
19
     </CreatedBy>
20
     <ErrorMessage>
21
          <ErrorMessageId
ErrorMessageId

Error message identifier

>
{Integer}</ErrorMessageId>
22
          <ErrorMessageLink
ErrorMessageLink

Error message reference

>
{String}</ErrorMessageLink>
23
     </ErrorMessage>
24
</ScheduledJob>
1
{
2
     "scheduledJob": {
3
          "scheduledJobId
ScheduledJobId

Scheduled production job identifier

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

Scheduled production job status

Possible domain values can be found here

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

Scheduled production job name

":
"{String}",
6
          "type": {
7
               "scheduledJobTypeId
ScheduledJobTypeId

Scheduled production job type identifier

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

Scheduled job type name

Possible domain values can be found here

":
"{String}",
9
               "scheduledJobTypeLink
ScheduledJobTypeLink

Scheduled production job type link

":
"{String}"
10
          },
11
          "scheduledAt
ScheduledAt

Data and time the job is sheduled to be executed

":
"{Datetime}",
12
          "executedAt
ExecutedAt

Date and time the job execution was started

":
"{Datetime}",
13
          "description
Description

Scheduled production job description

":
"{String}",
14
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
15
          "createdBy
CreatedBy

The user that created this object

":
{
16
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

":
"{String}"
20
          },
21
          "errorMessage": {
22
               "errorMessageId
ErrorMessageId

Error message identifier

":
"{Integer}",
23
               "errorMessageLink
ErrorMessageLink

Error message reference

":
"{String}"
24
          }
25
     }
26
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found
Error 107523 HTTP 400 Scheduled production job type not found: {0}