1. Overview

Microservice containing the business logic for managing templates of property definitions.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • data-type-controller : Data Type Controller

  • property-category-controller : Property Category Controller

  • property-definition-controller : Property Definition Controller

  • property-group-controller : Property Group Controller

2. Resources

2.1. Data-type-controller

Data Type Controller

2.1.1. Query DataTypes

GET /dataTypes
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20

Responses
HTTP Code Description Schema

200

OK

DataTypeInfosPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2. Property-category-controller

Property Category Controller

2.2.1. createPropertyCategory

POST /propertyCategories
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

propertyCategoryRequest
required

propertyCategoryRequest

PropertyCategoryRequest

Responses
HTTP Code Description Schema

201

Created

PropertyCategory

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Category with that name already exists

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Consumes
  • application/json

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.2. Query Property Categories

GET /propertyCategories
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20

Responses
HTTP Code Description Schema

200

OK

PropertyCategoriesPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.3. Query Property Category by id

GET /propertyCategories/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

PropertyCategoryInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.4. updatePropertyCategory

PUT /propertyCategories/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Body

propertyCategoryInfo
required

propertyCategoryInfo

PropertyCategoryRequest

Responses
HTTP Code Description Schema

200

OK

PropertyCategory

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Category with that name already exists

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Consumes
  • application/json

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.5. Delete Property Category

DELETE /propertyCategories/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3. Property-definition-controller

Property Definition Controller

2.3.1. getPropertyDefinitions

GET /propertyDefinitions
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

includeDeleted
optional

includeDeleted

boolean

Query

page
optional

page

integer (int32)

0

Query

propertyCategoryId
optional

propertyCategoryId

string

Query

propertyDefinitionIds
optional

propertyDefinitionIds

< string > array(multi)

Query

propertyGroupId
optional

propertyGroupId

string

Query

propertyName
optional

propertyName

string

Query

size
optional

size

integer (int32)

20

Query

version
optional

version

integer (int32)

Responses
HTTP Code Description Schema

200

OK

PropertyDefinitionsPage

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.2. getRevisions

GET /propertyDefinitions/revisions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

initialId
required

initialId

< string > array(multi)

Responses
HTTP Code Description Schema

200

OK

< PropertyDefinitionInfo > array

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.3. createPropertyDefinition

POST /propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

propertyGroupId
required

propertyGroupId

string

Body

createPropertyDefinitionRequest
required

createPropertyDefinitionRequest

PropertyDefinitionRequest

Responses
HTTP Code Description Schema

201

OK

PropertyDefinitionInfo

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property definition with that name already exists in the propertyGroup

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Consumes
  • application/json

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.4. getPropertyDefinitionsByGroup

GET /propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

propertyGroupId
required

propertyGroupId

string

Query

includeDeleted
optional

includeDeleted

boolean

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20

Responses
HTTP Code Description Schema

200

OK

PropertyDefinitionsPage

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.5. deletePropertyDefinitions

DELETE /propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

propertyGroupId
required

propertyGroupId

string

Responses
HTTP Code Description Schema

200

OK

object

400

propertyGroup not found

No Content

401

Unauthorized

No Content

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.6. getPropertyDefinition

GET /propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

propertyDefinitionId
required

propertyDefinitionId

string

Path

propertyGroupId
required

propertyGroupId

string

Responses
HTTP Code Description Schema

200

OK

PropertyDefinitionInfo

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.7. updatePropertyDefinition

PUT /propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

propertyDefinitionId
required

propertyDefinitionId

string

Path

propertyGroupId
required

propertyGroupId

string

Body

updatePropertyDefinitionRequest
required

updatePropertyDefinitionRequest

PropertyDefinitionUpdateRequest

Responses
HTTP Code Description Schema

200

OK

PropertyDefinitionInfo

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not found

HttpErrorResponse

409

Property definition with that name already exists on the propertyGroup

HttpErrorResponse

412

Property definition has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

Consumes
  • application/json

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.8. deletePropertyDefinition

DELETE /propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

propertyDefinitionId
required

propertyDefinitionId

string

Path

propertyGroupId
required

propertyGroupId

string

Responses
HTTP Code Description Schema

200

OK

object

400

propertyGroup not found

No Content

401

Unauthorized

No Content

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4. Property-group-controller

Property Group Controller

2.4.1. createPropertyGroup

POST /propertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

createProperyGroupRequest
required

createProperyGroupRequest

PropertyGroupRequest

Responses
HTTP Code Description Schema

201

Created

PropertyGroupInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Consumes
  • application/json

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.2. Query Property Groups

GET /propertyGroups
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

categoryId
optional

categoryId

string

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20

Responses
HTTP Code Description Schema

200

OK

PropertyGroupsPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.3. Delete All the Property Groups

DELETE /propertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.4. Update property groups

PUT /propertyGroups/globalDepartmentsPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

propertyGroupUpdateInfo
required

Property Group Ids

< string > array

Responses
HTTP Code Description Schema

200

OK

DepartmentsPropertyGroupAssociation

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal server error

No Content

503

Service Unavailable

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.5. Update property groups

PUT /propertyGroups/globalLinePropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

propertyGroupUpdateInfo
required

Property Group Ids

< string > array

Responses
HTTP Code Description Schema

200

OK

LinesPropertyGroupAssociation

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal server error

No Content

503

Service Unavailable

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.6. Update property groups

PUT /propertyGroups/globalUnitPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

propertyGroupUpdateInfo
required

Property Group Ids

< string > array

Responses
HTTP Code Description Schema

200

OK

UnitsPropertyGroupAssociation

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal server error

No Content

503

Service Unavailable

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.7. Update property groups

PUT /propertyGroups/globalUnitVariablesPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

propertyGroupUpdateInfo
required

Property Group Ids

< string > array

Responses
HTTP Code Description Schema

200

OK

UnitVariablesPropertyGroupAssociation

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal server error

No Content

503

Service Unavailable

No Content

Consumes
  • application/json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.8. Query Property Group

GET /propertyGroups/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

PropertyGroupInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.9. updatePropertyGroup

PUT /propertyGroups/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Body

properyGroupRequest
required

properyGroupRequest

PropertyGroupRequest

Responses
HTTP Code Description Schema

200

OK

PropertyGroupInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Consumes
  • application/json

Produces
  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.10. Delete Property Group

DELETE /propertyGroups/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.11. getGlobalDepartmentsPropertyGroupMapping

GET /propertyGroups/{id}/globalDepartmentsPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

DepartmentsPropertyGroupAssociation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.12. deleteGlobalDepartmentsPropertyGroupMapping

DELETE /propertyGroups/{id}/globalDepartmentsPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.13. deleteGlobalLinesPropertyGroupMapping

DELETE /propertyGroups/{id}/globalLinePropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.14. getGlobalLinesPropertyGroupMapping

GET /propertyGroups/{id}/globalLinesPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

LinesPropertyGroupAssociation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.15. deleteGlobalUnitPropertyGroupMapping

DELETE /propertyGroups/{id}/globalUnitPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.16. getGlobalUnitVariablesPropertyGroupMapping

GET /propertyGroups/{id}/globalUnitVariablesPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

UnitVariablesPropertyGroupAssociation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.17. deleteGlobalUnitVariablesPropertyGroupMapping

DELETE /propertyGroups/{id}/globalUnitVariablesPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.18. getGlobalUnitsPropertyGroupMapping

GET /propertyGroups/{id}/globalUnitsPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

string

Responses
HTTP Code Description Schema

200

OK

UnitsPropertyGroupAssociation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

3. Definitions

3.1. DataTypeInfosPage

Name Schema

content
optional

< PropertyDataTypeInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.2. DepartmentsPropertyGroupAssociation

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

propertyGroupId
optional

string

3.3. Error

Name Schema

code
optional

string

details
optional

object

3.4. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.5. LinesPropertyGroupAssociation

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

propertyGroupId
optional

string

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

string

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.7. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.8. PropertyCategoriesPage

Name Schema

content
optional

< PropertyCategory > array

links
optional

< Link > array

page
optional

PageMetadata

3.9. PropertyCategory

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

deleted
optional

boolean

id
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

propertyGroups
optional

< PropertyGroup > array

protected
optional

boolean

version
optional

integer (int32)

3.10. PropertyCategoryInfo

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

deleted
optional

boolean

id
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

protected
optional

boolean

version
optional

integer (int32)

3.11. PropertyCategoryRequest

Name Schema

name
optional

string

3.12. PropertyDataType

Name Schema

dataTypeDesc
optional

string

id
optional

integer (int32)

name
optional

string

usePrecision
optional

integer (int32)

userDefined
optional

integer (int32)

3.13. PropertyDataTypeInfo

Name Schema

dataTypeDesc
optional

string

id
optional

integer (int64)

name
optional

string

usePrecision
optional

integer (int32)

userDefined
optional

integer (int32)

3.14. PropertyDefinition

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

defaultValue
optional

string

deleted
optional

boolean

displayName
optional

string

id
optional

string

initialId
optional

string

isProtected
optional

boolean

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

propertyDataType
optional

PropertyDataType

propertyGroup
optional

PropertyGroup

required
optional

boolean

uom
optional

integer (int32)

version
optional

integer (int32)

3.15. PropertyDefinitionInfo

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

defaultValue
optional

string

deleted
optional

boolean

displayName
optional

string

groupCreatedBy
optional

string

groupCreatedOn
optional

string (date-time)

id
optional

string

initialId
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

propertyCategoryId
optional

string

propertyCategoryName
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyGroupId
optional

string

propertyGroupName
optional

string

protected
optional

boolean

required
optional

boolean

uom
optional

integer (int32)

version
optional

integer (int32)

3.16. PropertyDefinitionRequest

Name Schema

dataTypeId
optional

integer (int32)

defaultValue
optional

string

displayName
optional

string

name
optional

string

required
optional

boolean

uomId
optional

integer (int32)

3.17. PropertyDefinitionUpdateRequest

Name Schema

dataTypeId
optional

integer (int32)

defaultValue
optional

string

displayName
optional

string

name
optional

string

required
optional

boolean

uomId
optional

integer (int32)

version
optional

integer (int32)

3.18. PropertyDefinitionsPage

Name Schema

content
optional

< PropertyDefinitionInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.19. PropertyGroup

Name Schema

aliasName
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

deleted
optional

boolean

description
optional

string

id
optional

string

initialId
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

propertyCategory
optional

PropertyCategory

propertyDefinitions
optional

< PropertyDefinition > array

protected
optional

boolean

version
optional

integer (int32)

3.20. PropertyGroupInfo

Name Schema

aliasName
optional

string

applicationInfoList
optional

< PropertyGroupMappingResponse > array

createdBy
optional

string

createdOn
optional

string (date-time)

deleted
optional

boolean

description
optional

string

id
optional

string

initialId
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

propertyCategoryId
optional

string

protected
optional

boolean

version
optional

integer (int32)

3.21. PropertyGroupMappingResponse

Name Schema

application
optional

integer (int32)

applicationName
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

3.22. PropertyGroupRequest

Name Schema

aliasName
optional

string

description
optional

string

name
optional

string

propertyCategoryId
optional

string

3.23. PropertyGroupsPage

Name Schema

content
optional

< PropertyGroupInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.24. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

enum (, ?, &, /, #, *)

3.25. UnitVariablesPropertyGroupAssociation

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

propertyGroupId
optional

string

3.26. UnitsPropertyGroupAssociation

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

propertyGroupId
optional

string

3.27. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

4. Security

4.1. access_token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : https://processapphub.meridium.com/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://processapphub.meridium.com/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : https://processapphub.meridium.com/uaa/oauth/token

Name Description

default

Default oauth2 scope.