POST api/customfieldgroup/{save}

Save a custom field group for a predefined type. Processes this custom field group API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
save		string	None.

Body Parameters

The save custom field group command data contract supplied with the request.

SaveCustomFieldGroupCommandDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Order	The order value.	integer	None.
AppliesTo	The applies to classification.	CustomFieldGroupType	None.
SystemStatus	The system status value.	EnumDataContract	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:

{
  "Name": "sample string 1",
  "Order": 2,
  "AppliesTo": 0,
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 3
}

Response Information

Resource Description

The response returned after the operation completes.

CustomFieldGroupDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Fields	The collection of fields.	Collection of CustomFieldDataContract	None.
Order	The order value.	integer	None.
SystemStatus	The system status value.	EnumDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Fields": [
    {
      "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
    },
    {
      "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
    }
  ],
  "Order": 2,
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 3
}