[]
(Showing Draft Content)

CustomizeProperties

CustomizeProperties

[GET] /api/v1/customizeproperties

Get all customize properties.

Responses

[200] Success

[POST] /api/v1/customizeproperties

Add a new customize property.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

CustomizePropertyBizModel

Responses

[200] Success

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

Parameters

Name In Type
idRequired path string

Get the specified customize property's information.

Responses

[200] Success

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

Parameters

Name In Type
idRequired path string

Delete the specified customize property.

Responses

[200] Success

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

Parameters

Name In Type
idRequired path string

Update the specified customize property's information.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

CustomizePropertyBizModel

Responses

[200] Success

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

Parameters

Name In Type
idRequired path string

Validate the new available values for the specified customize property.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

CheckAvailableValuesModel

Responses

[200] Success

Models

Ƭ CustomizePropertyBizModel

Name Type
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
availableValuesNullable Array<string>