API

System APIs

GET system/output-object-definitions

List of output object definitions

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

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.

DefaultOutputDesignId Integer Reference to default design object.
Description String Description of the Output Object Definition.
IsOutputForCustomers Boolean If this is True you will be able to select this object definition in the customers output control menu.
IsOutputForSuppliers Boolean If this is True you will be able to select this object definition in the customers output control menu.
Name String Name of the Output Object.
OutputObjectDefinitionId Integer Output object definition identifier.
Scope String Scope of the OOD (LOCAL/GLOBAL).
Status Integer Output Object Definition status.
SubModule.
SubModuleId Integer 		Submodule identifier.
SubModuleId Integer Submodule identifier.
SupportsEmail Boolean If true then you will be allowed to add email settings.
SupportsFTP Boolean If true then you will be allowed to add FTP settings.
SupportsPrint Boolean If true then you will be allowed to add print settings.

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

DefaultOutputDesignId Integer Reference to default design object
Description String Description of the Output Object Definition
IsOutputForCustomers Boolean If this is True you will be able to select this object definition in the customers output control menu.
IsOutputForSuppliers Boolean If this is True you will be able to select this object definition in the customers output control menu.
Name String Name of the Output Object
OutputObjectDefinitionId Integer Output object definition identifier
Scope String Scope of the OOD (LOCAL/GLOBAL)
Status Integer Output Object Definition status
SubModule.
SubModuleId Integer 		Submodule identifier
SubModuleId Integer Submodule identifier
SupportsEmail Boolean If true then you will be allowed to add email settings
SupportsFTP Boolean If true then you will be allowed to add FTP settings
SupportsPrint Boolean If true then you will be allowed to add print settings

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
<OutputObjectDefinitions>
2
     <OutputObjectDefinition>
3
          <OutputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

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

Output Object Definition status

Possible domain values can be found here

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

Name of the Output Object

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

Description of the Output Object Definition

>{String}</Description>
7
          <OutputFormats
OutputFormats

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

>
8
               <SupportsPrint
SupportsPrint

If true then you will be allowed to add print settings

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

>{Boolean}</SupportsPrint>
9
               <SupportsEmail
SupportsEmail

If true then you will be allowed to add email settings

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

>{Boolean}</SupportsEmail>
10
               <SupportsFTP
SupportsFTP

If true then you will be allowed to add FTP settings

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

>{Boolean}</SupportsFTP>
11
          </OutputFormats>
12
          <SubModule
SubModule

Module of output object

>
13
               <SubModuleId
SubModuleId

Submodule identifier

>{Integer}</SubModuleId>
14
               <Name
Name

Name of the sub-module

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

>{String}</Name>
15
               <Module
Module

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

>
16
                    <Name
Name

Name of the module

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

>{String}</Name>
17
               </Module>
18
               <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
19
          </SubModule>
20
          <Repository
Repository

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

>
21
               <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

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

>{Boolean}</IsChanged>
22
               <OverriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

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

>{Integer}</OverriddenStatus>
23
               <Scope
Scope

Scope of the OOD (LOCAL/GLOBAL)

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

>{String}</Scope>
24
               <ChangedBy
ChangedBy

EmployeeId of the employee making the change

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

>
25
                    <UserId
UserId

User identifier

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

>{Integer}</UserId>
26
                    <UserLink
UserLink

User reference

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

>{String}</UserLink>
27
               </ChangedBy>
28
          </Repository>
29
          <OutputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

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

Detailed paging information for this list.

>
32
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
35
          <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>
36
          <FirstPage
FirstPage

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

>{String}</FirstPage>
37
          <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>
38
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
39
          <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>
40
          <NextPage
NextPage

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

>{String}</NextPage>
41
          <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>
42
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
44
     </Paging>
45
</OutputObjectDefinitions>
1
{
2
     "outputObjectDefinitions": [
3
          {
4
               "outputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

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

Output Object Definition status

Possible domain values can be found here

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

Name of the Output Object

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

Description of the Output Object Definition

": "{String}",
8
               "outputFormats
OutputFormats

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

": {
9
                    "supportsPrint
SupportsPrint

If true then you will be allowed to add print settings

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

": "{Boolean}",
10
                    "supportsEmail
SupportsEmail

If true then you will be allowed to add email settings

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

": "{Boolean}",
11
                    "supportsFTP
SupportsFTP

If true then you will be allowed to add FTP settings

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

": "{Boolean}"
12
               },
13
               "subModule
SubModule

Module of output object

": {
14
                    "subModuleId
SubModuleId

Submodule identifier

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

Name of the sub-module

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

": "{String}",
16
                    "module
Module

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

": {
17
                         "name
Name

Name of the module

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

": "{String}"
18
                    },
19
                    "subModuleLink
SubModuleLink

Submodule reference

": "{String}"
20
               },
21
               "repository
Repository

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

": {
22
                    "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

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

": "{Boolean}",
23
                    "overriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

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

": "{Integer}",
24
                    "scope
Scope

Scope of the OOD (LOCAL/GLOBAL)

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

": "{String}",
25
                    "changedBy
ChangedBy

EmployeeId of the employee making the change

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

": {
26
                         "userId
UserId

User identifier

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

": "{Integer}",
27
                         "userLink
UserLink

User reference

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

": "{String}"
28
                    }
29
               },
30
               "outputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

": "{String}"
31
          }
32
     ],
33
     "paging
Paging

Detailed paging information for this list.

": {
34
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
46
     }
47
}

Possible error codes the response might return:

Error 101013 HTTP 404 Sub-module not found