Datatypes
The REST Datatypes transfers all data physically as UTF-8 strings, either as JSON or XML representation. The following list gives an overview on the data types which are used throughout the whole REST Service API.
STRING
Definition |
Unicode Characters |
Pattern |
|
Example |
"Hello World!", "Heute ist ein schöner Tag", "世界您好!" |
Corresponding Java Datatype |
INTEGER
Definition |
Integer Numbers (-9,223,372,036,854,775,808 to 9,223,372,036,854,775,807) |
Pattern |
[+/-] 0-9* |
Example |
4711 |
Corresponding Java Datatype |
DECIMAL
Definition |
Signed decimal number. Please see the properties of the parameter/field for details on the The string representation consists of an optional sign,'+' or '-', followed by a sequence of The fraction consists of a decimal point followed by zero or more decimal digits. |
Pattern |
[+/-] 0-9*[.0-9*] |
Example |
100.90 |
Corresponding Java Datatype |
DATE
Definition |
Calendar Date (12/30/1899 to 12/31/9999) |
Pattern |
yyyy-MM-dd |
Example |
2012-05-01 |
Corresponding Java Datatype |
TIME
Definition |
Time (00:00:00 to 24:00:00) |
Pattern |
HH:mmZ |
Example |
12:05 |
Corresponding Java Datatype |
DATETIME
Definition |
Date and Time in one value |
||||||||||
Pattern |
|
||||||||||
Example |
2012-05-01T12:00:00 2012-05-01T12:00:00-0700 2012-05-01T12:00:00:000 2012-05-01T12:00:00:000-0700 |
||||||||||
Corresponding Java Datatype |
BOOLEAN
Definition |
Boolean value - either true or false. Note: Fields which are not mandatory might also have an empty string which means no value |
Pattern |
true / false |
Example |
true, false |
Corresponding Java Datatype |
ENTITY_ITEM
Definition |
A Product Manager object which is described in the Meta API. In case entity item's are part of a result object from a service call, they will be serialized as separate object structure. In case you need to provide an entity item as a parameter, a simpler string representation is mostly enough. "object" : { "id" : "86@1064" , "label" : "A1" } If you do not need the human readable label of the entity items, you can disable the label generation by specifying includeLabels with false. See also the REST List API Read for Root Entities page. |
Pattern |
Entity Item ID Syntax: Entity Item without a container item: '<external_identifier>'|<internal_id> Entity Item with a container item: '<external_identifier>'|<internal_id>@'<container_external_identifier>'|<container_internal_id> Please note that you need to escape single quotes in case they are part of the external identifier or container external identifier with a backslash |
Example |
'SomeItem'@'SupplierCat1' 12345@5 'SomeSupplier' 42 'SomeItem\'WithASingleQuote'@'MASTER' |
Corresponding Java Datatype |
com.heiler.pim.webservice.client.EntityItemReference |
MIME_VALUE
Definition |
A reference to a mime file. In case mime values are part of a result object from a service call, they will be serialized as separate object structure. The label and mime type are optional in case you want to write a mime value. They will be extracted from the relativeFilePath if omitted. |
Pattern |
No Simple string representation, it's always rendered as JSON/XML structure |
Example |
{ "label" : "examplePicture.jpg" , "mimeType" : "image/jpg" , "relativeFilePath" : "dir1\\dir2\\dir3\\examplePicture.[sequenceToMakeFileNameUnique].jpg" } |
Corresponding Java Datatype |
com.heiler.pim.webservice.client.MIMEValueReference |
ANY
Definition |
ANY can be one specific datatype like STRING,DATETIME, DECIMAL, ENTITY_ITEM or BOOLEAN. A field with ANY as datatype must have a specific implementation to figure out which of the specific datatypes mentioned before is actually taking effect. |
Pattern |
see at the specific datatype |
Example |
see at the specific datatype |
Corresponding Java Datatype |