[]
        
(Showing Draft Content)

CustomizeProperties

CustomizeProperties

[GET] /api/v1/customizeproperties

Get all the custom properties' information.

Response

Status Code: 200

Success

[POST] /api/v1/customizeproperties

Add a new custom property.

Request Schema

CustomizePropertyBizModel

Response

Status Code: 200

Success

[GET] /api/v1/customizeproperties/{id}

Get the specified custom property's information.

Parameters

Name Type Located In Description
idRequired string path The custom property id.

Response

Status Code: 200

Success

[DELETE] /api/v1/customizeproperties/{id}

Delete the specified custom property.

Parameters

Name Type Located In Description
idRequired string path The custom property id.

Response

Status Code: 200

Success

[PUT] /api/v1/customizeproperties/{id}

Update the specified custom property.

Parameters

Name Type Located In Description
idRequired string path The custom property id.

Request Schema

CustomizePropertyBizModel

Response

Status Code: 200

Success

[POST] /api/v1/customizeproperties/{id}/available-values-validation

Validate the available values of the specified custom property.

Parameters

Name Type Located In Description
idRequired string path The custom property id.

Request Schema

CheckAvailableValuesModel

Response

Status Code: 200

Success

Models

Ƭ CustomizePropertyBizModel

Name Type Description Example
idNullable string
nameNullable string
showInListNullable Boolean
allowUserEditNullable Boolean
multivaluedNullable Boolean
showInProfileNullable Boolean
availableValuesNullable Array<string>

Ƭ CheckAvailableValuesModel

Name Type Description Example
availableValuesNullable Array<string>