Meta-data structure

GeoCrew

Certain API calls return array of meta-data properties related to specific object. Properties can be used to build feature-rich UIs on client side, but can be also used to inspect data regardless of UI in general.


Response JSON structure for a single meta-data property:


Field

Description

id

Property identifier.

value

Property value.

title

Human-readable property name for UI. This value is optional.

text

Human-readable, formatted property value for UI. This value is optional. If this value is missing, use "Value" field contents

type

Property type (i.e. String, Double, DateTime, Boolean, etc.). This value is optional. If this value is missing, "String" type is assumed.

category

Human-readable property category for UI. This value is optional.

editable

Specifies if property is editable (expects user having Write credentials, used by this API method).

visible

Specifies whether property is visible or hidden in UI.

constraints

Specifies property value constraints (if any) for UI. This value is optional.

description

Human-readable description (help text) of property in UI. This value is optional.

view

Specifies a view in UI where property appears. This value is optional and client application-specific.

link

URL associated with property text/value in UI. This value is optional.

multiline

Specifies whether property is represented by multi-line text in UI. This value is optional. If this value is missing, False is assumed.

mandatory

Specifies whether property is mandatory if used for data input in UI. This value is optional. If this value is missing, False is assumed.


Example JSON response (i.e. for Image object):


[

  {

     "category":"Photo",

     "constraints":null,

     "editable":false,

     "id":"id",

     "text":"382be5e5-b538-4093-a825-522467ddb540",

     "title":"Identifier",

     "type":"String",

     "value":"382be5e5-b538-4093-a825-522467ddb540",

     "visible":true

     "view":0

  },{

     ...

  }

]


Data types (list of available "type" property values):


Type

Description

string

String value.

integer

Integer value.

double

Double (floating) value.

date

Date value.

time

Time value.

email

String value; e-mail address is expected.

camera

String value; device identifier is expected.

srs

String value; spatial reference system identifier is expected.

map

String value; background map identifier is expected.

user

String value; user identifier is expected.