Viewconfig JSON Schema

This page describes the JSON format of the i·views viewconfig.

View: object

View is the base class for all displayable views.

builtInActions: object

Contains all actions associated with the current view. The action is displayed, if they are visible. A Boolean value represents the response from the rights system.

update: boolean

Build in update action

read: boolean

Build in read action

select: boolean

Build in select action

delete: boolean

Build in delete action

create: boolean

Build in create action

additionalConfig: object

Add in volume configured elements to json. Look to ODIN

viewType: string , x ∈ { alternative , group , hierarchy , html , list , query , staticText , table }

Type determining the view kind

actions: object[]

Array of actions

elementType: string , x ∈ { concept , extension , instance }

Element type

searchType: string , x ∈ { concept , extension , instance }

Search type

elementLabel: string

Element label

label: string

View label

viewId: string

View configuration id

elementId: string

Element id

alternative:

An alternative represents a view with different tabs.

subView: object , x ∈ { alternative , group , hierarchy , list , staticText , table }

Attach the child object

alternatives: object[]

Array of alternatives

attribute:

Attribute

value: string

Value as string

blob:

Blob attribute

fileName: string

File name of blob attribute

binaryContainerId: string

Id of the binary container

blobLocator: string

Blob locator

mimeType: string , x ∈ { text/html , text/plain }

Mime type

fileId: string

File ID of blob value

storeId: string

Store ID of blob value

fileSize: string

File size of blob attribute

boolean:

Boolean attribute

cause-composite: object

Hit cause with hit type

cause-custom: object

Hit cause with hit type

cause-direct: object

Hit cause with hit type

cause-external: object

Hit cause with hit type

cause-folder: object

Hit cause with hit type

cause-semantic: object

Hit cause with hit type

choice:

Choice attribute

choiceValue: integer

Display string of choice

options: object

Show all options

choiceId: integer

Internal representation of choice

viewType: string , x ∈ { choice }

Type determining the view kind

collection-ref:

Collection reference attribute

color:

Color attribute

container:

Container attribute

date:

Date attribute

dateTime:

Date and time attribute

dateTime-interval:

An interval with value range for dates and times

min: dateTime

Min value of an interval

max: dateTime

Max value of an interval

extension: object

Instance or extension

extensionRelation:

Extension Relation attribute

flexTime:

Flex time attribute

day: integer

Flex time day value

minutes: integer

Flex time minutes value

year: integer

Flex time year value

hours: integer

Flex time hours value

allowsFuture: boolean

If the flex time value in the future? Default is true.

month: integer

Flex time month value

formats: object[]

Array of allowed formats

flexTime-interval:

An interval with value range for flex time values

min: flexTime

Min value of an interval

max: flexTime

Max value of an interval

float:

Float attribute

viewType: string , x ∈ { valueField }

Type determining the view kind

float-interval:

An interval with value range for floats

min: float

Min value of an interval

max: float

Max value of an interval

folder: object

Folder

folder-ref:

Folder reference attribute

geo:

Geo attribute

graph:

Description of the elements in the graph Editor

group:

A group view can contain several views displayed in a grouped view.

hierarchy:

Hierarchical structure containing nodes and leafs. It also contains a view which represents the selected node is data.

builtInActions: object

Contains all actions associated with the current view. The action is displayed, if they are visible. A Boolean value represents the response from the rights system.

select: boolean

Build in select action

create: boolean

Build in create action

read: boolean

Build in read action

update: boolean

Build in update action

delete: boolean

Build in delete action

expand: boolean

Build in expand action

moveDown: object
widhdraw: boolean

Build in widhdraw action

subView: object , x ∈ { alternative , group , hierarchy , list , staticText , table }

Attach the child object

nodes: object[]

Array of nodes

html:

A generated by a script HTML description appears.

mimeType: string , x ∈ { text/html , text/plain }

Mime type

viewType: string , x ∈ { html }

Type determining the view kind

value: string

Value as string

instance: object

Instance or extension

integer:

Integer attribute

integer-interval:

An interval with value range for integer

min: integer

Min value of an interval

max: integer

Max value of an interval

list:

List of properties

mapping-ref:

Mapping reference attribute

node: object

selectAction: object[]

Array of actions

nodes: object[]

Array of nodes

nodeId: string

Node id

searchType: string

Search type

elementType: string

Element type

label: string

View label

elementId: string

Element id

hasChildren: boolean

Node has children

parameters: object

<name>: object

Parameter name and values as object

parameterValues: object[] , x ∈ { string , locator , registeredUID }

Parameter values

parameterType: string , x ∈ { k:element , xsd:base64Binary , xsd:boolean , xsd:date , xsd:dateTime , xsd:decimal , xsd:duration , xsd:integer , xsd:language , xsd:string }

Parameter type

possibleOperators: object[] , x ∈ { containsPhrase , covers , distance , equal , equalBy , equalCardinality , equalGeo , equalMaxCardinality , equalMinCardinality , equalPresentTime , equalsTopicOneWay , fulltext , greater , greaterOrEqual , greaterOverlaps , greaterPresentTime , isCoveredBy , less , lessOrEqual , lessOverlaps , lessPresentTime , notEqual , overlaps , range , regexEqual , regexFulltext , unmodifiedEqual , words }

Possible operator of a table column

password:

Password attribute

property: object

Property

minOccurrences: integer

This attribute reflects the schema setting "minOccurs guideline" for the attribute type. Empty if there is no such restriction.

modNum: integer

Flag for version number. This is important for writing actions as this action is only performed if the backend modNum is not higher than the given one (meaning element data has already been altered).

status: string , x ∈ { deleted , new }

Status

elementType: string , x ∈ { concept , extension , instance }

Element type

maxOccurrences: integer

This attribute is only set if the schema restricts the number of attribute values.

schema: object

Schema for the current property. Only given if levelOfDetails is set to schema.

label: string

View label

searchType: string , x ∈ { concept , extension , instance }

Search type

viewId: string

View configuration id

elementId: string

Element id

query:

Integration of a query. This configuration is used to configure the query and tabular view.

table: object , x ∈ { table }

Table of a topic search

builtInActions: object

Contains all actions associated with the current view. The action is displayed, if they are visible. A Boolean value represents the response from the rights system.

update: boolean

Build in update action

read: boolean

Build in read action

select: boolean

Build in select action

delete: boolean

Build in delete action

create: boolean

Build in create action

viewType: string , x ∈ { query }

Type determining the view kind

context: object

Context object with special elements.

parameters: object

Parameter object

query-ref:

Query reference attribute

relation:

Relation

inverseLabel: string

Label of relation target

inverseElementId: string

Element id of inverse relation

viewType: string , x ∈ { relationField , subView }

Type determining the view kind

options: object

Show all options

inverse: object

Show schema from the inverse relation

schema:

Schema for the current property. Only given if levelOfDetails is set to schema.

isMainDirection: boolean

Boolean for is main direction

isShortcutRelation: boolean

Boolean for is shortcut relation

isSymmetric: boolean

Boolean for is symmetric relation

isSingleSided: boolean

Boolean for is single sided

color: color

Color value

Schema: object

Schema

typeId: string

Type id

typeName: string

Type name

rdf-id: string

RDF-Id

internalName: string

Internal Name of an type

script-ref:

Script reference attribute

staticText:

View containing static content.

mimeType: string , x ∈ { text/html , text/plain }

Mime type

string:

String attribute

string-interval:

An interval with value range for strings

min: string

Min value of an interval

max: string

Max value of an interval

table:

View containing table data.

builtInActions: object

Contains all actions associated with the current view. The action is displayed, if they are visible. A Boolean value represents the response from the rights system.

select: boolean

Build in select action

jump: boolean

Build in jump action

sort: boolean

Build in sort action

create: boolean

Build in create action

read: boolean

Build in read action

update: boolean

Build in update action

delete: boolean

Build in delete action

context: object

Table context of a table

sortIndices: object[]

An Array of numbers that describe the sort order

parameters: object

Parameter object

query: string

Name of the search that is used to determine search results.

createHits: boolean

If true create hits instead of elements. Default: false

startIndex: integer

Start value of the included elements

contents: object

Contents object of a table context

elementId: string

Element id

viewId: string

View configuration id

pageSize: integer

Page size of a table

filter: object

Filter of a table context

maxResultsExceeded: boolean

The value is true if max results exceeded

stopIndex: integer

Stop value of the included elements

withoutSorting: boolean

If true do without sorting. Default: false

configuredProtos: object[]

Configured protos of a table

totalCount: integer

Number of total found results

rows: object[]

Rows of a table

columnDescriptions: object

Column descriptions of a table

columnIndex: integer

Column id of a column

width: integer

Column width in percent

additionalConfig: object

Add in volume configured elements to json. Look to ODIN

time:

Time attribute

url:

Url attribute