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": "b6aefac1-07e6-4a6b-bd77-4a65b2a542a5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "13ea5390-4263-429e-859c-5a12c63e7c44",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6706474c-0805-42a6-844d-d62c2694d1cc",
"CreateDate": "2025-10-24T10:42:29.9073757-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-24T10:42:29.9073757-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-10-24T10:42:29.9073757-07:00",
"Fields": [
{
"FormTypeFieldId": "ba7bdea3-dd6b-4f56-b649-0aa3f4e53494",
"Section": {
"FormTypeSectionId": "c5659fe5-f170-42b3-95d9-0d39b8973fab",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "e15e88d9-7c7f-4195-8a4b-292097c46c62",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc3b1ef3-8ee3-42bc-8760-93e5f5833cf4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ca3bfb30-fc88-419e-a059-d2a039b29220",
"CreateDate": "2025-10-24T10:42:29.9073757-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-24T10:42:29.9073757-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d424be42-d08a-49c6-bce5-83f99684576e",
"FieldId": "de0d015a-fc9f-45cb-9a45-18caed4f2334",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d424be42-d08a-49c6-bce5-83f99684576e",
"FieldId": "de0d015a-fc9f-45cb-9a45-18caed4f2334",
"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",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "ba7bdea3-dd6b-4f56-b649-0aa3f4e53494",
"Section": {
"FormTypeSectionId": "c5659fe5-f170-42b3-95d9-0d39b8973fab",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "e15e88d9-7c7f-4195-8a4b-292097c46c62",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "bc3b1ef3-8ee3-42bc-8760-93e5f5833cf4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ca3bfb30-fc88-419e-a059-d2a039b29220",
"CreateDate": "2025-10-24T10:42:29.9073757-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-24T10:42:29.9073757-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d424be42-d08a-49c6-bce5-83f99684576e",
"FieldId": "de0d015a-fc9f-45cb-9a45-18caed4f2334",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d424be42-d08a-49c6-bce5-83f99684576e",
"FieldId": "de0d015a-fc9f-45cb-9a45-18caed4f2334",
"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",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "e8c16620-46cd-4af8-a662-209b84bd8cd7",
"CreateDate": "2025-10-24T10:42:29.9073757-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-24T10:42:29.9073757-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": "e3a5b8fa-65d3-4c18-8c26-e4d2d6c6a8de",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "685f67d5-7c7e-4b32-a43e-7a9959b5de01",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e0568f1f-8a40-49fd-b8a6-fe15955d36ad",
"CreateDate": "2025-10-24T10:42:29.9543112-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-24T10:42:29.9543112-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-10-24T10:42:29.9543112-07:00",
"Fields": [
{
"FormTypeFieldId": "47afcf68-5605-47eb-9d04-b25b59adc7f1",
"Section": {
"FormTypeSectionId": "0eb29e0d-9fff-4911-84c2-f9dc2a98a18d",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "07369030-dd44-4355-a86b-8733400d0e2b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "474c7cbb-d1a9-42a0-aa8c-07877d6794f0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b1c83ddc-7270-41c9-9981-3844a94be4b3",
"CreateDate": "2025-10-24T10:42:29.9543112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-24T10:42:29.9543112-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b218f1c5-56af-421a-8754-a7f4dff45b3b",
"FieldId": "3eba56e6-8fe9-432f-ac7d-fc950757ed3e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b218f1c5-56af-421a-8754-a7f4dff45b3b",
"FieldId": "3eba56e6-8fe9-432f-ac7d-fc950757ed3e",
"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",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "47afcf68-5605-47eb-9d04-b25b59adc7f1",
"Section": {
"FormTypeSectionId": "0eb29e0d-9fff-4911-84c2-f9dc2a98a18d",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "07369030-dd44-4355-a86b-8733400d0e2b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "474c7cbb-d1a9-42a0-aa8c-07877d6794f0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b1c83ddc-7270-41c9-9981-3844a94be4b3",
"CreateDate": "2025-10-24T10:42:29.9543112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-24T10:42:29.9543112-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b218f1c5-56af-421a-8754-a7f4dff45b3b",
"FieldId": "3eba56e6-8fe9-432f-ac7d-fc950757ed3e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b218f1c5-56af-421a-8754-a7f4dff45b3b",
"FieldId": "3eba56e6-8fe9-432f-ac7d-fc950757ed3e",
"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",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "c8a7d91f-2dbb-40bf-bbec-b64ef439e2be",
"CreateDate": "2025-10-24T10:42:29.9543112-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-24T10:42:29.9543112-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}