CustomField

PATCH /ver2/CostomFieldService.svc/customFields/{customFieldIdOrName}

envianceSdk.customFields.updateCustomField

[
    "customfieldIDorName",
    {
        "caption": "Custom Field Caption",
        "captionLocalizations": [
            {
                "culture": "en-US",
                "value": "Caption US"
            },
            {
                "culture": "ru-RU",
                "value": "Caption RU"
            },
            {
                "culture": "zh-CN",
                "value": "Caption Chinese"
            },
            {
                "culture": "en-GB",
                "value": "Caption UK"
            },
            {
                "culture": "es-MX",
                "value": "Caption Spanish"
            }
        ],
        "dataType": "Number",
        "description": "Custom Field Description",
        "descriptionLocalizations": [
            {
                "culture": "en-US",
                "value": "Description (United States)"
            },
            {
                "culture": "ru-RU",
                "value": "Description  (Russia)"
            },
            {
                "culture": "zh-CN",
                "value": "Description (Chinese)"
            },
            {
                "culture": "en-GB",
                "value": "Description (United Kingdom)"
            },
            {
                "culture": "es-MX",
                "value": "Description Spanish"
            }
        ],
        "hyperlinkType": null,
        "isLinkedList": false,
        "isListValuesByTemplate": null,
        "isSensitiveData": true,
        "label": null,
        "listItems": [
            {
                "id": "175d915f-9d70-40fe-a87b-d4b87b8ef721",
                "value": "test",
                "valueLocalizations": [
                    {
                        "culture": "en-US",
                        "value": "test US"
                    },
                    {
                        "culture": "ru-RU",
                        "value": "test RU"
                    },
                    {
                        "culture": "zh-CN",
                        "value": "test Chinese"
                    },
                    {
                        "culture": "en-GB",
                        "value": "test UK"
                    },
                    {
                        "culture": "es-MX",
                        "value": "test Spanish"
                    }
                ]
            }
        ],
        "name": "Custom Field Name",
        "size": null,
        "trackValueHistory": false,
        "valueEntryMethod": "Dropdown List"
    },
    "onsuccess",
    "onerror"
]

Request

Path parameters

customFieldIdOrNamestring required

Headers

EnvApi-Systemidstring

Specify specific system to run instead of Home

EnvApi-Packageidstring

(optional) Clients application/package ID

EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring

Udfs of DateTime should use Iso

EnvApi-Udf-DateTime-ReadInUserTzstring

(obsolete) Udfs of DateTime type whould be in ReadInUserTz

EnvApi-Udf-Value-Invariantstring

(optional) Udfs - Force Non-Localized (invariant) values

EnvApi-Localization-Allstring

(optional) Extend objects with User-given Localizations

x-client-request-idstring

(optional) Client ID for double submit prevention

Request body

Response

not available

Changes

No recorded changes to this operation across all 1 revision of this API.