[]
(Showing Draft Content)

CustomizeProperties

CustomizeProperties

[GET] /api/v1/customizeproperties

Get all customize properties.

Response

Status Code: 200

Success

[POST] /api/v1/customizeproperties

Add a new customize property.

Request Schema

CustomizePropertyBizModel

Response

Status Code: 200

Success

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

Get the specified customize property's information.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

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

Delete the specified customize property.

Parameters

Name Type Located In Description
idRequired string path

Response

Status Code: 200

Success

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

Update the specified customize property's information.

Parameters

Name Type Located In Description
idRequired string path

Request Schema

CustomizePropertyBizModel

Response

Status Code: 200

Success

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

Validate the new available values for the specified customize property.

Parameters

Name Type Located In Description
idRequired string path

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>
valueType PropertyValueType
sensitiveNullable Boolean

Ƭ PropertyValueType

Enum:

  • Text
  • Boolean
  • Integer
  • Float
  • Date
  • DateTime

The value type of the organization property.

Ƭ CheckAvailableValuesModel

Name Type Description Example
availableValuesNullable Array<string>