POST api/customfield/updatestatus
Update the System Status of custom field. i.e. Active or Deleted Processes this custom field API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The update custom field command data contract supplied with the request.
UpdateCustomFieldCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomFieldId |
The unique identifier of the related custom field resource. |
integer |
None. |
| SystemStatus |
The system status value. |
string |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"CustomFieldId": 1,
"SystemStatus": "sample string 2",
"Id": 3
}
Response Information
Resource Description
The response returned after the operation completes.
CustomFieldDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Type |
The type value. |
EnumDataContract |
None. |
| ControlType |
The control type value. |
EnumDataContract |
None. |
| Name |
The name value. |
string |
None. |
| Validator |
The validator value. |
string |
None. |
| Order |
The order value. |
integer |
None. |
| Options |
The collection of options. |
Collection of string |
None. |
| SystemStatus |
The system status value. |
EnumDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ControlType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Validator": "sample string 2",
"Order": 3,
"Options": [
"sample string 1",
"sample string 2"
],
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 4
}