API

System APIs

POST system/output-designs

Creates a new output design

HTTP method POST
URI https://api.rambase.net/system/output-designs
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 1949, version 5

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
<OutputDesign>
2
     <Name
Name

Required/mandatory field

Name of the output design

>{String}</Name>
3
     <PaperSize
PaperSize

Technical description of size of paper used for printing

This field is optional.

>{String}</PaperSize>
4
</OutputDesign>
1
{
2
     "outputDesign": {
3
          "name
Name

Required/mandatory field

Name of the output design

": "{String}",
4
          "paperSize
PaperSize

Technical description of size of paper used for printing

This field is optional.

": "{String}"
5
     }
6
}

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.

Format:
1
<OutputDesign>
2
     <OutputDesignId
OutputDesignId

Output design identifier

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

Output design status

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

Name of the output design

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

Technical description of size of paper used for printing

Possible domain values can be found here

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

Description of the output design

>
7
          <IsChanged
IsChanged

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

>{Boolean}</IsChanged>
8
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>{Integer}</ChangedBy>
9
          <OverriddenStatus
OverriddenStatus

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

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

Scope of the OPD (LOCAL/GLOBAL)

>{String}</Scope>
11
     </Description>
12
</OutputDesign>
1
{
2
     "outputDesign": {
3
          "outputDesignId
OutputDesignId

Output design identifier

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

Output design status

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

Name of the output design

": "{String}",
6
          "paperSize
PaperSize

Technical description of size of paper used for printing

Possible domain values can be found here

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

Description of the output design

": {
8
               "isChanged
IsChanged

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

": "{Boolean}",
9
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": "{Integer}",
10
               "overriddenStatus
OverriddenStatus

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

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

Scope of the OPD (LOCAL/GLOBAL)

": "{String}"
12
          }
13
     }
14
}

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 102608 HTTP 404 Legacy design of type {0} is not found :: {1}
Error 101420 HTTP 404 Setting definition not found