Get Property Definition

Get Property Definition

Retrieve a single Property Definition by its id. Searches the current tenant. If no tenant specific definition is found, searches within the global scope.

Request
URI
GET
https://{api_host}/properties-service/api/propertydefinitions/{id}
COPY
Path Parameters
string
id
Required

The id of the Property Definition

Responses
200

successful operation

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"
}
DataType
dataType
Required

dataType

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

PermissibleValueList
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


On This Page
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