System APIs

GET system/output-designs/{outputDesignId}/versions/{versionId}

Get details of given version of a output design

HTTP method	GET
URI	https://api.rambase.net/system/output-designs/{outputDesignId}/versions/{versionId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {outputDesignId}	Output design identifier Integer, minimum 100000
- URI parameter {versionId}	Identifier of the version Integer, minimum 1
Successful HTTP status code	200
API resource identifier	2384, 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.

Format:

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:

                                        <OutputDesignVersion>
                                    

<OutputDesignVersionId

OutputDesignVersionId

Identifier of the version

>{Integer}</OutputDesignVersionId>

<Status

Status

Version status

>{Integer}</Status>

<DesignType

DesignType

This is the various types the output design can be

Possible domain values can be found here

>{String}</DesignType>

<Description

Description

Description of this output design version

>{String}</Description>

<HashCode

HashCode

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

>{String}</HashCode>

<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>

<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>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<CreatedBy

CreatedBy

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

<EmployeeId

EmployeeId

Employee identifier

>{Integer}</EmployeeId>

<LastName

LastName

Last name of employee

>{String}</LastName>

<EmployeeLink

EmployeeLink

Employee reference

>{String}</EmployeeLink>

                                             </CreatedBy>
                                    

                                             <LegacyDesigns>
                                    

<LayoutId

LayoutId

The identifier of the legacy layout

>{Integer}</LayoutId>

<LogoId

LogoId

The identifier of the logo used in the legacy layout

>{Integer}</LogoId>

<DateFormatId

DateFormatId

The identifier of the date formats used in the legacy layout

>{Integer}</DateFormatId>

<BarcodeId

BarcodeId

The identifier of the barcodes used in the legacy layout

>{Integer}</BarcodeId>

                                             </LegacyDesigns>
                                    

                                             <DataSource>
                                    

<DataSourceId

DataSourceId

Data source identifier

>{Integer}</DataSourceId>

<Name

Name

Name of the data source

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

>{String}</Name>

<DataSourceLink

DataSourceLink

Data source reference

>{String}</DataSourceLink>

                                             </DataSource>
                                    

                                        </OutputDesignVersion>
                                    

{

                                             "outputDesignVersion": {
                                    

"outputDesignVersionId

OutputDesignVersionId

Identifier of the version

": "{Integer}",

"status

Status

Version status

": "{Integer}",

"designType

DesignType

This is the various types the output design can be

Possible domain values can be found here

": "{String}",

"description

Description

Description of this output design version

": "{String}",

"hashCode

HashCode

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

": "{String}",

"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}",

"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}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"createdBy

CreatedBy

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

": {

"employeeId

EmployeeId

Employee identifier

": "{Integer}",

"lastName

LastName

Last name of employee

": "{String}",

"employeeLink

EmployeeLink

Employee reference

": "{String}"

},

                                                  "legacyDesigns": {
                                    

"layoutId

LayoutId

The identifier of the legacy layout

": "{Integer}",

"logoId

LogoId

The identifier of the logo used in the legacy layout

": "{Integer}",

"dateFormatId

DateFormatId

The identifier of the date formats used in the legacy layout

": "{Integer}",

"barcodeId

BarcodeId

The identifier of the barcodes used in the legacy layout

": "{Integer}"

},

                                                  "dataSource": {
                                    

"dataSourceId

DataSourceId

Data source identifier

": "{Integer}",

"name

Name

Name of the data source

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

": "{String}",

"dataSourceLink

DataSourceLink

Data source reference

": "{String}"

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

POST

Make edit version

This makes a edit version of a output design so that you are able to make changes to it.

AOP/100286

POST

Make test version

This makes a test version of a output design so that you or someone else can test it before moving it into production.

AOP/100287

POST

Make main version

This makes a main version of a output design so that all users can use it.

AOP/100288

POST

Send data source files to myself

Use this to get the example data source files sent to your own email registered in your PER

AOP/100409

POST

Copy to new design

Create a new design based on given output design

AOP/100410

POST

Send translation file (PO) to myself

Use this to get the translation file sent to your own email registered in your PER

AOP/100443

Possible error codes the response might return:

Error 102607 HTTP 404

Version of output design not found