PUT FormTypes
Updates the given form type.
Request Information
URI Parameters
None.
Body Parameters
Form type to update
FormType| Name | Description | Type | Additional information |
|---|---|---|---|
| FormTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| AssetType | AssetType |
None. |
|
| FrequencyNeeded | integer |
None. |
|
| ValueNeededDate | date |
None. |
|
| Fields | Collection of FormTypeField |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"FormTypeId": "a1bece82-055e-4728-b999-f4018d806260",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a932b7e8-f431-44dd-b147-7433fbb278e9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c7b6984a-5ddf-466e-9633-34c94372762a",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-23T05:39:54.0996718-07:00",
"Fields": [
{
"FormTypeFieldId": "7f06e002-10ea-46f4-af4b-505251387eab",
"Section": {
"FormTypeSectionId": "098727bc-8f80-4547-bc5b-25b3feab7a40",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "47a17623-e45f-4264-bca8-fb13c478d32c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b866bf4-8d5a-4e3c-927e-69bcc5ad1d34",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "800deb38-1dd5-4026-81c8-58315cee0e62",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "14b15922-b50f-42df-8874-2dc916976b21",
"FieldId": "1c73e151-58a4-4f19-8300-2f3ad4ee9c5e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "14b15922-b50f-42df-8874-2dc916976b21",
"FieldId": "1c73e151-58a4-4f19-8300-2f3ad4ee9c5e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "7f06e002-10ea-46f4-af4b-505251387eab",
"Section": {
"FormTypeSectionId": "098727bc-8f80-4547-bc5b-25b3feab7a40",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "47a17623-e45f-4264-bca8-fb13c478d32c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7b866bf4-8d5a-4e3c-927e-69bcc5ad1d34",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "800deb38-1dd5-4026-81c8-58315cee0e62",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "14b15922-b50f-42df-8874-2dc916976b21",
"FieldId": "1c73e151-58a4-4f19-8300-2f3ad4ee9c5e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "14b15922-b50f-42df-8874-2dc916976b21",
"FieldId": "1c73e151-58a4-4f19-8300-2f3ad4ee9c5e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "5667404a-d0f1-41a9-b877-77a2abc4c9ff",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 6"
}
Response Information
Resource Description
On success, the updated form type.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | FormType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormTypeId": "60ef0b5e-46d9-4bf4-8713-e8890b500191",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "51e737d3-50c9-419b-be9c-4ae02e55c22e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9b7aef06-61d7-47a6-9351-85532833303f",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-23T05:39:54.0996718-07:00",
"Fields": [
{
"FormTypeFieldId": "1add3560-6bd8-4db3-adcf-c2cf682cb2ef",
"Section": {
"FormTypeSectionId": "c8d51429-f5d5-4ae9-9f0b-8b510d28aac0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "544e4c6e-648d-406e-b169-6d3ff7471efb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cb45049d-5c4d-4b1c-8d22-a9227f12a2f0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2b5b74ef-8d6f-45fe-a99e-baecb91ac4df",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "07106b37-35fc-4b52-a53f-cc287cf475e9",
"FieldId": "8316a5a3-d710-4162-ba84-fccb993ee5f9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "07106b37-35fc-4b52-a53f-cc287cf475e9",
"FieldId": "8316a5a3-d710-4162-ba84-fccb993ee5f9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "1add3560-6bd8-4db3-adcf-c2cf682cb2ef",
"Section": {
"FormTypeSectionId": "c8d51429-f5d5-4ae9-9f0b-8b510d28aac0",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "544e4c6e-648d-406e-b169-6d3ff7471efb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cb45049d-5c4d-4b1c-8d22-a9227f12a2f0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2b5b74ef-8d6f-45fe-a99e-baecb91ac4df",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "07106b37-35fc-4b52-a53f-cc287cf475e9",
"FieldId": "8316a5a3-d710-4162-ba84-fccb993ee5f9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "07106b37-35fc-4b52-a53f-cc287cf475e9",
"FieldId": "8316a5a3-d710-4162-ba84-fccb993ee5f9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "0a57ffcf-a435-48dc-b611-272535dbbef5",
"CreateDate": "2026-10-23T05:39:54.0996718-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-23T05:39:54.0996718-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}