Create Or update A Property Definition
Creates or updates a Property Definition
Request
URI
PUT
https://{api_host}/properties-service/api/propertydefinitions/{id}
COPY
Path Parameters
string
id
Required
The id of the Property Definition to create or update
Request Body
ContextPropertyDefinition
of type(s)
application/json
Optional
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,
"facets": {
"facets": {}
},
"lastUpdated": "string",
"createdDate": "string",
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"tenantId": "string",
"orderIndex": 0,
"id": "string"
}
object
dataType
Required
dataType
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
Constraints:
minLength: 0
maxLength: 2000
description
string
label
Optional
Constraints:
minLength: 0
maxLength: 255
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
object
permissibleValues
Optional
permissibleValues
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
204
Successfully updated Property Definition
Returns
ContextPropertyDefinition
of type(s)
*/*
"ContextPropertyDefinition Object"
object
dataType
Required
dataType
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
Constraints:
minLength: 0
maxLength: 2000
description
string
label
Optional
Constraints:
minLength: 0
maxLength: 255
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
object
permissibleValues
Optional
permissibleValues
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
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' https://{api_host}/properties-service/api/propertydefinitions/{id}
On This Page
Api Operations
POST
Create A Property Group
GET
Get Property Groups
POST
Get multiple Property Groups
GET
Get A Property Group
DELETE
Delete A Property Group
PUT
Create Or update A Property Group
POST
Create A Property Definition
GET
Get Property Definitions
POST
Get Multiple Property Definitions
POST
Get permissible values for A Property Definition
GET
Get Property Definition
DELETE
Delete A Property Definition
PUT
Create Or update A Property Definition