API

System APIs

POST system/output-designs/{outputDesignId}/versions

Creates a new version of output design

HTTP method POST
URI https://api.rambase.net/system/output-designs/{outputDesignId}/versions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {outputDesignId} Output design identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2389, version 13

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
<OutputDesignVersion>
2
     <DesignType
DesignType

Required/mandatory field

This is the various types the output design can be

Applicable domain values can be found here

>{String}</DesignType>
3
     <Description
Description

Description of this output design version

This field is optional.

>{String}</Description>
4
     <HashCode
HashCode

This is the generated hashcode of the report file. This uniquely identifies the output design.

This field is optional.

>{String}</HashCode>
5
     <OutputType
OutputType

This defines the type of the output will be.
Examples: pdf, docx, xls, ...

More can be added if they are made available through the output designer.

Applicable domain values can be found here

This field is optional.

>{String}</OutputType>
6
     <ExternalFilePath
ExternalFilePath

ExternalFilePath is for TYPE eq FILE.
It is will be an optional field and will contain a path to an external file.
Ex: C:\NiceLabel\Return label 1\

This field is optional.

>{String}</ExternalFilePath>
7
     <LegacyDesigns
LegacyDesigns

This field is optional.

>
8
          <LayoutId
LayoutId

The identifier of the legacy layout

This field is optional.

>{Integer}</LayoutId>
9
          <LogoId
LogoId

The identifier of the logo used in the legacy layout

This field is optional.

>{Integer}</LogoId>
10
          <DateFormatId
DateFormatId

The identifier of the date formats used in the legacy layout

This field is optional.

>{Integer}</DateFormatId>
11
          <BarcodeId
BarcodeId

The identifier of the barcodes used in the legacy layout

This field is optional.

>{Integer}</BarcodeId>
12
     </LegacyDesigns>
13
     <DataSource
DataSource

This field is optional.

>
14
          <DataSourceId
DataSourceId

Data source identifier

This field is optional.

>{Integer}</DataSourceId>
15
     </DataSource>
16
</OutputDesignVersion>
1
{
2
     "outputDesignVersion": {
3
          "designType
DesignType

Required/mandatory field

This is the various types the output design can be

Applicable domain values can be found here

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

Description of this output design version

This field is optional.

": "{String}",
5
          "hashCode
HashCode

This is the generated hashcode of the report file. This uniquely identifies the output design.

This field is optional.

": "{String}",
6
          "outputType
OutputType

This defines the type of the output will be.
Examples: pdf, docx, xls, ...

More can be added if they are made available through the output designer.

Applicable domain values can be found here

This field is optional.

": "{String}",
7
          "externalFilePath
ExternalFilePath

ExternalFilePath is for TYPE eq FILE.
It is will be an optional field and will contain a path to an external file.
Ex: C:\NiceLabel\Return label 1\

This field is optional.

": "{String}",
8
          "legacyDesigns
LegacyDesigns

This field is optional.

": {
9
               "layoutId
LayoutId

The identifier of the legacy layout

This field is optional.

": "{Integer}",
10
               "logoId
LogoId

The identifier of the logo used in the legacy layout

This field is optional.

": "{Integer}",
11
               "dateFormatId
DateFormatId

The identifier of the date formats used in the legacy layout

This field is optional.

": "{Integer}",
12
               "barcodeId
BarcodeId

The identifier of the barcodes used in the legacy layout

This field is optional.

": "{Integer}"
13
          },
14
          "dataSource
DataSource

This field is optional.

": {
15
               "dataSourceId
DataSourceId

Data source identifier

This field is optional.

": "{Integer}"
16
          }
17
     }
18
}

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
<OutputDesignVersion>
2
     <OutputDesignVersionId
OutputDesignVersionId

Identifier of the version

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

Version status

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

This is the various types the output design can be

Possible domain values can be found here

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

Description of this output design version

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

This is the generated hashcode of the report file. This uniquely identifies the output design.

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

This defines the type of the output will be.
Examples: pdf, docx, xls, ...

More can be added if they are made available through the output designer.

Possible domain values can be found here

>{String}</OutputType>
8
     <ExternalFilePath
ExternalFilePath

ExternalFilePath is for TYPE eq FILE.
It is will be an optional field and will contain a path to an external file.
Ex: C:\NiceLabel\Return label 1\

>{String}</ExternalFilePath>
9
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
10
     <CreatedBy
CreatedBy

The user id of the person how created the version of the output design

>
11
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
12
          <LastName
LastName

Last name of employee

>{String}</LastName>
13
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
14
     </CreatedBy>
15
     <LegacyDesigns>
16
          <LayoutId
LayoutId

The identifier of the legacy layout

>{Integer}</LayoutId>
17
          <LogoId
LogoId

The identifier of the logo used in the legacy layout

>{Integer}</LogoId>
18
          <DateFormatId
DateFormatId

The identifier of the date formats used in the legacy layout

>{Integer}</DateFormatId>
19
          <BarcodeId
BarcodeId

The identifier of the barcodes used in the legacy layout

>{Integer}</BarcodeId>
20
     </LegacyDesigns>
21
     <DataSource>
22
          <DataSourceId
DataSourceId

Data source identifier

>{Integer}</DataSourceId>
23
          <DataSourceLink
DataSourceLink

Data source reference

>{String}</DataSourceLink>
24
     </DataSource>
25
</OutputDesignVersion>
1
{
2
     "outputDesignVersion": {
3
          "outputDesignVersionId
OutputDesignVersionId

Identifier of the version

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

Version status

": "{Integer}",
5
          "designType
DesignType

This is the various types the output design can be

Possible domain values can be found here

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

Description of this output design version

": "{String}",
7
          "hashCode
HashCode

This is the generated hashcode of the report file. This uniquely identifies the output design.

": "{String}",
8
          "outputType
OutputType

This defines the type of the output will be.
Examples: pdf, docx, xls, ...

More can be added if they are made available through the output designer.

Possible domain values can be found here

": "{String}",
9
          "externalFilePath
ExternalFilePath

ExternalFilePath is for TYPE eq FILE.
It is will be an optional field and will contain a path to an external file.
Ex: C:\NiceLabel\Return label 1\

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

Date and time of creation

": "{Datetime}",
11
          "createdBy
CreatedBy

The user id of the person how created the version of the output design

": {
12
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
13
               "lastName
LastName

Last name of employee

": "{String}",
14
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
15
          },
16
          "legacyDesigns": {
17
               "layoutId
LayoutId

The identifier of the legacy layout

": "{Integer}",
18
               "logoId
LogoId

The identifier of the logo used in the legacy layout

": "{Integer}",
19
               "dateFormatId
DateFormatId

The identifier of the date formats used in the legacy layout

": "{Integer}",
20
               "barcodeId
BarcodeId

The identifier of the barcodes used in the legacy layout

": "{Integer}"
21
          },
22
          "dataSource": {
23
               "dataSourceId
DataSourceId

Data source identifier

": "{Integer}",
24
               "dataSourceLink
DataSourceLink

Data source reference

": "{String}"
25
          }
26
     }
27
}

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