API

System APIs

GET system/jobs/output-jobs

List of output jobs

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

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.

FailedJobs() Named filter This is the failed output jobs
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedBy Integer Employee identifier. Available macros: currentUser()
CreatedForObjectId Integer Identifier of the object.
CreatedForObjectItem Integer Item-number of the object.
CreatedForObjectType String Type of object.
DateFinished Date Date the output job ended. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DateStarted Date Date the output job started. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
EmailDestination String The recepient email address.
ExternalProcessStatus Integer Status of external process.
ForwardedFromId Integer Where the output job was forwarded from.
ForwardedToId Integer Where the output job was forwarded to.
Message String Message for the output job. Typically an error message. Always specified if external process has failed.
Name String Name of system job definition.
Note String Information written to the output job during processing.
OutputJobId Integer Output job identifier.
OutputObjectDefinitionId Integer Output object definition identifier.
OutputType String Type of output.
PrintConnectorId Integer External identifier of the print connector. Based on access token.
PrinterId Integer Identifier of the printer.
PrinterName String The name of the printer used.
RamBaseServerId Integer RamBase server reference.
Severity String Severity/impact of the job.
StartedAt Datetime Date and time the output job started. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Status Integer Status of output job.
SystemJobDefinitionId Integer System job definition reference.
TimeFinished Time Time the output job ended.
TimeStarted Time Time the output job started.

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

CreatedAt Datetime Date and time of creation
CreatedBy Integer Employee identifier
CreatedForObjectId Integer Identifier of the object
CreatedForObjectItem Integer Item-number of the object
CreatedForObjectType String Type of object
DateFinished Date Date the output job ended
DateStarted Date Date the output job started
EmailDestination String The recepient email address
ExternalProcessStatus Integer Status of external process
ForwardedFromId Integer Where the output job was forwarded from
ForwardedToId Integer Where the output job was forwarded to
Message String Message for the output job. Typically an error message. Always specified if external process has failed.
Name String Name of system job definition
Note String Information written to the output job during processing
OutputJobId Integer Output job identifier
OutputObjectDefinitionId Integer Output object definition identifier
OutputType String Type of output
PrintConnectorId Integer External identifier of the print connector. Based on access token.
PrinterId Integer Identifier of the printer
PrinterName String The name of the printer used
RamBaseServerId Integer RamBase server reference
Severity String Severity/impact of the job
StartedAt Datetime Date and time the output job started
Status Integer Status of output job
SystemJobDefinitionId Integer System job definition reference
TimeFinished Time Time the output job ended
TimeStarted Time Time the output job started

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
<OutputJobs>
2
     <OutputJob>
3
          <OutputJobId
OutputJobId

Output job identifier

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

Status of output job

Possible domain values can be found here

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

Status of external process

Possible domain values can be found here

>{Integer}</ExternalProcessStatus>
6
          <OutputType
OutputType

Type of output

Possible domain values can be found here

>{String}</OutputType>
7
          <CreatedAt
CreatedAt

Date and time of creation

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

Date and time the output job started

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

Date and time the output job finished

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

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

>{String}</Message>
11
          <OutputEmail
OutputEmail

The recepient email address

>{String}</OutputEmail>
12
          <Note
Note

Information written to the output job during processing

>{String}</Note>
13
          <OutputPrinter
OutputPrinter

The name of the printer used

>
14
               <PrinterId
PrinterId

Identifier of the printer

>{Integer}</PrinterId>
15
               <Name
Name

Name of the printer

>{String}</Name>
16
          </OutputPrinter>
17
          <PrintConnector
PrintConnector

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

>
18
               <PrintConnectorId
PrintConnectorId

Print connector identifier

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

>{Integer}</PrintConnectorId>
19
               <Name
Name

Readable name of the print connector

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

>{String}</Name>
20
               <PrintConnectorLink
PrintConnectorLink

Reference to the print connector

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

>{String}</PrintConnectorLink>
21
          </PrintConnector>
22
          <OutputDesign
OutputDesign

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

>
23
               <OutputDesignId
OutputDesignId

Output design identifier

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

>{Integer}</OutputDesignId>
24
               <Name
Name

Name of the output design

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

>{String}</Name>
25
               <OutputDesignLink
OutputDesignLink

Output design reference

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

>{String}</OutputDesignLink>
26
          </OutputDesign>
27
          <OutputObjectDefinition>
28
               <OutputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

>{Integer}</OutputObjectDefinitionId>
29
               <OutputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

>{String}</OutputObjectDefinitionLink>
30
          </OutputObjectDefinition>
31
          <ForwardedFrom
ForwardedFrom

Where the output job was forwarded from

>
32
               <OutputJobId
OutputJobId

Output job identifier

>{Integer}</OutputJobId>
33
               <OutputJobLink
OutputJobLink

Output job reference

>{String}</OutputJobLink>
34
          </ForwardedFrom>
35
          <ForwardedTo
ForwardedTo

Where the output job was forwarded to

>
36
               <OutputJobId
OutputJobId

Output job identifier

>{Integer}</OutputJobId>
37
               <OutputJobLink
OutputJobLink

Output job reference

>{String}</OutputJobLink>
38
          </ForwardedTo>
39
          <SystemJobDefinition>
40
               <SystemJobDefinitionId
SystemJobDefinitionId

System job definition reference

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

Severity/impact of the job

Possible domain values can be found here

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

Name of system job definition

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

System job definition reference

>{String}</SystemJobDefinitionLink>
44
          </SystemJobDefinition>
45
          <RamBaseServer>
46
               <RamBaseServerId
RamBaseServerId

RamBase server reference

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

Description of RamBase server

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

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

RamBase server reference

>{String}</RamBaseServerLink>
49
          </RamBaseServer>
50
          <OutputFile
OutputFile

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

>
51
               <FileVersionId
FileVersionId

File identifier

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

>{Integer}</FileVersionId>
52
               <Filename
Filename

Filename to display for the file version. Will be used when downloading the file.

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

>{String}</Filename>
53
               <FileExtension
FileExtension

Extension of the file (ex. jpg)

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

>{String}</FileExtension>
54
               <Database
Database

Database of the object

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

>{String}</Database>
55
               <FileVersionLink
FileVersionLink

File reference

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

>{String}</FileVersionLink>
56
          </OutputFile>
57
          <CreatedBy>
58
               <UserId
UserId

User identifier

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

Name of the user

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

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

First name of the user

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

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

User reference

>{String}</UserLink>
62
          </CreatedBy>
63
          <CreatedFor>
64
               <Database
Database

Database of the object

>{String}</Database>
65
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
66
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
67
               <ObjectLink
ObjectLink

Identifier of the object

>{String}</ObjectLink>
68
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
69
               <ItemType
ItemType

Type of item

>{String}</ItemType>
70
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
71
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
72
          </CreatedFor>
73
          <OutputJobLink
OutputJobLink

Output job reference

>{String}</OutputJobLink>
74
     </OutputJob>
75
     <Paging
Paging

Detailed paging information for this list.

>
76
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
79
          <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>
80
          <FirstPage
FirstPage

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

>{String}</FirstPage>
81
          <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>
82
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
83
          <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>
84
          <NextPage
NextPage

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

>{String}</NextPage>
85
          <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>
86
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
88
     </Paging>
89
</OutputJobs>
1
{
2
     "outputJobs": [
3
          {
4
               "outputJobId
OutputJobId

Output job identifier

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

Status of output job

Possible domain values can be found here

": "{Integer}",
6
               "externalProcessStatus
ExternalProcessStatus

Status of external process

Possible domain values can be found here

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

Type of output

Possible domain values can be found here

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

Date and time of creation

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

Date and time the output job started

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

Date and time the output job finished

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

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

": "{String}",
12
               "outputEmail
OutputEmail

The recepient email address

": "{String}",
13
               "note
Note

Information written to the output job during processing

": "{String}",
14
               "outputPrinter
OutputPrinter

The name of the printer used

": {
15
                    "printerId
PrinterId

Identifier of the printer

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

Name of the printer

": "{String}"
17
               },
18
               "printConnector
PrintConnector

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

": {
19
                    "printConnectorId
PrintConnectorId

Print connector identifier

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

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

Readable name of the print connector

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

": "{String}",
21
                    "printConnectorLink
PrintConnectorLink

Reference to the print connector

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

": "{String}"
22
               },
23
               "outputDesign
OutputDesign

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

": {
24
                    "outputDesignId
OutputDesignId

Output design identifier

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

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

Name of the output design

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

": "{String}",
26
                    "outputDesignLink
OutputDesignLink

Output design reference

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

": "{String}"
27
               },
28
               "outputObjectDefinition": {
29
                    "outputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

": "{Integer}",
30
                    "outputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

": "{String}"
31
               },
32
               "forwardedFrom
ForwardedFrom

Where the output job was forwarded from

": {
33
                    "outputJobId
OutputJobId

Output job identifier

": "{Integer}",
34
                    "outputJobLink
OutputJobLink

Output job reference

": "{String}"
35
               },
36
               "forwardedTo
ForwardedTo

Where the output job was forwarded to

": {
37
                    "outputJobId
OutputJobId

Output job identifier

": "{Integer}",
38
                    "outputJobLink
OutputJobLink

Output job reference

": "{String}"
39
               },
40
               "systemJobDefinition": {
41
                    "systemJobDefinitionId
SystemJobDefinitionId

System job definition reference

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

Severity/impact of the job

Possible domain values can be found here

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

Name of system job definition

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

System job definition reference

": "{String}"
45
               },
46
               "ramBaseServer": {
47
                    "ramBaseServerId
RamBaseServerId

RamBase server reference

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

Description of RamBase server

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

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

RamBase server reference

": "{String}"
50
               },
51
               "outputFile
OutputFile

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

": {
52
                    "fileVersionId
FileVersionId

File identifier

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

": "{Integer}",
53
                    "filename
Filename

Filename to display for the file version. Will be used when downloading the file.

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

": "{String}",
54
                    "fileExtension
FileExtension

Extension of the file (ex. jpg)

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

": "{String}",
55
                    "database
Database

Database of the object

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

": "{String}",
56
                    "fileVersionLink
FileVersionLink

File reference

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

": "{String}"
57
               },
58
               "createdBy": {
59
                    "userId
UserId

User identifier

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

Name of the user

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

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

First name of the user

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

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

User reference

": "{String}"
63
               },
64
               "createdFor": {
65
                    "database
Database

Database of the object

": "{String}",
66
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
67
                    "objectType
ObjectType

Type of object

": "{String}",
68
                    "objectLink
ObjectLink

Identifier of the object

": "{String}",
69
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
70
                    "itemType
ItemType

Type of item

": "{String}",
71
                    "itemLink
ItemLink

API reference to the item

": "{String}",
72
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
73
               },
74
               "outputJobLink
OutputJobLink

Output job reference

": "{String}"
75
          }
76
     ],
77
     "paging
Paging

Detailed paging information for this list.

": {
78
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
81
          "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}",
82
          "firstPage
FirstPage

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

": "{String}",
83
          "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}",
84
          "previousPage
PreviousPage

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

": "{String}",
85
          "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}",
86
          "nextPage
NextPage

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

": "{String}",
87
          "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}",
88
          "lastPage
LastPage

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

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

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

": "{Integer}"
90
     }
91
}

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 103580 HTTP 404 Setting definition not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}