1. Overview
Microservice containing the business logic for managing templates of property definitions.
2. Resources
2.1. Data-type-controller
Data Type Controller
2.1.1. Query DataTypes
GET /dataTypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2. Property-category-controller
Property Category Controller
2.2.1. createPropertyCategory
POST /propertyCategories
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
propertyCategoryRequest |
propertyCategoryRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
409 |
Category with that name already exists |
|
500 |
Internal Server error |
2.2.2. Query Property Categories
GET /propertyCategories
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2.3. Query Property Categories
GET /propertyCategories/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2.4. updatePropertyCategory
PUT /propertyCategories/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Body |
propertyCategoryInfo |
propertyCategoryInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
409 |
Category with that name already exists |
|
500 |
Internal Server error |
2.3. Property-definition-controller
Property Definition Controller
2.3.1. getPropertyDefinitions
GET /propertyDefinitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
propertyCategoryId |
propertyCategoryId |
string |
|
Query |
propertyDefinitionIds |
propertyDefinitionIds |
< string > array(multi) |
|
Query |
propertyGroupId |
propertyGroupId |
string |
|
Query |
propertyName |
propertyName |
string |
|
Query |
size |
size |
integer (int32) |
|
Query |
version |
version |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.3.2. getRevisions
GET /propertyDefinitions/revisions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< PropertyDefinitionInfo > array |
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.3.3. createPropertyDefinition
POST /propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
propertyGroupId |
propertyGroupId |
string |
Body |
createPropertyDefinitionRequest |
createPropertyDefinitionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
OK |
|
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
409 |
Property definition with that name already exists in the propertyGroup |
|
500 |
Internal Server error |
2.3.4. getPropertyDefinitionsByGroup
GET /propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
propertyGroupId |
propertyGroupId |
string |
|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.3.5. deletePropertyDefinitions
DELETE /propertyGroups/{propertyGroupId}/propertyDefinitions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
propertyGroup not found |
No Content |
401 |
Unauthorized |
No Content |
2.3.6. getPropertyDefinition
GET /propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
propertyDefinitionId |
propertyDefinitionId |
string |
Path |
propertyGroupId |
propertyGroupId |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.3.7. updatePropertyDefinition
PUT /propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
propertyDefinitionId |
propertyDefinitionId |
string |
Path |
propertyGroupId |
propertyGroupId |
string |
Body |
updatePropertyDefinitionRequest |
updatePropertyDefinitionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
404 |
Not found |
|
409 |
Property definition with that name already exists on the propertyGroup |
|
412 |
Property definition has been updated since the GET on which the submitted changes were made. Response contains the current record. |
2.3.8. deletePropertyDefinition
DELETE /propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
propertyDefinitionId |
propertyDefinitionId |
string |
Path |
propertyGroupId |
propertyGroupId |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
propertyGroup not found |
No Content |
401 |
Unauthorized |
No Content |
2.4. Property-group-controller
Property Group Controller
2.4.1. createPropertyGroup
POST /propertyGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
createProperyGroupRequest |
createProperyGroupRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
409 |
Property Group with that name already exists |
|
500 |
Internal Server error |
2.4.2. Query Property Groups
GET /propertyGroups
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
categoryId |
categoryId |
string |
|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.4.3. Delete All the Property Groups
DELETE /propertyGroups
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.4.4. Query Property Group
GET /propertyGroups/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.4.5. updatePropertyGroup
PUT /propertyGroups/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
string |
Body |
properyGroupRequest |
properyGroupRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
409 |
Property Group with that name already exists |
|
412 |
Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record. |
|
500 |
Internal Server error |
3. Definitions
3.1. DataTypeInfosPage
| Name | Schema |
|---|---|
content |
< PropertyDataTypeInfo > array |
links |
< Link > array |
page |
3.5. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.6. PropertyCategoriesPage
| Name | Schema |
|---|---|
content |
< PropertyCategory > array |
links |
< Link > array |
page |
3.7. PropertyCategory
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
id |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
propertyGroups |
< PropertyGroup > array |
version |
integer (int32) |
3.8. PropertyCategoryPage
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
id |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
propertyGroups |
< PropertyGroup > array |
version |
integer (int32) |
3.10. PropertyDataType
| Name | Schema |
|---|---|
dataTypeDesc |
string |
id |
integer (int32) |
name |
string |
usePrecision |
integer (int32) |
userDefined |
integer (int32) |
3.11. PropertyDataTypeInfo
| Name | Schema |
|---|---|
dataTypeDesc |
string |
id |
integer (int64) |
name |
string |
usePrecision |
integer (int32) |
userDefined |
integer (int32) |
3.12. PropertyDefinition
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defaultValue |
string |
deleted |
boolean |
displayName |
string |
id |
string |
initialId |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
propertyDataType |
|
propertyGroup |
|
required |
boolean |
uom |
integer (int32) |
version |
integer (int32) |
3.13. PropertyDefinitionInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defaultValue |
string |
deleted |
boolean |
displayName |
string |
id |
string |
initialId |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
propertyCategoryId |
string |
propertyCategoryName |
string |
propertyDataType |
string |
propertyDataTypeId |
integer (int32) |
propertyGroupId |
string |
propertyGroupName |
string |
required |
boolean |
uom |
integer (int32) |
version |
integer (int32) |
3.14. PropertyDefinitionPage
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defaultValue |
string |
deleted |
boolean |
displayName |
string |
id |
string |
initialId |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
propertyCategoryId |
string |
propertyCategoryName |
string |
propertyDataType |
string |
propertyDataTypeId |
integer (int32) |
propertyGroupId |
string |
propertyGroupName |
string |
required |
boolean |
uom |
integer (int32) |
version |
integer (int32) |
3.15. PropertyDefinitionRequest
| Name | Schema |
|---|---|
dataTypeId |
integer (int32) |
defaultValue |
string |
displayName |
string |
name |
string |
required |
boolean |
uomId |
integer (int32) |
3.16. PropertyDefinitionUpdateRequest
| Name | Schema |
|---|---|
dataTypeId |
integer (int32) |
defaultValue |
string |
displayName |
string |
name |
string |
required |
boolean |
uomId |
integer (int32) |
version |
integer (int32) |
3.17. PropertyDefinitionsPage
| Name | Schema |
|---|---|
content |
< PropertyDefinitionInfo > array |
links |
< Link > array |
page |
3.18. PropertyGroup
| Name | Schema |
|---|---|
aliasName |
string |
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
description |
string |
id |
string |
initialId |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
propertyCategory |
|
propertyDefinitions |
< PropertyDefinition > array |
version |
integer (int32) |
3.19. PropertyGroupInfo
| Name | Schema |
|---|---|
aliasName |
string |
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
description |
string |
id |
string |
initialId |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
propertyCategoryId |
string |
version |
integer (int32) |
3.20. PropertyGroupPage
| Name | Schema |
|---|---|
aliasName |
string |
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
description |
string |
id |
string |
initialId |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
< Link > array |
name |
string |
propertyCategoryId |
string |
version |
integer (int32) |
3.21. PropertyGroupRequest
| Name | Schema |
|---|---|
aliasName |
string |
description |
string |
name |
string |
propertyCategoryId |
string |
3.22. PropertyGroupsPage
| Name | Schema |
|---|---|
content |
< PropertyGroupInfo > array |
links |
< Link > array |
page |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://localhost/uaa/oauth/authorize
Token URL : https://localhost/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://localhost/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://localhost/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://localhost/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |