API

System APIs

GET system/output-object-definitions/{outputObjectDefinitionId}

Output object definition details for the provided identifier

HTTP method GET
URI https://api.rambase.net/system/output-object-definitions/{outputObjectDefinitionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {outputObjectDefinitionId} Output object definition identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 1872, version 29

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

Output object definition identifier

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

Output Object Definition status

Possible domain values can be found here

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

Name of the Output Object

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

Description of the Output Object Definition

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

If this is True you will be able to select this object definition in the customers output control menu.

>{Boolean}</IsOutputForCustomers>
7
     <IsOutputForSuppliers
IsOutputForSuppliers

If this is True you will be able to select this object definition in the customers output control menu.

>{Boolean}</IsOutputForSuppliers>
8
     <OutputFormats>
9
          <SupportsPrint
SupportsPrint

If true then you will be allowed to add print settings

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

If true then you will be allowed to add email settings

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

If true then you will be allowed to add FTP settings

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

Module of output object

>
14
          <SubModuleId
SubModuleId

Submodule identifier

>{Integer}</SubModuleId>
15
          <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
16
          <Name
Name

Name of the sub-module

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

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

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

>
18
               <ModuleId
ModuleId

Module identifier

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

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

Name of the module

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

>{String}</Name>
20
          </Module>
21
     </SubModule>
22
     <Repository
Repository

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

>
23
          <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=Repository in your request URI to get this field

>{Boolean}</IsChanged>
24
          <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=Repository in your request URI to get this field

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

Scope of the OOD (LOCAL/GLOBAL)

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

>{String}</Scope>
26
          <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=Repository in your request URI to get this field

>
27
               <UserId
UserId

User identifier

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

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

User reference

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

>{String}</UserLink>
29
          </ChangedBy>
30
     </Repository>
31
</OutputObjectDefinition>
1
{
2
     "outputObjectDefinition": {
3
          "outputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

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

Output Object Definition status

Possible domain values can be found here

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

Name of the Output Object

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

Description of the Output Object Definition

": "{String}",
7
          "isOutputForCustomers
IsOutputForCustomers

If this is True you will be able to select this object definition in the customers output control menu.

": "{Boolean}",
8
          "isOutputForSuppliers
IsOutputForSuppliers

If this is True you will be able to select this object definition in the customers output control menu.

": "{Boolean}",
9
          "outputFormats": {
10
               "supportsPrint
SupportsPrint

If true then you will be allowed to add print settings

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

If true then you will be allowed to add email settings

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

If true then you will be allowed to add FTP settings

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

Module of output object

": {
15
               "subModuleId
SubModuleId

Submodule identifier

": "{Integer}",
16
               "subModuleLink
SubModuleLink

Submodule reference

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

Name of the sub-module

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

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

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

": {
19
                    "moduleId
ModuleId

Module identifier

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

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

Name of the module

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

": "{String}"
21
               }
22
          },
23
          "repository
Repository

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

": {
24
               "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=Repository in your request URI to get this field

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

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

Scope of the OOD (LOCAL/GLOBAL)

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

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

": {
28
                    "userId
UserId

User identifier

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

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

User reference

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

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

Possible error codes the response might return:

Error 101013 HTTP 404 Sub-module not found