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": "6f41c806-6dc1-47e0-9ec9-82a15e3be0cd",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b08f52cf-90fd-415f-a452-57735f280122",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e0b84fec-f798-4066-af2b-5e71abc48227",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:10.415101-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-26T13:57:10.415101-07:00",
"Fields": [
{
"FormTypeFieldId": "1c05c0e9-52a8-49ce-9ed2-c2d0a1305c1e",
"Section": {
"FormTypeSectionId": "515cd0f0-714a-4a03-a896-f054964330fe",
"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": "b179ea2c-611a-45eb-bd8d-796afcc03c91",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "15badded-46a7-41a8-a688-ad8ff0fcab9c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c3933590-821f-4281-a227-7f09c562e3cd",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:10.415101-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f70fb143-8b6f-4a39-a290-b2904c641d8c",
"FieldId": "400f7569-dbf4-422d-8e4c-a82c35ac47a4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f70fb143-8b6f-4a39-a290-b2904c641d8c",
"FieldId": "400f7569-dbf4-422d-8e4c-a82c35ac47a4",
"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": "1c05c0e9-52a8-49ce-9ed2-c2d0a1305c1e",
"Section": {
"FormTypeSectionId": "515cd0f0-714a-4a03-a896-f054964330fe",
"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": "b179ea2c-611a-45eb-bd8d-796afcc03c91",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "15badded-46a7-41a8-a688-ad8ff0fcab9c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c3933590-821f-4281-a227-7f09c562e3cd",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:10.415101-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f70fb143-8b6f-4a39-a290-b2904c641d8c",
"FieldId": "400f7569-dbf4-422d-8e4c-a82c35ac47a4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f70fb143-8b6f-4a39-a290-b2904c641d8c",
"FieldId": "400f7569-dbf4-422d-8e4c-a82c35ac47a4",
"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": "f6813fbd-1c86-443d-8699-a0991af335b8",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:10.415101-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": "bb38774e-b965-481e-afe1-c6b5db756f13",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0e8f8244-a587-437b-8c8b-6209985413ad",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7853c820-89d8-4e1c-adfd-ac0c41dac54d",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:10.415101-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-26T13:57:10.415101-07:00",
"Fields": [
{
"FormTypeFieldId": "608de27f-6d8e-4222-909c-d4281c5f71c7",
"Section": {
"FormTypeSectionId": "a23a0d70-e1a3-4efb-a9d8-26261557427f",
"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": "2411eabe-d9f7-475a-b5b7-bf0b95b25ecb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34deefcd-995a-4a00-ba13-c9a18f17f935",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "209be6ea-4ad7-4818-9e11-798d5ba4f449",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:10.415101-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e683d102-ff74-441e-8fa6-d15c39e398ce",
"FieldId": "6b2ca4bd-d353-4df9-8c4a-cc5377df6dc8",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e683d102-ff74-441e-8fa6-d15c39e398ce",
"FieldId": "6b2ca4bd-d353-4df9-8c4a-cc5377df6dc8",
"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": "608de27f-6d8e-4222-909c-d4281c5f71c7",
"Section": {
"FormTypeSectionId": "a23a0d70-e1a3-4efb-a9d8-26261557427f",
"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": "2411eabe-d9f7-475a-b5b7-bf0b95b25ecb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34deefcd-995a-4a00-ba13-c9a18f17f935",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "209be6ea-4ad7-4818-9e11-798d5ba4f449",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:10.415101-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e683d102-ff74-441e-8fa6-d15c39e398ce",
"FieldId": "6b2ca4bd-d353-4df9-8c4a-cc5377df6dc8",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e683d102-ff74-441e-8fa6-d15c39e398ce",
"FieldId": "6b2ca4bd-d353-4df9-8c4a-cc5377df6dc8",
"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": "f400ca15-ebcb-48a8-8400-fab3f25a9bba",
"CreateDate": "2026-09-26T13:57:10.415101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:10.415101-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}