ExtendedPropertyApiV1

[POST] /Manager/ExtendedProperty/AddExtendedProperty

添加自定义属性。

Request Body

Type: application/json-patch+json

AddExtendedPropertyParam

Example:

{
  "PropertyName": "Address",
  "PropertyType": "Text"
}

Type: application/json

AddExtendedPropertyParam

Example:

{
  "PropertyName": "Address",
  "PropertyType": "Text"
}

Type: text/json

AddExtendedPropertyParam

Example:

{
  "PropertyName": "Address",
  "PropertyType": "Text"
}

Type: application/*+json

AddExtendedPropertyParam

Example:

{
  "PropertyName": "Address",
  "PropertyType": "Text"
}

Responses

[200] OK

ResultDataBase

Type: [text/plain]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

ResultDataBase

Type: [application/json]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

ResultDataBase

Type: [text/json]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

[POST] /Manager/ExtendedProperty/UpdateExtendedPropertyName

更新自定义属性。

Request Body

Type: application/json-patch+json

UpdateExtendedPropertyNameParam

Example:

{
  "OldPropertyName": "Address",
  "NewPropertyName": "Hometown"
}

Type: application/json

UpdateExtendedPropertyNameParam

Example:

{
  "OldPropertyName": "Address",
  "NewPropertyName": "Hometown"
}

Type: text/json

UpdateExtendedPropertyNameParam

Example:

{
  "OldPropertyName": "Address",
  "NewPropertyName": "Hometown"
}

Type: application/*+json

UpdateExtendedPropertyNameParam

Example:

{
  "OldPropertyName": "Address",
  "NewPropertyName": "Hometown"
}

Responses

[200] OK

ResultDataBase

Type: [text/plain]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

ResultDataBase

Type: [application/json]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

ResultDataBase

Type: [text/json]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

[POST] /Manager/ExtendedProperty/DeleteExtendedProperty

删除自定义属性。

Request Body

Type: application/json-patch+json

PropertyNameParam

Example:

{
  "PropertyName": "Address"
}

Type: application/json

PropertyNameParam

Example:

{
  "PropertyName": "Address"
}

Type: text/json

PropertyNameParam

Example:

{
  "PropertyName": "Address"
}

Type: application/*+json

PropertyNameParam

Example:

{
  "PropertyName": "Address"
}

Responses

[200] OK

ResultDataBase

Type: [text/plain]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

ResultDataBase

Type: [application/json]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

ResultDataBase

Type: [text/json]

Example:

{
  "Result": false,
  "Message": "Error message.",
  "ErrorCode": 0,
  "MessageProperties": null
}

[GET] /Manager/ExtendedProperty/GetExtendedProperties

获取自定义属性列表。

Responses

[200] OK

ExtendedPropertiesResultData

Type: [text/plain]

Example:

{
  "ExtendedProperties": [
    {
      "PropertyName": "Mentor",
      "PropertyType": "User"
    },
    {
      "PropertyName": "Address",
      "PropertyType": "Text"
    }
  ],
  "Result": true,
  "Message": null,
  "ErrorCode": 0,
  "MessageProperties": null
}

ExtendedPropertiesResultData

Type: [application/json]

Example:

{
  "ExtendedProperties": [
    {
      "PropertyName": "Mentor",
      "PropertyType": "User"
    },
    {
      "PropertyName": "Address",
      "PropertyType": "Text"
    }
  ],
  "Result": true,
  "Message": null,
  "ErrorCode": 0,
  "MessageProperties": null
}

ExtendedPropertiesResultData

Type: [text/json]

Example:

{
  "ExtendedProperties": [
    {
      "PropertyName": "Mentor",
      "PropertyType": "User"
    },
    {
      "PropertyName": "Address",
      "PropertyType": "Text"
    }
  ],
  "Result": true,
  "Message": null,
  "ErrorCode": 0,
  "MessageProperties": null
}

Models

Ƭ ResultDataBase

请求结果。

属性名	类型	说明	Example
Result	Boolean	请求是否成功。
MessageNullable	string	请求返回的信息。
ErrorCode	int32	请求返回的错误码。
MessagePropertiesNullable	Array	请求返回信息中的数据。

Ƭ AddExtendedPropertyParam

添加自定义属性请求中使用的参数。

属性名	类型	说明	Example
PropertyNameNullable	string	属性名称。
PropertyTypeNullable	string	属性类型。

Ƭ UpdateExtendedPropertyNameParam

更新自定义属性请求中使用的参数。

属性名	类型	说明	Example
OldPropertyNameNullable	string	旧的属性名称。
NewPropertyNameNullable	string	新的属性名称。

Ƭ PropertyNameParam

自定义属性请求中使用的参数。

属性名	类型	说明	Example
PropertyNameNullable	string	属性名称。

Ƭ ExtendedPropertiesResultData

请求返回的自定义属性列表。

属性名	类型	说明	Example
ExtendedPropertiesNullable	Array<PropertyInfoForUser>	z自定义属性列表。
Result	Boolean	请求是否成功。
MessageNullable	string	请求返回的信息。
ErrorCode	int32	请求返回的错误码。
MessagePropertiesNullable	Array	请求返回信息中的数据。

Ƭ PropertyInfoForUser

扩展属性的信息。

属性名	类型	说明	Example
PropertyNameNullable	string	属性名。
PropertyTypeNullable	string	属性类型。