1. Overview
Microservice containing the business logic for managing templates of property definitions.
1.2. Tags
-
data-type-controller : Data Type Controller
-
engineering-units-controller : Engineering Units Controller
-
property-category-controller : Property Category Controller
-
property-definition-controller : Property Definition Controller
-
property-group-application-mapping-controller : Property Group Application Mapping Controller
-
property-group-controller : Property Group Controller
2. Resources
2.1. Data-type-controller
Data Type Controller
2.1.1. Query DataTypes
GET /v1/dataTypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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. Engineering-units-controller
Engineering Units Controller
2.2.1. Query DataTypes
GET /v1/engineeringUnits
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
active |
engineering unit active to get uom details |
boolean |
Query |
code |
engineering unit code to get uom details |
string |
Query |
description |
engineering unit description to get uom details |
string |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.3. Property-category-controller
Property Category Controller
2.3.1. createPropertyCategory
POST /v1/propertyCategories
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
propertyCategoryInfo |
propertyCategoryInfo |
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.3.2. Query Property Categories
GET /v1/propertyCategories
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
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.3.3. Query Property Category by Id
GET /v1/propertyCategories/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.3.4. updatePropertyCategory
PUT /v1/propertyCategories/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.5. Delete Property Category
DELETE /v1/propertyCategories/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
id |
id |
string |
|
Query |
forceDelete |
forceDelete |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.4. Property-definition-controller
Property Definition Controller
2.4.1. getPropertyDefinitions
GET /v1/propertyDefinitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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.4.2. createPropertyDefinition
POST /v1/propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.4.3. getPropertyDefinitionsByGroup
GET /v1/propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
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.4.4. deletePropertyDefinitions
DELETE /v1/propertyGroups/{propertyGroupId}/propertyDefinitions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
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.5. getPropertyDefinition
GET /v1/propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.4.6. updatePropertyDefinition
PUT /v1/propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
propertyDefinitionId |
propertyDefinitionId |
string |
Path |
propertyGroupId |
propertyGroupId |
string |
Body |
updatePropertyDefinitionRequest |
updatePropertyDefinitionRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
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.4.7. deletePropertyDefinition
DELETE /v1/propertyGroups/{propertyGroupId}/propertyDefinitions/{propertyDefinitionId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.5. Property-group-application-mapping-controller
Property Group Application Mapping Controller
2.5.1. Get entities mapped to a property group
GET /v1/propertyGroups/applicationMapping
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
propertyGroupId |
propertyGroupId |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfully retrieved |
object |
401 |
You are not authorized to view the resource |
No Content |
403 |
Accessing the resource you were trying to reach is forbidden |
No Content |
404 |
The resource you were trying to reach is not found |
No Content |
500 |
Internal server error |
No Content |
2.5.2. Update entities mapping to a property group
PUT /v1/propertyGroups/{propertyGroupId}/applicationMapping
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
propertyGroupId |
propertyGroupId |
string |
Body |
entityRequest |
List of entity/Application (1 - Materials, 2 - Areas, 3 - Workspace Centers,4 - WorkUnits, 5 - Material Variables) to map with group. |
< integer (int32) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfully retrieved |
object |
400 |
Bad Request |
No Content |
401 |
You are not authorized to view the resource |
No Content |
403 |
Accessing the resource you were trying to reach is forbidden |
No Content |
404 |
The resource you were trying to reach is not found |
No Content |
500 |
Internal server error |
No Content |
2.5.3. delete entities mapped to a property group
DELETE /v1/propertyGroups/{propertyGroupId}/applicationMapping/{application}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
application |
application |
integer (int32) |
Path |
propertyGroupId |
propertyGroupId |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Successfully retrieved |
object |
401 |
You are not authorized to view the resource |
No Content |
403 |
Accessing the resource you were trying to reach is forbidden |
No Content |
404 |
The resource you were trying to reach is not found |
No Content |
500 |
Internal server error |
No Content |
2.6. Property-group-controller
Property Group Controller
2.6.1. createPropertyGroup
POST /v1/propertyGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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.6.2. Query Property Groups
GET /v1/propertyGroups
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
categoryId |
categoryId |
string |
|
Query |
includeApplications |
includeApplications |
boolean |
|
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.6.3. Delete All the Property Groups
DELETE /v1/propertyGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.6.4. Query Property Group
GET /v1/propertyGroups/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
id |
id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.6.5. updatePropertyGroup
PUT /v1/propertyGroups/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
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 |
2.6.6. Delete Property Group
DELETE /v1/propertyGroups/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
id |
id |
string |
|
Query |
forceDelete |
forceDelete |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
3. Definitions
3.1. DataTypeInfosPage
| Name | Schema |
|---|---|
content |
< PropertyDataTypeInfo > array |
links |
|
page |
3.4. Link
| Name | Schema |
|---|---|
deprecation |
string |
href |
string |
hreflang |
string |
media |
string |
name |
string |
profile |
string |
rel |
string |
template |
|
templated |
boolean |
title |
string |
type |
string |
3.6. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.7. PropertyCategoriesPage
| Name | Schema |
|---|---|
content |
< PropertyCategory > array |
links |
|
page |
3.8. PropertyCategory
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
id |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
propertyGroups |
< PropertyGroup > array |
protected |
boolean |
version |
integer (int32) |
3.9. PropertyCategoryPage
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
deleted |
boolean |
id |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
|
name |
string |
propertyGroups |
< PropertyGroup > array |
protected |
boolean |
version |
integer (int32) |
3.11. PropertyDataType
| Name | Schema |
|---|---|
dataTypeDesc |
string |
id |
integer (int32) |
name |
string |
usePrecision |
integer (int32) |
userDefined |
integer (int32) |
3.12. PropertyDataTypeInfo
| Name | Schema |
|---|---|
dataTypeDesc |
string |
id |
integer (int64) |
name |
string |
usePrecision |
integer (int32) |
userDefined |
integer (int32) |
3.13. PropertyDefinition
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defaultValue |
string |
deleted |
boolean |
displayName |
string |
id |
string |
initialId |
string |
isProtected |
boolean |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
name |
string |
propertyDataType |
|
propertyGroup |
|
required |
boolean |
uom |
integer (int32) |
version |
integer (int32) |
3.14. PropertyDefinitionInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defaultValue |
string |
deleted |
boolean |
displayName |
string |
groupCreatedBy |
string |
groupCreatedOn |
string (date-time) |
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 |
protected |
boolean |
required |
boolean |
uom |
integer (int32) |
version |
integer (int32) |
3.15. PropertyDefinitionPage
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
defaultValue |
string |
deleted |
boolean |
displayName |
string |
groupCreatedBy |
string |
groupCreatedOn |
string (date-time) |
id |
string |
initialId |
string |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
links |
|
name |
string |
propertyCategoryId |
string |
propertyCategoryName |
string |
propertyDataType |
string |
propertyDataTypeId |
integer (int32) |
propertyGroupId |
string |
propertyGroupName |
string |
protected |
boolean |
required |
boolean |
uom |
integer (int32) |
version |
integer (int32) |
3.16. PropertyDefinitionRequest
| Name | Schema |
|---|---|
dataTypeId |
integer (int32) |
defaultValue |
string |
displayName |
string |
name |
string |
required |
boolean |
uomId |
integer (int32) |
3.17. PropertyDefinitionUpdateRequest
| Name | Schema |
|---|---|
dataTypeId |
integer (int32) |
defaultValue |
string |
displayName |
string |
name |
string |
required |
boolean |
uomId |
integer (int32) |
version |
integer (int32) |
3.18. PropertyDefinitionsPage
| Name | Schema |
|---|---|
content |
< PropertyDefinitionInfo > array |
links |
|
page |
3.19. 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 |
protected |
boolean |
version |
integer (int32) |
3.20. PropertyGroupInfo
| Name | Schema |
|---|---|
aliasName |
string |
applications |
< integer (int32) > array |
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.21. PropertyGroupPage
| Name | Schema |
|---|---|
content |
< PropertyGroupInfo > array |
links |
3.22. PropertyGroupRequest
| Name | Schema |
|---|---|
aliasName |
string |
description |
string |
name |
string |
propertyCategoryId |
string |
3.23. PropertyGroupsPage
| Name | Schema |
|---|---|
content |
< PropertyGroupInfo > array |
links |
|
page |
3.25. UnitOfMeasure
| Name | Description | Schema |
|---|---|---|
active |
Active |
boolean |
code |
Engineering Unit code |
string |
description |
Engineering Unit description |
string |
engUnitId |
Engineering Unit id |
integer (int64) |
links |
< Link > array |
3.26. UnitOfMeasurePage
| Name | Schema |
|---|---|
content |
< UnitOfMeasure > array |
links |
|
page |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://10.181.213.73/uaa/oauth/authorize
Token URL : https://10.181.213.73/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://10.181.213.73/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://10.181.213.73/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://10.181.213.73/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |