Update Property Group Using PUT
Updates a property group
Request
URI
PUT
https://{api_host}/properties/api/property-groups/{propertyGroupId}
COPY
Path Parameters
string
propertyGroupId
Required
propertyGroupId
Query Parameters
string
apiVersion
Optional
The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
Request Body
PropertyGroup
of type(s)
application/json
Required
{
"createdAt": "string",
"createdBy": "string",
"description": "string",
"displayName": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"projectName": "string",
"properties": {
"properties": {
"$dynamicDefault": "string",
"$dynamicEnum": "string",
"const": {},
"default": {},
"description": "string",
"encrypted": false,
"enum": [
{}
],
"format": "string",
"items": "Property Object",
"maxItems": 0,
"maxLength": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minimum": 0,
"oneOf": [
"Property Object"
],
"pattern": "string",
"properties": {
"properties": "Property Object"
},
"readOnly": false,
"title": "string",
"type": "string"
}
},
"type": "string",
"updatedAt": "string",
"updatedBy": "string"
}
string As date-time
As date-time
createdAt
Optional
Created time
string
createdBy
Optional
Created by
string
description
Optional
Property group description
string
displayName
Optional
Property group display name
string
id
Optional
Object ID
string
name
Optional
Property group name
string
orgId
Optional
Org ID
string
projectId
Optional
Project ID
string
projectName
Optional
Project Name
object
properties
Optional
Properties
string
type
Optional
Property group type
Possible values are :
INPUT,
CONSTANT,
string As date-time
As date-time
updatedAt
Optional
Updated time
string
updatedBy
Optional
Updated by
Responses
200
OK
Returns
PropertyGroup
of type(s)
application/json
"PropertyGroup Object"
string As date-time
As date-time
createdAt
Optional
Created time
string
createdBy
Optional
Created by
string
description
Optional
Property group description
string
displayName
Optional
Property group display name
string
id
Optional
Object ID
string
name
Optional
Property group name
string
orgId
Optional
Org ID
string
projectId
Optional
Project ID
string
projectName
Optional
Project Name
object
properties
Optional
Properties
string
type
Optional
Property group type
Possible values are :
INPUT,
CONSTANT,
string As date-time
As date-time
updatedAt
Optional
Updated time
string
updatedBy
Optional
Updated by
400
Bad Request
Operation doesn't return any data structure
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Not Found
Operation doesn't return any data structure
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/properties/api/property-groups/{propertyGroupId}