System APIs
Creates a new output object definition
| HTTP method | POST |
| URI | https://api.rambase.net/system/output-object-definitions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 1871, version 16 |
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.
Name
Required/mandatory field
Name of the Output Object
>{String}</Name>Description
Description of the Output Object Definition
This field is optional.
>{String}</Description>SubModule
Required/mandatory field
Module of output object
>SubModuleId
Required/mandatory field
Submodule identifier
Minimum value: 100000
>{Integer}</SubModuleId>Name
Required/mandatory field
Name of the Output Object
": "{String}",Description
Description of the Output Object Definition
This field is optional.
": "{String}",SubModule
Required/mandatory field
Module of output object
": {SubModuleId
Required/mandatory field
Submodule identifier
Minimum value: 100000
": "{Integer}"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.
| $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 |
| $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. |
| $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] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
OutputObjectDefinitionId
Output object definition identifier
>{Integer}</OutputObjectDefinitionId>Status
Output Object Definition status
Possible domain values can be found here
>{Integer}</Status>Name
Name of the Output Object
>{String}</Name>Description
Description of the Output Object Definition
>{String}</Description>IsOutputForCustomers
If this is True you will be able to select this object definition in the customers output control menu.
>{Boolean}</IsOutputForCustomers>IsOutputForSuppliers
If this is True you will be able to select this object definition in the customers output control menu.
>{Boolean}</IsOutputForSuppliers>SupportsPrint
If true then you will be allowed to add print settings
>{Boolean}</SupportsPrint>SupportsEmail
If true then you will be allowed to add email settings
>{Boolean}</SupportsEmail>SupportsFTP
If true then you will be allowed to add FTP settings
>{Boolean}</SupportsFTP>SubModule
Module of output object
>SubModuleId
Submodule identifier
>{Integer}</SubModuleId>SubModuleLink
Submodule reference
>ModuleId
Module identifier
>{Integer}</ModuleId>Name
Name of the module
>{String}</Name>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>OverriddenStatus
Contains the global overridden object status if object status has been changed locally.
>{Integer}</OverriddenStatus>Scope
Scope of the OOD (LOCAL/GLOBAL)
>{String}</Scope>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>OutputObjectDefinitionId
Output object definition identifier
": "{Integer}",Status
Output Object Definition status
Possible domain values can be found here
": "{Integer}",Name
Name of the Output Object
": "{String}",Description
Description of the Output Object Definition
": "{String}",IsOutputForCustomers
If this is True you will be able to select this object definition in the customers output control menu.
": "{Boolean}",IsOutputForSuppliers
If this is True you will be able to select this object definition in the customers output control menu.
": "{Boolean}",SupportsPrint
If true then you will be allowed to add print settings
": "{Boolean}",SupportsEmail
If true then you will be allowed to add email settings
": "{Boolean}",SupportsFTP
If true then you will be allowed to add FTP settings
": "{Boolean}"SubModule
Module of output object
": {SubModuleId
Submodule identifier
": "{Integer}",SubModuleLink
Submodule reference
": {ModuleId
Module identifier
": "{Integer}",Name
Name of the module
": "{String}"IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",OverriddenStatus
Contains the global overridden object status if object status has been changed locally.
": "{Integer}",Scope
Scope of the OOD (LOCAL/GLOBAL)
": "{String}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"
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 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |