Gets a property by key
Permission level: read
GET /property/{propertyKey}
Operation id: PropertyService_GetProperty
Tags: PropertyService
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
propertyKey | string | Yes | The property to retrieve |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
includeGenerics | boolean | No | If true, include the generic properties under the requested key (if any). Default: false |
propertyCharacteristics.domain | string | No | The property is specific for this domain. Required = false |
propertyCharacteristics.parentDomain | string | No | The parent domain. Required = false |
propertyCharacteristics.parentPropertyKey | string | No | The parent property key. Required = false |
propertyCharacteristics.parentPropertyValue | string | No | The parent property value. Required = false |
propertyCharacteristics.parentScope | string | No | The parent scope. Required = false |
propertyCharacteristics.parentTenantId | string | No | The parent tenant id. Required = false |
propertyCharacteristics.scope | string | No | The property is specific for this scope. Required = false |
propertyCharacteristics.tenantId | string | No | The property is specific for this tenant. Required = false |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
property | object | No |
{
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"properties": {
"type": "object"
}
}
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}