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": "c50a9c5a-7c6b-41a4-b321-b0437984a96b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ec5236e8-5b9d-417f-9e76-1809dff495ca",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f720f6ce-2195-4fb6-9989-49e150039a67",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-07T11:32:24.4268946-08:00",
"Fields": [
{
"FormTypeFieldId": "a8a15e40-6317-4e7a-9957-a7ee0f3d5ae9",
"Section": {
"FormTypeSectionId": "f7847b54-7eab-485c-8e15-a71f7bf29164",
"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": "c1f419a0-fa81-469c-be73-6ddb6567eeda",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fc18b484-1f4a-4e5b-a390-1fc76e69676a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "44a60a3a-a24d-48b0-a7a5-2ef1db25d8fb",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ee571ef-48ff-4c7a-8bd4-bf69039c9708",
"FieldId": "3939a61e-a93f-4ec2-8561-5805423fec2f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ee571ef-48ff-4c7a-8bd4-bf69039c9708",
"FieldId": "3939a61e-a93f-4ec2-8561-5805423fec2f",
"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": "a8a15e40-6317-4e7a-9957-a7ee0f3d5ae9",
"Section": {
"FormTypeSectionId": "f7847b54-7eab-485c-8e15-a71f7bf29164",
"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": "c1f419a0-fa81-469c-be73-6ddb6567eeda",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fc18b484-1f4a-4e5b-a390-1fc76e69676a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "44a60a3a-a24d-48b0-a7a5-2ef1db25d8fb",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7ee571ef-48ff-4c7a-8bd4-bf69039c9708",
"FieldId": "3939a61e-a93f-4ec2-8561-5805423fec2f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7ee571ef-48ff-4c7a-8bd4-bf69039c9708",
"FieldId": "3939a61e-a93f-4ec2-8561-5805423fec2f",
"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": "7dce7393-73cf-443c-bd2e-025bb04165b5",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08: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": "3f8eac80-a700-45ec-b70f-bf9eded6e102",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f13206b4-3d95-4991-b7d3-1569281a4766",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "226e3630-0c46-4411-a285-dec06cca66ec",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-07T11:32:24.4268946-08:00",
"Fields": [
{
"FormTypeFieldId": "46b8f40d-738c-4480-be85-cd8fb10b8e63",
"Section": {
"FormTypeSectionId": "ae431cdf-f1c7-41f8-bbe1-81bae1d22e39",
"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": "407174cf-d1ce-45d2-a360-120eb6a8dcb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4b9a5e76-e000-4214-9370-68efea86511d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dbc05ab2-1f0b-47a0-a804-610d282a1d2b",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6976c97b-bc1b-41cb-828d-9a452296a761",
"FieldId": "1808e174-284a-49c3-a9d2-c749de19c539",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6976c97b-bc1b-41cb-828d-9a452296a761",
"FieldId": "1808e174-284a-49c3-a9d2-c749de19c539",
"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": "46b8f40d-738c-4480-be85-cd8fb10b8e63",
"Section": {
"FormTypeSectionId": "ae431cdf-f1c7-41f8-bbe1-81bae1d22e39",
"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": "407174cf-d1ce-45d2-a360-120eb6a8dcb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4b9a5e76-e000-4214-9370-68efea86511d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dbc05ab2-1f0b-47a0-a804-610d282a1d2b",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6976c97b-bc1b-41cb-828d-9a452296a761",
"FieldId": "1808e174-284a-49c3-a9d2-c749de19c539",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6976c97b-bc1b-41cb-828d-9a452296a761",
"FieldId": "1808e174-284a-49c3-a9d2-c749de19c539",
"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": "74301b8c-8ace-48ec-8015-2749b855866c",
"CreateDate": "2026-03-07T11:32:24.4268946-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:32:24.4268946-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}