PUT /system-ms/udf-definition/v1/{udfType}/{udfId}

Perform the authentication and login to the API. For more information, see POST /auth/login.

Use PUT /system-ms/udf-definition/v1/{udfType}/{udfId} to send an HTTP PUT request.

Click Try it Out option.

Set the parameters as listed in the following table.

Parameter Name	Sample Value	Supported Value	Description
udfType	USERS	USERS, DEPARTMENTS	Indicates the type of the UDF definition. Note: This parameter is mandatory.
udfId	udfId	integer 32	Indicates the id of the UDF definition. Note: This parameter is mandatory.

Under Request body select application/json from drop-down list.

Enter the request body parameter values as follows:

{
  "udfId": 0,
  "udfType": "USERS",
  "udfDisplayName": "string",
  "udfCmgDisplayName": "string",
  "readonly": true,
  "advance": true,
  "udfCmgMiscNumber": "string",
  "udfFieldTypeName": "None",
  "udfAdDisplayName": "string"
}

The following table describes the request body parameters. <TBD: New>

Parameter Name	Sample Value	Description
>udfId	Integer (int32)	-
>udfType	String	- Options: USERS, DEPARTMENTS
>udfDisplayName	String	-
>udfCmgDisplayName	String	-
>readonly	Boolean	-
>advance	Boolean	-
>udfCmgMiscNumber	String	-
>udfFieldTypeName	String	- Options: None, STREET ADDRESS, ADDRESS 1, ADDRESS 2, ADDRESS 3, ADDRESS 4, AUTHORIZATION CODE, CAR LICENSE, CITY, CLASS_OF_SERVICE, COMPUSERVE ID, COMPUTER, COST CENTER, COUNTRY, DEPARTMENT, EMAIL, EMPLOYEE NUMBER, EMPLOYEE TYPE, EXTENSION TYPE, EXTENSION CATEGORY, EXCHANGE ID, FAX NUMBER, FIXED CHARGE, FOLIO NUMBER, GROUP ID, GUEST STATUS, HOME PHONE, INFORMATION 1, INFORMATION 2, INFORMATION_FILE, IP/FQDN ADDRESS, JOB TITLE, LANGUAGE, MARKUP CATEGORY, MEMO ID, MOBILE NUMBER, NAME, PAGER ID, PERSONAL MARKUP CATEGORY, PHONE, POSTAL CODE, PRINTER, ROOM, SECRETARY, STATE, TEXT, TIME_SYSTEM_CARD_NO, UNIQUE IDENTIFIER, UNIQUE ID, VOICE ANNOUNCEMENT FILE, VOICE SYSTEM MAIL BOX NUMBER, WWW HOME PAGE, USER ID, USER PASSWORD, ADDRESS, CONFIDENTIAL, OTHER HOME PHONE, OTHER MOBILE NUMBER, TELEPHONE NUMBER
>udfAdDisplayName	String	-

Click on Execute to generate the request URL.

Request URL:

https://<IP_Address>:<PORT>/system-ms/udf-definition/v1/USERS/1

The following table lists the expected responses.

Response Type	Value	Schema
Valid Response	200 OK	`{ "udfId": 0, "udfType": "USERS", "udfDisplayName": "string", "udfCmgDisplayName": "string", "readonly": true, "advance": true, "udfCmgMiscNumber": "string", "udfFieldTypeName": "None", "udfAdDisplayName": "string" }`
Error Response	400 Bad Request	Not applicable
	401 Authentication Failure	Not applicable
	403 Forbidden	Not applicable
	404 Not found	Not applicable