Swagger UIswagger

its4land Public API
 0.0.2 

[ Base URL: platform.its4land.com/api ]
/api/swagger.json

The its4land Public API provides access to the services of the its4land Publish and Share platform.

Site

Everything about Site. A site corresponds to an installation of the Publish and Share platform.

Projects

Everything about projects. A project is the central structure in Publish and Share to organize task. A project has at least a Name and a AOI. Every data processed by tools in Publish and Share are accessible via the project

GET/projects
Get a GeoJSON structure containing a list of Projects.
POST/projects
Create a new project
GET/projects/{project_uid}
Getting single Projects by its UID
DELETE/projects/{project_uid}
Deletes a single e project by its UID
PATCH/projects/{project_uid}
Update a project
GET/projects/{project_uid}/Models
Returns the models of a project
POST/projects/{project_uid}/Models
Create a new model
DELETE/projects/{project_uid}/Models/{model_uid}
Removes a model from a project.
GET/projects/{project_uid}/SpatialSources
Returns the SpatialSources of a Project.
POST/projects/{project_uid}/SpatialSources
Create a new SpatialSource
DELETE/projects/{project_uid}/SpatialSources/{spatialsource_uid}
Removes a spatialsource from a project.
GET/projects/{project_uid}/connectedObjects
Returns an array of connect objects
GET/projects/{project_uid}/Tags
Returns the tags of a project.
POST/projects/{project_uid}/Tags
Adds a tag to the project
DELETE/projects/{project_uid}/Tags/{tag}
Removes a tag from a project.

Models

Everything about models. A model stores all data related to any kind of classification process based on any kind of TrainingSets. A Model is related to one or Project.

GET/models
Returns a list of models.
POST/models
Create a new model
GET/models/{model_uid}
Returns a single model
PATCH/models/{model_uid}
Updates some attributes of a model
GET/models/{model_uid}/modelclasses
Returns the model classes of the classifier.
POST/models/{model_uid}/modelclasses
Create a new ModelClass under a model

TrainingSets

Everything about TrainingSets. A TrainingSet is part of Model and the base for a classifier

GET/trainingsets
Returns a list of TrainingSets
POST/trainingsets
Create a new TrainingSet
GET/trainingsets/{trainingsets_uid}
Returns a single TrainingSet

SpatialSources

Everything about SpatialSources. A SpatialSource documents the evidence for as SpatialUnit. A SpatialSource can be a SketchMap, Orthoimages, etc. An SpatialSource may have several manifestations at the same time. See LADM for more details.

GET/spatialsources
Returns a list of SpatialSources
POST/spatialsources
Create a new SpatialSource
GET/spatialsource/{spatialsource_uid}
Returns a single SpatialSource
PUT/spatialsource/{spatialsource_uid}
Replace an existing SpatialSource by a newer version
GET/spatialsource/{spatialsource_uid}/AdditionalDocument
Returns the additional documents of a spatial source
POST/spatialsource/{spatialsource_uid}/AdditionalDocument
Add a new additional document to a spatial source
GET/spatialsource/{spatialsource_uid}/AdditionalDocument/{adddoc_uid}
Returns the additional documents of a spatial source
DELETE/spatialsource/{spatialsource_uid}/AdditionalDocument/{adddoc_uid}
Removes an additional document for a spatial source.

AdminSources

Everything about AdminSources. A AdminSource documents the evidence for a interrest in land. This could be a right like ownership or a restriction like right of way. The AdminSource document itself is not the registration, it provides an evidence for a later registration in a LAS. The AdminSource Document is related to a SpatialUnit. See LADM for more details.

GET/adminsources
Returns a list of AdminSource document indizes
POST/adminsources
Creates a new AdminSource
GET/adminsources/{adminsource_uid}
Returns a single Admin Source
PATCH/adminsources/{adminsource_uid}
Update an Admin Source

SpatialUnits

Everything about SpatialUnits. Details defined by the Concept. See LADM for more details.

GET/spatialunits
Returns a list of SpatialUnits in a GeoJSON structure.
POST/spatialunits
Create a new SpatialUnit
POST/spatialunits/create2Dpolygonspatialunit
Creates a spatial unit
GET/spatialunits/qualitative
Returns a list of SpatialUnits
POST/spatialunits/qualitative
Create a new SpatialUnit
GET/spatialunits/{spatialunit_uid}
Returns a list of SpatialUnits
PATCH/spatialunits/{spatialunit_uid}
Update an spatial unit
GET/spatialunits/qualitative/{spatialunit_uid}
Returns a single spatial unit
PATCH/spatialunits/qualitative/{spatialunit_uid}
Updates a new SpatialUnit
GET/spatialunits/concepts
Returns a list of spatial units concepts
POST/spatialunits/concepts
Create a new concept for a spatial unit
GET/spatialunits/concepts/{concept_uid}
Returns a single spatial unit concept
PATCH/spatialunits/concepts/{concept_uid}
Updates a new spatial unit concept

BoundaryFaceString

Everything about BoundaryFaceString. See LADM for more details.

GET/boundaryfacestring
Returns a list of boundary face strings in a GeoJSON structure.
POST/boundaryfacestring
Create a new concept for a boundary face string
GET/boundaryfacestring/{boundaryfacestring_uid}
Returns a single boundary face string
PUT/boundaryfacestring/{boundaryfacestring_uid}
Replace an existing BoundaryFaceString by a newer version
PATCH/boundaryfacestring/{boundaryfacestring_uid}
Updates a boundary face string

Classifier

Everything about Classifier. A Classifier is part of a Model. The Classifier itself is defined by the Application.

GET/classifier
Returns a list of classifier
POST/classifier
Create a new classifier
GET/classifier/{classifier_id}
Returns a single classifier.

ModelClasses

Everything about ModelClasses. Assigned to Models. Describe the different class that can be detected by the Classifier of the Model.

GET/modelclasses
Returns ModelClasses
GET/modelclasses/{modelclasses_uid}
Returns a single model class
PATCH/modelclasses/{modelclasses_uid}
Updates some attributes of a ModelClass

ContentItems

Everything about ContentItems. Any form of digital content, like files, images or other binary and non-binary structures.

GET/contentitems
Returns a list of contentitems
POST/contentitems
Create a new content in the object storage
GET/contentitems/{contentitem_id}
Returns a single content from the object storage.

MetricMapFeatures

Everything about MetricMapFeatures. Handel of Point-, Line- and Polygon-TopographicFeature.

GET/metricmapfeature
Returns MetricMapFeature
POST/metricmapfeature
Create a new metricMapFeature
PATCH/metricmapfeature/{mmf_uid}
Updates a metric map feature

Images

Everything about Images. Orthoimages that should be published on Publish and Share

Tags

Everything about Tags. Nearly every resource accessible via this API can be tagged. Endpoint for handle Tags.

GET/tags
Get a list of tags
GET/tags/{tag_name}
Returns a single tag
PATCH/tags/{tag_name}
Updates a tag
PATCH/tags/{tag_uid}/merge
Merge tags

WP5ValidationSets

Everything about WP5ValidationSets. WP5 requires a different kind of classification. This Endpoint is only used by WP5

GET/WP5ValidationSets
Returns a list of WP5ValidationSets
POST/WP5ValidationSets
Create a new WP5ValidationSets
GET/WP5ValidationSets/{wp5validationset_uid}
Returns a single WP5ValidationSet

Tools

Everything about tools

GET/tools
Get a list of tools

Processes

Everything about processes

GET/processes
Get a list of processes
POST/processes
Creates a new processes
GET/processes/{process_uid}
Returns metadata for a single process
GET/processes/{process_uid}/log
Get the full log of a process
POST/processes/{process_uid}/log
Writes a single log entry

Misc

General endpoints

GET/DDILayers
Return a list of registered DDI (WFS/WMS) Layer
POST/DDILayers
Register a new DDI (WFS/WMS) Layer
GET/PuSConfig
Returns a list of configuration parameters as Key Value

Models

SiteEndpointType{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

}
#/definitions/ProjectsEndpointTypeProjectsEndpointType{
typestring

GeoJson feature collection

Enum:
Array [ 1 ]
namestring

Name of the feature collection. Always i4lProject

Enum:
Array [ 1 ]
crs#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features[#/definitions/ProjectsEndpointType_featuresProjectsEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_propertiesProjectsEndpointType_properties{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ProjectDirstring

URI to a directory resource. Not clear if needed.

Models[

Array of models (UID).

#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
]
SpatialSources[

Array of SpatialSources (UID).

#/definitions/ProjectsEndpointType_properties_SpatialSourcesProjectsEndpointType_properties_SpatialSources{
UIDstring

UUID of the SpatialSources.

}
]
Tags[

Array of tags (strings).

string]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
]
}
#/definitions/ProjectsPostRequestProjectsPostRequest{
type*string

GeoJson feature collection

Enum:
Array [ 1 ]
name*string

Name of the feature collection. Always i4lProject

Enum:
Array [ 1 ]
crs*#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features*[#/definitions/ProjectsPostRequest_featuresProjectsPostRequest_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/ProjectsPostRequest_propertiesProjectsPostRequest_properties{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ProjectDirstring

URI to a directory resource. Not clear if needed.

Models[

Array of models (UID).

#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
]
SpatialSources[

Array of SpatialSources (UID).

#/definitions/ProjectsPostRequest_properties_SpatialSourcesProjectsPostRequest_properties_SpatialSources{
UIDstring

UUID of SpatialSources

}
]
Tags[

Array of tags (strings).

string]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
]
}
ProjectsPatchRequest{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

ProjectDirstring

URI to a directory resource. Not clear if needed.

Models[

Array of models (UID).

#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
]
SpatialSources[

Array of SpatialSources (UID).

#/definitions/ProjectsPostRequest_properties_SpatialSourcesProjectsPostRequest_properties_SpatialSources{
UIDstring

UUID of SpatialSources

}
]
AOI[

Polygon. The polygon is encoded a comma separated list of coordinates. X1, Y1, X2, Y2, …, Xn, Yn, X1, Y1. Patch requires a complete polygon.

string]
Tags[

Array of tags (strings) of the associated models. Patch requires an updated array.

string]
}
ProjectsEndpointType2{
typestring

GeoJson feature collection

Enum:
Array [ 1 ]
namestring

Name of the feature collection. Always i4lProject

Enum:
Array [ 1 ]
crs#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features[#/definitions/ProjectsEndpointType2_featuresProjectsEndpointType2_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType2_propertiesProjectsEndpointType2_properties{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ConnectedObjectsConnectedObjectsEndpointType[#/definitions/ConnectedObjectsEndpointType_innerConnectedObjectsEndpointType_inner{
projectUIDstring

UUID of the project

TypeOfConnectedObjectstring

Type of the connected object from item2item

NameOfConnectedObjectstring

Name of the object, taken from the object table

UUIDofConnectObjectstring

UUID of the connected object

}
]
Tags[

Array of tags (strings).

string]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
]
}
#/definitions/ModelsEndpointTypeModelsEndpointType{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

TrainingSetstring

UID of the TrainingSet.

Classifierstring

UID of the assigned classifier

Tools[

Comma separated list tool names which can make use of the model.

string]
ModelClasses[

Array of ModelClasses (UID).

#/definitions/ModelsEndpointType_ModelClassesModelsEndpointType_ModelClasses{
UIDstring

UUID od associated model classes

}
]
NumModelClassesinteger($init32)

Number of ModelClasses in the Model

Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/ModelsPostRequestModelsPostRequest{
Name*string

Freely chosen name

Description*string

Free text for description. Only plain text.

TrainingSetstring

TrainingSet of the model (UID)

Classifierstring

Classifier UID

Tools[

Comma separated list tool names which can make use of the model.

string]
ModelClasses[

Array of ModelClasses (UID).

#/definitions/ModelsEndpointType_ModelClassesModelsEndpointType_ModelClasses{
UIDstring

UUID od associated model classes

}
]
Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
ModelsPatchRequest{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

TrainingSetstring

TrainingSet of the model (UID)

Classifierstring

UID of the assigned classifier

Tools[

Comma separated list tool names which can make use of the model.

string]
ModelClasses[

Array of ModelClasses (UID).

#/definitions/ModelsEndpointType_ModelClassesModelsEndpointType_ModelClasses{
UIDstring

UUID od associated model classes

}
]
Tags[

Array of tags (strings). Patch requires an updated array.

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/ModelClassesEndpointTypeModelClassesEndpointType{
UIDstring

UUID

ConceptNamestring

Freely chosen name of the concept represented by the class

NameInModelstring

Freely chosen name of the concept represented by the class

ConceptImagestring

UID of an image that illustrates the concept. The image must be stored in advanced via the ContentItem endpoint.

Model#/definitions/ModelClassesEndpointType_ModelModelClassesEndpointType_Model{
description:

Array of Projects (UID).

UIDstring

UUID of associated models.

}
}
#/definitions/ModelClassesPostRequestModelClassesPostRequest{
ConceptNamestring

Freely chosen name of the concept represented by the class

NameInModelstring

Freely chosen name of the concept represented by the class

ConceptImagestring

UID of an image that illustrates the concept. The image must be stored in advanced via the ContentItem endpoint.

}
#/definitions/SpatialSourcesEndpointTypeSpatialSourcesEndpointType{
description:

Data model of the /spatialsources endpoint

UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

Typestring

Spatial Source type.

ContentItemstring

UID of the ContentItem

AdditionalDocuments[

Array of additional SpatialSource Documents. Mainly uses in WP3 tp store the different representation of a SketchMap.

#/definitions/SpatialSourcesEndpointType_AdditionalDocumentsSpatialSourcesEndpointType_AdditionalDocuments{
UIDstring

UUID of the additional document.

}
]
Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/SpatialSourcesPostRequestSpatialSourcesPostRequest{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

Typestring

Spatial Source type.

ContentItemstring

UID of the ContentItem

Tags[

Array of tags (strings).

string]
}
#/definitions/AdminSourcesEndpointTypeAdminSourcesEndpointType{
description:

Data model of the /adminsources endpoint

UIDstring

UUID of AdminSource

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Typestring

Admin Source type.

ContentItemstring

UID of the ContentItem

Conceptstring

Zeigt auf ein Konzept (UID) in einer auf LADM aufbauenden Ontologie. Was ist der Unterscheid zu Type? Besserer Name, daa ansosnsten Verwechselung mit Concept aus Models

SpatialUnits[

Array of Spatial Units. The Admin Source document provides the legal evidenace for the registartion of the Spatial Unit in the LAS.

#/definitions/AdminSourcesEndpointType_SpatialUnitsAdminSourcesEndpointType_SpatialUnits{
UIDstring

UUID of the spatial unit.

}
]
Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/AdminSourcesPostRequestAdminSourcesPostRequest{
description:

Post Request of he /adminsources endpoint

Name*string

Freely chosen name

Description*string

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Typestring

Admin Source type.

ContentItem*string

UID of the ContentItem

Conceptstring

Zeigt auf ein Konzept (UID) in einer auf LADM aufbauenden Ontologie. Was ist der Unterscheid zu Type? Besserer Name, daa ansosnsten Verwechselung mit Concept aus Models

SpatialUnits[

Array of Spatial Units. The Admin Source document provides the legal evidenace for the registartion of the Spatial Unit in the LAS.

#/definitions/AdminSourcesEndpointType_SpatialUnitsAdminSourcesEndpointType_SpatialUnits{
UIDstring

UUID of the spatial unit.

}
]
Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/AdditionalDocumentsEndpointTypeAdditionalDocumentsEndpointType{
UIDstring

UUID

Typestring

Type of the additional document.

Descriptionstring

Free text for description. Only plain text.

ContentItemstring

UID of the ContentItem

}
#/definitions/AdditionalDocumentsPostAdditionalDocumentsPost{
Typestring

Type of the additional document.

Descriptionstring

Free text for description. Only plain text.

ContentItemstring

UID of the ContentItem

}
#/definitions/SpatialUnitsFeatureEndpointTypeSpatialUnitsFeatureEndpointType{
type*string

GeoJson feature collection

Enum:
Array [ 1 ]
name*string

Name of the feature collection. Always SpatialUnitFeatures

Enum:
Array [ 1 ]
crs*#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features*[#/definitions/SpatialUnitsFeatureEndpointType_featuresSpatialUnitsFeatureEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/SpatialUnitsFeatureEndpointType_propertiesSpatialUnitsFeatureEndpointType_properties{
UIDstring

UUID

Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Conceptstring

According to the ontology based on LADM

Levelstring

Level according to LADM

AdminSource[

Related Admin Source Documents

#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
]
}
#/definitions/SpatialUnitsFeaturePostRequestSpatialUnitsFeaturePostRequest{
type*string

GeoJson feature collection

Enum:
Array [ 1 ]
name*string

Name of the feature collection. Always SpatialUnitFeatures

Enum:
Array [ 1 ]
crs*#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features*[#/definitions/SpatialUnitsFeaturePostRequest_featuresSpatialUnitsFeaturePostRequest_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/SpatialUnitsFeaturePostRequest_propertiesSpatialUnitsFeaturePostRequest_properties{
Name*string

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Concept*string

According to the ontology based on LADM

Levelstring

Level according to LADM

AdminSource[

Related Admin Source Documents

#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
]
}
#/definitions/SpatialUnitBaseFeaturePostRequestSpatialUnitBaseFeaturePostRequest{
description:

Post Request of he /adminsources endpoint

Name*string

Freely chosen name

Description*string

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Levelstring

Level according to LADM

Conceptstring

According to the ontology based on LADM

AdminSource[

Related Admin Source Documents

#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
]
BoundaryFaceStringstring

UUID to a boundary face string

Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
#/definitions/SpatialUnitConceptEndpointTypeSpatialUnitConceptEndpointType{
description:

Spatial unit concept

UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

contentitemstring

UID of the ContentItem

}
#/definitions/SpatialUnitConceptPostRequestSpatialUnitConceptPostRequest{
description:

Post Request of spatial unit concept

Name*string

Freely chosen name

Description*string

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

contentitemstring

UID of the ContentItem

}
#/definitions/BoundaryFaceStringEndpointTypeBoundaryFaceStringEndpointType{
type*string

GeoJson feature collection

Enum:
Array [ 1 ]
name*string

Name of the feature collection. Always BoundaryFaceString

Enum:
Array [ 1 ]
crs*#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features*[#/definitions/BoundaryFaceStringEndpointType_featuresBoundaryFaceStringEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/BoundaryFaceStringEndpointType_propertiesBoundaryFaceStringEndpointType_properties{
UIDstring

UUID

Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

SpatialUnit[

Related SpatialUnit

#/definitions/BoundaryFaceStringEndpointType_properties_SpatialUnitBoundaryFaceStringEndpointType_properties_SpatialUnit{
UIDstring

UID of an spatial unit feature

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/BoundaryFaceStringEndpointType_geometryBoundaryFaceStringEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
}
]
}
#/definitions/BoundaryFaceStringPostRequestBoundaryFaceStringPostRequest{
type*string

GeoJson feature collection

Enum:
Array [ 1 ]
name*string

Name of the feature collection. Always BoundaryFaceString

Enum:
Array [ 1 ]
crs*#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features*[#/definitions/BoundaryFaceStringPostRequest_featuresBoundaryFaceStringPostRequest_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/BoundaryFaceStringPostRequest_propertiesBoundaryFaceStringPostRequest_properties{
Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

SpatialUnit[

Related SpatialUnit

#/definitions/BoundaryFaceStringEndpointType_properties_SpatialUnitBoundaryFaceStringEndpointType_properties_SpatialUnit{
UIDstring

UID of an spatial unit feature

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/BoundaryFaceStringEndpointType_geometryBoundaryFaceStringEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
}
]
}
#/definitions/TrainingsSetEndpointTypeTrainingsSetEndpointType{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

TrainingSetTypestring

TrainingSet type.

TrainingSetStatusinteger($init32)

0 = untrained 1 = trained

Tools[

Comma separated list tool names which can make use of the training set.

string]
ContentItemstring

UID of the ContentItem

Tags[

Array of tags (strings).

string]
Models[

Array of Projects (UID).

#/definitions/TrainingsSetEndpointType_ModelsTrainingsSetEndpointType_Models{
UIDstring

UUID of associated models.

}
]
}
#/definitions/TrainingSetsPostRequestTrainingSetsPostRequest{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

TrainingSetTypestring

TrainingSet type.

TrainingSetStatusinteger($init32)

0 = untrained 1 = trained

Tools[

Comma separated list tool names which can make use of the training set.

string]
ContentItemstring

UID of the ContentItem

Tags[

Array of tags (strings).

string]
Models[

Array of Projects (UID).

#/definitions/TrainingsSetEndpointType_ModelsTrainingsSetEndpointType_Models{
UIDstring

UUID of associated models.

}
]
}
#/definitions/ClassifierEndpointTypeClassifierEndpointType{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

ClassifierTypestring

Classifier type.

Tools[

Comma separated list tool names which can make use of the classifier.

string]
ContentItemstring

UID of the ContentItem

Tags[

Array of tags (strings).

string]
Models[

Array of Projects (UID).

#/definitions/TrainingsSetEndpointType_ModelsTrainingsSetEndpointType_Models{
UIDstring

UUID of associated models.

}
]
}
#/definitions/ClassifierPostRequestClassifierPostRequest{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

ClassifierTypestring

Classifier type.

Tools[

Comma separated list tool names which can make use of the classifier.

string]
ContentItemstring

UID of the ContentItem

Tags[

Array of tags (strings).

string]
Models[

Array of Projects (UID).

#/definitions/TrainingsSetEndpointType_ModelsTrainingsSetEndpointType_Models{
UIDstring

UUID of associated models.

}
]
}
#/definitions/ContentItemEndpointTypeContentItemEndpointType{
ContentIDstring

UID of the ContentItem

ContentTypestring

mime/type of the content

ContentNamestring

Name of the contentitem. Typically the file name

ContentSizeinteger

Size of the file in bytes

ContentDescriptionstring

Free text for description. Only plain text.

}
#/definitions/MetricMapFeaturesEndpointTypeMetricMapFeaturesEndpointType{
type*string

GeoJson feature collection

Enum:
Array [ 1 ]
name*string

Name of the feature collection. Always i4lMetricMapFeature

Enum:
Array [ 1 ]
crs*#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
features*[#/definitions/MetricMapFeaturesEndpointType_featuresMetricMapFeaturesEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/MetricMapFeaturesEndpointType_propertiesMetricMapFeaturesEndpointType_properties{
UIDstring

UUID

fgroupstring

Name of the feature group

ftypestring

Name of the feature type

fsubtypestring

Name of the feature subtype

fnamestring

Freely chosen name

fURIstring

URI to the feature definition

}
geometry#/definitions/MetricMapFeaturesEndpointType_geometryMetricMapFeaturesEndpointType_geometry{
typestringEnum:
Array [ 3 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
}
]
}
#/definitions/MetricMapFeaturePostRequestMetricMapFeaturePostRequest{
type*stringEnum:
Array [ 1 ]
properties*#/definitions/MetricMapFeaturePostRequest_propertiesMetricMapFeaturePostRequest_properties{
fgroup*string

Name of the feature group

ftypestring

Name of the feature type

fsubtypestring

Name of the feature subtype

fname*string

Freely chosen name

fURIstring

URI to the feature definition

}
geometry*#/definitions/MetricMapFeaturesEndpointType_geometryMetricMapFeaturesEndpointType_geometry{
typestringEnum:
Array [ 3 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
}
#/definitions/WP5ValidationSetsEndpointTypeWP5ValidationSetsEndpointType{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

Statusinteger($init32)

Status of the validation set.

ContentItemstring

UID of the ContentItem

Tags[

Array of tags (strings).

string]
Models[

Array of Projects (UID).

#/definitions/TrainingsSetEndpointType_ModelsTrainingsSetEndpointType_Models{
UIDstring

UUID of associated models.

}
]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/WP5ValidationSetsPostRequestWP5ValidationSetsPostRequest{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

Statusinteger($init32)

Status of the validation set.

ContentItemstring

UID of the ContentItem

Tags[

Array of tags (strings).

string]
Models[

Array of Projects (UID).

#/definitions/TrainingsSetEndpointType_ModelsTrainingsSetEndpointType_Models{
UIDstring

UUID of associated models.

}
]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
ImageSetsEndpointType{
UIDstring

UUID

Namestring

Name of the image. Filename ?

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Metadata[

Metadata for the image set. Like, flight date, etc.

#/definitions/ImageSetsEndpointType_MetadataImageSetsEndpointType_Metadata{
MetaDataKeystring

Name of the metadata key

MetaDataValuestring

Value of the metadata

}
]
ContentItems[

Metadata for the image set. Like, flight date, etc.

#/definitions/ImageSetsEndpointType_ContentItemsImageSetsEndpointType_ContentItems{
ContentUIDstring

UUID of a ContentItem

Descriptionstring

Description related to the image set

}
]
Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/DDILayersEndpointTypeDDILayersEndpointType{
UIDstring

Publish and Share UID (UUID) of the layer

Namestring

Layer name. Must be unique

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Servicestring

Service type of the layer. WFS or WMS

EMNamestring

When the Em repository is uesed, this paramter contains the name of the layer in the EM repository

ContentItems[

List of Images (ContenItems. Used for the DDI Service.

string

UUID of a ContentItem

]
Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/DDILayersPostRequestDDILayersPostRequest{
Name*string

Layer name. Must be unique

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Service*string

Service type of the layer. WFS or WMS

EMNamestring

When the Em repository is uesed, this paramter contains the name of the layer in the EM repository

ContentItems[

List of Images (ContenItems. Used for the DDI Service.

string

UUID of a ContentItem

]
Tags[

Array of tags (strings).

string]
Projects[

Array of Projects (UID).

#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
]
}
#/definitions/TagsEndpointTypeTagsEndpointType{
UIDstring

UUID

TagValuestring

Display value of the tag

TaggedObjects[

List of tagged objects: Type, UUID, Name, Description

#/definitions/TagsEndpointType_TaggedObjectsTagsEndpointType_TaggedObjects{
ObjectTypestring

Project, Model, TrainingSet, etc.

ObjectUUIDstring

UUID of the object

Namestring

Name of the object

Descriptionstring

Description of the object.

}
]
TaggedObjectsSum[#/definitions/TagsEndpointType_TaggedObjectsSumTagsEndpointType_TaggedObjectsSum{
ObjectTypestring

Project, Model, TrainingSet, etc.

Countinteger

Number of object

}
]
}
TagsPostRequest[string]
TagsListResponse[

Array of tags (strings).

string]
ConnectedObjectsEndpointType[#/definitions/ConnectedObjectsEndpointType_innerConnectedObjectsEndpointType_inner{...}]
RFC6902PatchRequest[{...}]
#/definitions/ToolsEndpointTypeToolsEndpointType{
UIDstring

UID of the tool

Namestring

Name of the tool. Should be WP name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Free text for long description.

ExtDescriptionURLstring

URL to an external content. The content is added as static html in the the standard web client.

Supplierstring

Free text for description. Only plain text.

Versionstring

Tool version.

ToolURLstring

Link to external documentation

Image#/definitions/ToolsEndpointType_ImageToolsEndpointType_Image{
description:

Details about the image

UIDstring

UID of the image

ReleaseDatestring($date)

Release Data of of the tool image

Imagestring

Image of the tool

}
EntryPoints[#/definitions/ToolsEndpointType_EntryPointsToolsEndpointType_EntryPoints{
Namestring

Name of the EntryPoint or sub tool

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Free text for long description. Only plain text.

EntryPointstring

How to start the sub tool

}
]
}
#/definitions/ProcessEndpointTypeProcessEndpointType{
UIDstring

UID of the process

Project#/definitions/ProcessEndpointType_ProjectProcessEndpointType_Project{
description:

A process always belongs to a project

UIDstring

UID of the project

Namestring

Name of the project

Descriptionstring

Free text for description. Only plain text.

}
Statusstring

Status of the project. Can be one of:

  • WAITING: Process is queued for execution
  • RUNNING: Process is currently executing
  • FINISHED: Process terminated normally
  • ABORTED: Process terminated unexpectedly
  • ZOMBIE: Process is listed in the platform process table, but the internal (process) API has no information about it. Possible in case of historical/archived processes or due to platform error.
Enum:
Array [ 5 ]
CreatedAtstring($date)

Creation date

CreatedBystring

User name of the creator

LastModifiedAtstring($date)

Last modification date

LastModifiedBystring

User name of the last modifier

Tool#/definitions/ProcessEndpointType_ToolProcessEndpointType_Tool{
description:

Information about the tool executed by the process

ToolNamestring

Name of the tool

Versionstring

Version of the tool

EntryPoint#/definitions/ProcessEndpointType_Tool_EntryPointProcessEndpointType_Tool_EntryPoint{
description:

Entry point used in the process

EntryPointNamestring

Name of the entry point

Parameter[

Parameters used in the process

#/definitions/ProcessEndpointType_Tool_EntryPoint_ParameterProcessEndpointType_Tool_EntryPoint_Parameter{
ParameterNamestring

Name of the parameter

ParameterValuestring

Value of the parameter

}
]
}
}
Logsstring

Logs from the process

Results[

Results from the process

#/definitions/ProcessEndpointType_ResultsProcessEndpointType_Results{
ResultTypestring

Spatial Unit/Orthomosaic/Boundary Face String/MetricMapFeature

ResultUIDstring

UUID

}
]
}
#/definitions/ProcessPostRequestProcessPostRequest{
Project*#/definitions/ProcessPostRequest_ProjectProcessPostRequest_Project{
description:

A process always belongs to a project

UID*string

UID of the project

}
Tool*#/definitions/ProcessPostRequest_ToolProcessPostRequest_Tool{
description:

Information about the tool executed by the process

ToolName*string

Name of the tool

Version*string

Version of the tool

EntryPoint#/definitions/ProcessPostRequest_Tool_EntryPointProcessPostRequest_Tool_EntryPoint{
description:

Entry point used in the process

EntryPointName*string

Name of the entry point

Parameter[

Parameters used in the process

#/definitions/ProcessEndpointType_Tool_EntryPoint_ParameterProcessEndpointType_Tool_EntryPoint_Parameter{
ParameterNamestring

Name of the parameter

ParameterValuestring

Value of the parameter

}
]
}
}
}
#/definitions/LogEntryEndpointTypeLogEntryEndpointType{
description:

Log entry

SeqNrinteger

Ordering number. Lowest means oldest entry

LogDatestring($date)

Log date in dd.mm.yyyy hh24:mi:ss

LogSourcestring

Source of the log. Could be either GUI, Tool, …

LogLevelstring

error, info, warning, debug

LogMsgstring

Log message. Free text

}
#/definitions/LogEntryPostRequestLogEntryPostRequest{
description:

Log entry

LogSourcestring

Source of the log. Could be either GUI, Tool, …

LogLevelstring

error, info, warning, debug

LogMsgstring

Log message. Free text

}
RFC6902PatchRequest_org[#/definitions/RFC6902PatchRequest_org_innerRFC6902PatchRequest_org_inner{...}]
PublishAndShareConfigEndpointType[#/definitions/PublishAndShareConfigEndpointType_innerPublishAndShareConfigEndpointType_inner{...}]
#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
#/definitions/ProjectsEndpointType_crsProjectsEndpointType_crs{
typestring

Coordinate system definition

Enum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_crs_propertiesProjectsEndpointType_crs_properties{
namestringEnum:
Array [ 2 ]
}
}
#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
#/definitions/ProjectsEndpointType_properties_SpatialSourcesProjectsEndpointType_properties_SpatialSources{
UIDstring

UUID of the SpatialSources.

}
#/definitions/ProjectsEndpointType_propertiesProjectsEndpointType_properties{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ProjectDirstring

URI to a directory resource. Not clear if needed.

Models[

Array of models (UID).

#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
]
SpatialSources[

Array of SpatialSources (UID).

#/definitions/ProjectsEndpointType_properties_SpatialSourcesProjectsEndpointType_properties_SpatialSources{
UIDstring

UUID of the SpatialSources.

}
]
Tags[

Array of tags (strings).

string]
}
#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
#/definitions/ProjectsEndpointType_featuresProjectsEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType_propertiesProjectsEndpointType_properties{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ProjectDirstring

URI to a directory resource. Not clear if needed.

Models[

Array of models (UID).

#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
]
SpatialSources[

Array of SpatialSources (UID).

#/definitions/ProjectsEndpointType_properties_SpatialSourcesProjectsEndpointType_properties_SpatialSources{
UIDstring

UUID of the SpatialSources.

}
]
Tags[

Array of tags (strings).

string]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
#/definitions/ProjectsPostRequest_properties_SpatialSourcesProjectsPostRequest_properties_SpatialSources{
UIDstring

UUID of SpatialSources

}
#/definitions/ProjectsPostRequest_propertiesProjectsPostRequest_properties{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ProjectDirstring

URI to a directory resource. Not clear if needed.

Models[

Array of models (UID).

#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
]
SpatialSources[

Array of SpatialSources (UID).

#/definitions/ProjectsPostRequest_properties_SpatialSourcesProjectsPostRequest_properties_SpatialSources{
UIDstring

UUID of SpatialSources

}
]
Tags[

Array of tags (strings).

string]
}
#/definitions/ProjectsPostRequest_featuresProjectsPostRequest_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/ProjectsPostRequest_propertiesProjectsPostRequest_properties{
Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ProjectDirstring

URI to a directory resource. Not clear if needed.

Models[

Array of models (UID).

#/definitions/ProjectsEndpointType_properties_ModelsProjectsEndpointType_properties_Models{
UIDstring

UUID of the Models.

}
]
SpatialSources[

Array of SpatialSources (UID).

#/definitions/ProjectsPostRequest_properties_SpatialSourcesProjectsPostRequest_properties_SpatialSources{
UIDstring

UUID of SpatialSources

}
]
Tags[

Array of tags (strings).

string]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
#/definitions/ProjectsEndpointType2_propertiesProjectsEndpointType2_properties{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ConnectedObjectsConnectedObjectsEndpointType[#/definitions/ConnectedObjectsEndpointType_innerConnectedObjectsEndpointType_inner{
projectUIDstring

UUID of the project

TypeOfConnectedObjectstring

Type of the connected object from item2item

NameOfConnectedObjectstring

Name of the object, taken from the object table

UUIDofConnectObjectstring

UUID of the connected object

}
]
Tags[

Array of tags (strings).

string]
}
#/definitions/ProjectsEndpointType2_featuresProjectsEndpointType2_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/ProjectsEndpointType2_propertiesProjectsEndpointType2_properties{
UIDstring

UUID

Namestring

Freely chosen name

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

ConnectedObjectsConnectedObjectsEndpointType[#/definitions/ConnectedObjectsEndpointType_innerConnectedObjectsEndpointType_inner{
projectUIDstring

UUID of the project

TypeOfConnectedObjectstring

Type of the connected object from item2item

NameOfConnectedObjectstring

Name of the object, taken from the object table

UUIDofConnectObjectstring

UUID of the connected object

}
]
Tags[

Array of tags (strings).

string]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
#/definitions/ModelsEndpointType_ModelClassesModelsEndpointType_ModelClasses{
UIDstring

UUID od associated model classes

}
#/definitions/ModelsEndpointType_ProjectsModelsEndpointType_Projects{
UIDstring

UUID of associated project.

}
#/definitions/ModelClassesEndpointType_ModelModelClassesEndpointType_Model{
description:

Array of Projects (UID).

UIDstring

UUID of associated models.

}
#/definitions/SpatialSourcesEndpointType_AdditionalDocumentsSpatialSourcesEndpointType_AdditionalDocuments{
UIDstring

UUID of the additional document.

}
#/definitions/AdminSourcesEndpointType_SpatialUnitsAdminSourcesEndpointType_SpatialUnits{
UIDstring

UUID of the spatial unit.

}
#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
#/definitions/SpatialUnitsFeatureEndpointType_propertiesSpatialUnitsFeatureEndpointType_properties{
UIDstring

UUID

Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Conceptstring

According to the ontology based on LADM

Levelstring

Level according to LADM

AdminSource[

Related Admin Source Documents

#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
#/definitions/SpatialUnitsFeatureEndpointType_featuresSpatialUnitsFeatureEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/SpatialUnitsFeatureEndpointType_propertiesSpatialUnitsFeatureEndpointType_properties{
UIDstring

UUID

Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Conceptstring

According to the ontology based on LADM

Levelstring

Level according to LADM

AdminSource[

Related Admin Source Documents

#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
#/definitions/SpatialUnitsFeaturePostRequest_propertiesSpatialUnitsFeaturePostRequest_properties{
Name*string

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Concept*string

According to the ontology based on LADM

Levelstring

Level according to LADM

AdminSource[

Related Admin Source Documents

#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
#/definitions/SpatialUnitsFeaturePostRequest_featuresSpatialUnitsFeaturePostRequest_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/SpatialUnitsFeaturePostRequest_propertiesSpatialUnitsFeaturePostRequest_properties{
Name*string

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

Concept*string

According to the ontology based on LADM

Levelstring

Level according to LADM

AdminSource[

Related Admin Source Documents

#/definitions/SpatialUnitsFeatureEndpointType_properties_AdminSourceSpatialUnitsFeatureEndpointType_properties_AdminSource{
UIDstring

UID of an Admin Source Document Index

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/ProjectsEndpointType_geometryProjectsEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[[
maxItems: 2

minItems: 2
number]
]
]
}
}
#/definitions/BoundaryFaceStringEndpointType_properties_SpatialUnitBoundaryFaceStringEndpointType_properties_SpatialUnit{
UIDstring

UID of an spatial unit feature

}
#/definitions/BoundaryFaceStringEndpointType_propertiesBoundaryFaceStringEndpointType_properties{
UIDstring

UUID

Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

SpatialUnit[

Related SpatialUnit

#/definitions/BoundaryFaceStringEndpointType_properties_SpatialUnitBoundaryFaceStringEndpointType_properties_SpatialUnit{
UIDstring

UID of an spatial unit feature

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
#/definitions/BoundaryFaceStringEndpointType_geometryBoundaryFaceStringEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
#/definitions/BoundaryFaceStringEndpointType_featuresBoundaryFaceStringEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/BoundaryFaceStringEndpointType_propertiesBoundaryFaceStringEndpointType_properties{
UIDstring

UUID

Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

SpatialUnit[

Related SpatialUnit

#/definitions/BoundaryFaceStringEndpointType_properties_SpatialUnitBoundaryFaceStringEndpointType_properties_SpatialUnit{
UIDstring

UID of an spatial unit feature

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/BoundaryFaceStringEndpointType_geometryBoundaryFaceStringEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
}
#/definitions/BoundaryFaceStringPostRequest_propertiesBoundaryFaceStringPostRequest_properties{
Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

SpatialUnit[

Related SpatialUnit

#/definitions/BoundaryFaceStringEndpointType_properties_SpatialUnitBoundaryFaceStringEndpointType_properties_SpatialUnit{
UIDstring

UID of an spatial unit feature

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
#/definitions/BoundaryFaceStringPostRequest_featuresBoundaryFaceStringPostRequest_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/BoundaryFaceStringPostRequest_propertiesBoundaryFaceStringPostRequest_properties{
Namestring

Name of the Spatial Unit

Descriptionstring

Free text for description. Only plain text. Max 255 char.

LongDescriptionstring

Text for description. Can contain html. Max 4000 char.

ExtDescriptionURLstring

URL to an external description of the document.

SpatialUnit[

Related SpatialUnit

#/definitions/BoundaryFaceStringEndpointType_properties_SpatialUnitBoundaryFaceStringEndpointType_properties_SpatialUnit{
UIDstring

UID of an spatial unit feature

}
]
Projects[

Related Projects

#/definitions/SpatialUnitsFeatureEndpointType_properties_ProjectsSpatialUnitsFeatureEndpointType_properties_Projects{
UIDstring

UID of an Project

}
]
}
geometry#/definitions/BoundaryFaceStringEndpointType_geometryBoundaryFaceStringEndpointType_geometry{
typestringEnum:
Array [ 1 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
}
#/definitions/TrainingsSetEndpointType_ModelsTrainingsSetEndpointType_Models{
UIDstring

UUID of associated models.

}
#/definitions/MetricMapFeaturesEndpointType_propertiesMetricMapFeaturesEndpointType_properties{
UIDstring

UUID

fgroupstring

Name of the feature group

ftypestring

Name of the feature type

fsubtypestring

Name of the feature subtype

fnamestring

Freely chosen name

fURIstring

URI to the feature definition

}
#/definitions/MetricMapFeaturesEndpointType_geometryMetricMapFeaturesEndpointType_geometry{
typestringEnum:
Array [ 3 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
#/definitions/MetricMapFeaturesEndpointType_featuresMetricMapFeaturesEndpointType_features{
typestringEnum:
Array [ 1 ]
properties#/definitions/MetricMapFeaturesEndpointType_propertiesMetricMapFeaturesEndpointType_properties{
UIDstring

UUID

fgroupstring

Name of the feature group

ftypestring

Name of the feature type

fsubtypestring

Name of the feature subtype

fnamestring

Freely chosen name

fURIstring

URI to the feature definition

}
geometry#/definitions/MetricMapFeaturesEndpointType_geometryMetricMapFeaturesEndpointType_geometry{
typestringEnum:
Array [ 3 ]
coordinates[[
maxItems: 2

minItems: 2
number]
]
}
}
#/definitions/MetricMapFeaturePostRequest_propertiesMetricMapFeaturePostRequest_properties{
fgroup*string

Name of the feature group

ftypestring

Name of the feature type

fsubtypestring

Name of the feature subtype

fname*string

Freely chosen name

fURIstring

URI to the feature definition

}
#/definitions/ImageSetsEndpointType_MetadataImageSetsEndpointType_Metadata{
MetaDataKeystring

Name of the metadata key

MetaDataValuestring

Value of the metadata

}
#/definitions/ImageSetsEndpointType_ContentItemsImageSetsEndpointType_ContentItems{
ContentUIDstring

UUID of a ContentItem

Descriptionstring

Description related to the image set

}
#/definitions/TagsEndpointType_TaggedObjectsTagsEndpointType_TaggedObjects{
ObjectTypestring

Project, Model, TrainingSet, etc.

ObjectUUIDstring

UUID of the object

Namestring

Name of the object

Descriptionstring

Description of the object.

}
#/definitions/TagsEndpointType_TaggedObjectsSumTagsEndpointType_TaggedObjectsSum{
ObjectTypestring

Project, Model, TrainingSet, etc.

Countinteger

Number of object

}
#/definitions/ConnectedObjectsEndpointType_innerConnectedObjectsEndpointType_inner{
projectUIDstring

UUID of the project

TypeOfConnectedObjectstring

Type of the connected object from item2item

NameOfConnectedObjectstring

Name of the object, taken from the object table

UUIDofConnectObjectstring

UUID of the connected object

}
#/definitions/ToolsEndpointType_ImageToolsEndpointType_Image{
description:

Details about the image

UIDstring

UID of the image

ReleaseDatestring($date)

Release Data of of the tool image

Imagestring

Image of the tool

}
#/definitions/ToolsEndpointType_EntryPointsToolsEndpointType_EntryPoints{
Namestring

Name of the EntryPoint or sub tool

Descriptionstring

Free text for description. Only plain text.

LongDescriptionstring

Free text for long description. Only plain text.

EntryPointstring

How to start the sub tool

}
#/definitions/ProcessEndpointType_ProjectProcessEndpointType_Project{
description:

A process always belongs to a project

UIDstring

UID of the project

Namestring

Name of the project

Descriptionstring

Free text for description. Only plain text.

}
#/definitions/ProcessEndpointType_Tool_EntryPoint_ParameterProcessEndpointType_Tool_EntryPoint_Parameter{
ParameterNamestring

Name of the parameter

ParameterValuestring

Value of the parameter

}
#/definitions/ProcessEndpointType_Tool_EntryPointProcessEndpointType_Tool_EntryPoint{
description:

Entry point used in the process

EntryPointNamestring

Name of the entry point

Parameter[

Parameters used in the process

#/definitions/ProcessEndpointType_Tool_EntryPoint_ParameterProcessEndpointType_Tool_EntryPoint_Parameter{
ParameterNamestring

Name of the parameter

ParameterValuestring

Value of the parameter

}
]
}
#/definitions/ProcessEndpointType_ToolProcessEndpointType_Tool{
description:

Information about the tool executed by the process

ToolNamestring

Name of the tool

Versionstring

Version of the tool

EntryPoint#/definitions/ProcessEndpointType_Tool_EntryPointProcessEndpointType_Tool_EntryPoint{
description:

Entry point used in the process

EntryPointNamestring

Name of the entry point

Parameter[

Parameters used in the process

#/definitions/ProcessEndpointType_Tool_EntryPoint_ParameterProcessEndpointType_Tool_EntryPoint_Parameter{
ParameterNamestring

Name of the parameter

ParameterValuestring

Value of the parameter

}
]
}
}
#/definitions/ProcessEndpointType_ResultsProcessEndpointType_Results{
ResultTypestring

Spatial Unit/Orthomosaic/Boundary Face String/MetricMapFeature

ResultUIDstring

UUID

}
#/definitions/ProcessPostRequest_ProjectProcessPostRequest_Project{
description:

A process always belongs to a project

UID*string

UID of the project

}
#/definitions/ProcessPostRequest_Tool_EntryPointProcessPostRequest_Tool_EntryPoint{
description:

Entry point used in the process

EntryPointName*string

Name of the entry point

Parameter[

Parameters used in the process

#/definitions/ProcessEndpointType_Tool_EntryPoint_ParameterProcessEndpointType_Tool_EntryPoint_Parameter{
ParameterNamestring

Name of the parameter

ParameterValuestring

Value of the parameter

}
]
}
#/definitions/ProcessPostRequest_ToolProcessPostRequest_Tool{
description:

Information about the tool executed by the process

ToolName*string

Name of the tool

Version*string

Version of the tool

EntryPoint#/definitions/ProcessPostRequest_Tool_EntryPointProcessPostRequest_Tool_EntryPoint{
description:

Entry point used in the process

EntryPointName*string

Name of the entry point

Parameter[

Parameters used in the process

#/definitions/ProcessEndpointType_Tool_EntryPoint_ParameterProcessEndpointType_Tool_EntryPoint_Parameter{
ParameterNamestring

Name of the parameter

ParameterValuestring

Value of the parameter

}
]
}
}
#/definitions/RFC6902PatchRequest_org_innerRFC6902PatchRequest_org_inner{
op*stringEnum:
Array [ 2 ]
path*string
fromstring
valuestring
}
#/definitions/PublishAndShareConfigEndpointType_innerPublishAndShareConfigEndpointType_inner{
configkeystring

Configuration parameter: Key

configvaluestring

Configuration paramter: Value

descriptionstring

Configuration paratmeter: Description

}