GET production/serial-number-templates/{serialNumberTemplateId}/elements/{serialNumberElementId}

Get an element for a serial number template

Note: Log in to check if your API client have access to run this resource
Version: 2
Success HTTP Status Code: 200

Uri parameters

{serialNumberTemplateId} Integer Serial number template identifer
{serialNumberElementId} Integer Serialnumber Template Element identifer.

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 is 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 Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page 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
<SerialNumberElement>
2
     <SerialNumberElementId
SerialNumberElementId

Serialnumber Template Element identifer.

>
{Integer}</SerialNumberElementId>
3
     <OrderIndex
OrderIndex

Line number for the serial number template. Is used for ordering the lines when building the serial number template.

>
{Integer}</OrderIndex>
4
     <Content
Content

Dependent of the value of CONTENTTYPE.

If 'TEXT' this is a static text.
If 'DATEFORMAT' one of a set of predefined format parameters (YYYY,MM,DD etc).
If 'FIELD' one of a predefined list of fields where a value can come from e.g. Product.
If 'SEQUENCE' - not available.

>
{String}</Content>
5
     <ContentType
ContentType

Where this part of the serialno string should come from.

values:
'TEXT' - A fixed text
'DATEFORMAT' - (YY, WW, MM...) - (from current date)
'FIELD' - given field from Rambase e.g. Product.
'SEQUENCE' - a system managed counter

Possible domain values can be found here when logged in

>
{String}</ContentType>
6
     <HasSequenceDependence
HasSequenceDependence

Changes in this value will make the counter cycle back to its STARTWITH value.

>
{Boolean}</HasSequenceDependence>
7
     <Sequence>
8
          <StartValue
StartValue

The start value if CONTENTTYPE = SEQUENCE.

>
{Integer}</StartValue>
9
          <Length
Length

Only used when contenttype = 'SEQUENCE'.
If > 0 means the sequence will have a fixed length , and filled from the left using the FILLER value.

>
{Integer}</Length>
10
          <FillerCharacter
FillerCharacter

the character filled in when this is a sequence with LENGTH field > 0. (Usually '0').

>
{String}</FillerCharacter>
11
     </Sequence>
12
</SerialNumberElement>
1
{
2
     "serialNumberElement": {
3
          "serialNumberElementId
SerialNumberElementId

Serialnumber Template Element identifer.

":
"{Integer}",
4
          "orderIndex
OrderIndex

Line number for the serial number template. Is used for ordering the lines when building the serial number template.

":
"{Integer}",
5
          "content
Content

Dependent of the value of CONTENTTYPE.

If 'TEXT' this is a static text.
If 'DATEFORMAT' one of a set of predefined format parameters (YYYY,MM,DD etc).
If 'FIELD' one of a predefined list of fields where a value can come from e.g. Product.
If 'SEQUENCE' - not available.

":
"{String}",
6
          "contentType
ContentType

Where this part of the serialno string should come from.

values:
'TEXT' - A fixed text
'DATEFORMAT' - (YY, WW, MM...) - (from current date)
'FIELD' - given field from Rambase e.g. Product.
'SEQUENCE' - a system managed counter

Possible domain values can be found here when logged in

":
"{String}",
7
          "hasSequenceDependence
HasSequenceDependence

Changes in this value will make the counter cycle back to its STARTWITH value.

":
"{Boolean}",
8
          "sequence": {
9
               "startValue
StartValue

The start value if CONTENTTYPE = SEQUENCE.

":
"{Integer}",
10
               "length
Length

Only used when contenttype = 'SEQUENCE'.
If > 0 means the sequence will have a fixed length , and filled from the left using the FILLER value.

":
"{Integer}",
11
               "fillerCharacter
FillerCharacter

the character filled in when this is a sequence with LENGTH field > 0. (Usually '0').

":
"{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 104116 HTTP 404 Serialnumber template was not found.
Error 104118 HTTP 404 Serialnumber template element not found