...
| Page Properties | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Resources & Remarks Modification History
|
| Excerpt |
|---|
A description of the structure in which yuuvis® Momentum expects objects to be formatted and returns objects. |
...
Specifying Structured Data Properties
Even if the schema allows various structured data properties in an object, the instantiated object can contain a value for at most one structured data property. The value for a structured data property has to be a valid JSON structure. It is not allowed to pass a single string, boolean or other variable format:
| Code Block | ||||
|---|---|---|---|---|
| ||||
"appTable:customerdetails": {
"value": {
"id": 2982,
"uid": "711e1858-eb24-4183-8743-0292c7b9b93b"
}
} |
...
The maximum value for the total number of sub-properties within one JSON value is 500. The keys have to be strings not longer than 32 characters and have to follow the convention [a-zA-Zz][a-zA-Z0z0-9]*. The maximum depth for JSON structure is 16. Empty maps are not allowed in any position of the JSON and are replaced by null.
...
| Code Block | ||
|---|---|---|
| ||
{
"objects": [{
"properties": {
"system:objectTypeId": {
"value": "document"
},
"name": {
"value": "exampledocument-without-content"
},
"appTable:customerdetails": {
"value": {
"id": 2982,
"uid": "711e1858-eb24-4183-8743-0292c7b9b93b",
"word": "beverages",
"words": [
"tee",
"milk",
"water"],
"sentence": "The customer prefers hot chocolate.",
"sentences": [
"Unfortunately, hot chocolate is not offered.",
"The customer decides for milk instead.",
"The milk should be cool."
],
"food": {
"uid": "7aa4a2f2-3dc0-420c-a0d7-edc6af3619de",
"dish": "Bunny Chow",
"description": "Fresh Norwegian salmon, lightly brushed with our herbed Dijon mustard sauce, with choice of two sides.",
"ingredient": "Jelly",
"measurement": "1/2 teaspoon",
"lastcooked": "2018-03-13T00:00:00.000Z"
}
}
}
}
}]
}
|
| Anchor | ||||
|---|---|---|---|---|
|
Section 'contentStreams'
The section contentStreams is always present for objects with a binary content file assigned to them. It is a list with one entry containing a set of content stream properties.
>> Schema - Defining Object Types#DefiningObjectTypes-ContentStreamPropertiesContent Stream Properties
Each object with an assigned content file stored in yuuvis® Momentum has the full set of those properties in addition to the previously described properties section.
...
The properties in these sections are not defined in a schema. They are not always present and appear only in specific situations. They cannot be used in SELECT and/or WHERE clauses of search queries.
| Anchor | ||||
|---|---|---|---|---|
|
Section 'renditions'
The section renditions occurs during the import of objects with a binary content file. It contains a list of rendition specifications.
...
| Property | Description | Required in an import body where the 'renditions' section is specified | |
|---|---|---|---|
| mimeType | mimeType of the rendition. Available values: | yes | |
| kind | Kind of the rendition. Available values: | yes | |
| contentStream | Section of content stream properties describing the details of the plain text file that should be read to create the text rendition. It has to be included into the multipart request body. | yes | |
| length | Length of the file to be read for the creation of the rendition. | no | |
| mimeType | mimeType of the file to be read for the creation of the rendition. Available values: | no | |
| fileName | Name of the file to be read for the creation of the renditionrendition file. | no | |
| cid | Reference within the multipart on the file to be read for the creation of the rendition. | yes | |
...
The example objects list below is taken from an import request body in which an e-mail file is assigned as binary content file. Since the section renditions is also specified, the CONTENTANALYZER will not analyze the email file. The plain text read from the file content.txt will referenced by cid will be stored in Elasticsearch for full-text search.
...