Create A Property Definition
Creates a new Property Definition. If the Property Definition to create conflicts with an existing definition, an error is raised.
Request
URI
POST
https://{api_host}/properties-service/api/propertydefinitions
COPY
Request Body
ContextPropertyDefinition of type(s) application/json
Optional
{
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"label": "string",
"version": 0,
"lastUpdated": "string",
"createdDate": "string",
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"tenantId": "string",
"orderIndex": 0,
"id": "string"
}
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
string
label
Optional
label
integer As int64 As int64
version
Optional
version
object
facets
Optional
facets
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
displayAdvice
Optional
displayAdvice
Possible values are : TEXTBOX, HYPERLINK, EMAIL, TEXTAREA, DATE_TIME_PICKER, CHECKBOX, YES_NO, CHECKBOX_GROUP, DUAL_LIST, RADIO_GROUP, DROPDOWN, LIST, SEARCHER, TREE, FORM, IMAGE, SLIDER, DATA_TABLE, VALUE_PICKER, CONFIRM_PASSWORD,
string
tenantId
Optional
tenantId
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
Responses
200
successful operation
Operation doesn't return any data structure
201
Successfully created Property Definition
Returns ContextPropertyDefinition of type(s) */*
{
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"label": "string",
"version": 0,
"lastUpdated": "string",
"createdDate": "string",
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"tenantId": "string",
"orderIndex": 0,
"id": "string"
}
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
string
label
Optional
label
integer As int64 As int64
version
Optional
version
object
facets
Optional
facets
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
displayAdvice
Optional
displayAdvice
Possible values are : TEXTBOX, HYPERLINK, EMAIL, TEXTAREA, DATE_TIME_PICKER, CHECKBOX, YES_NO, CHECKBOX_GROUP, DUAL_LIST, RADIO_GROUP, DROPDOWN, LIST, SEARCHER, TREE, FORM, IMAGE, SLIDER, DATA_TABLE, VALUE_PICKER, CONFIRM_PASSWORD,
string
tenantId
Optional
tenantId
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
400
Property Definition already exists
Operation doesn't return any data structure
Api Operations
POST
Create A Property Definition
POST
Create A Property Group
PUT
Create Or update A Property Definition
PUT
Create Or update A Property Group
DELETE
Delete A Property Definition
DELETE
Delete A Property Group
GET
Get A Property Group
POST
Get Multiple Property Definitions
POST
Get multiple Property Groups
POST
Get permissible values for A Property Definition
GET
Get Property Definition
GET
Get Property Definitions
GET
Get Property Groups