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. |
|
| Active | boolean |
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": "6dfd49a9-56df-4f9e-af09-92d8413f2fd9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7d0df69d-1d47-4c2d-a541-91aff97982d7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "345aad52-0752-45d7-882a-1c3e82ae432b",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-09T04:58:20.8903444-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "fb6a099c-8dcd-4cb2-8c75-541a87cda2de",
"Section": {
"FormTypeSectionId": "bc4344da-5ee5-4c01-8f5a-a28bf8ddde2c",
"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": "b74e5d13-4fd4-4b53-bc9e-dd73f2404652",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6b87c10f-a222-4ac6-96d0-3dbf9f2eee47",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9e089736-c686-46dd-8d84-de4856150e98",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b2b02afa-92f5-4a81-9b00-7e8728c67136",
"FieldId": "696dbcf5-a4e9-4a35-b5a2-2ee47b637f69",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b2b02afa-92f5-4a81-9b00-7e8728c67136",
"FieldId": "696dbcf5-a4e9-4a35-b5a2-2ee47b637f69",
"FieldName": "sample string 1",
"FieldLabel": "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": "fb6a099c-8dcd-4cb2-8c75-541a87cda2de",
"Section": {
"FormTypeSectionId": "bc4344da-5ee5-4c01-8f5a-a28bf8ddde2c",
"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": "b74e5d13-4fd4-4b53-bc9e-dd73f2404652",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6b87c10f-a222-4ac6-96d0-3dbf9f2eee47",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9e089736-c686-46dd-8d84-de4856150e98",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b2b02afa-92f5-4a81-9b00-7e8728c67136",
"FieldId": "696dbcf5-a4e9-4a35-b5a2-2ee47b637f69",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b2b02afa-92f5-4a81-9b00-7e8728c67136",
"FieldId": "696dbcf5-a4e9-4a35-b5a2-2ee47b637f69",
"FieldName": "sample string 1",
"FieldLabel": "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 4",
"CompanyId": "b61327e4-78af-443b-9572-b56f739e3a5c",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 7"
}
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": "35ee6344-402e-4c8b-9881-d51cc14410ce",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "67beaa48-ac99-47d7-beb3-e040d9aa58c9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a1643c16-b3bd-4380-8e76-3aaab1783eec",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-09T04:58:20.8903444-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8fffa12e-b93a-45cf-bcdc-ed8e5a449cda",
"Section": {
"FormTypeSectionId": "996bd531-bd4c-4672-a35c-b3789b8e6ab4",
"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": "693badb5-77c6-4ac8-9e57-6e9713003015",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7c642cc8-7b4b-4c54-886e-5b04d305abd8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "90e936d5-01f2-43cf-8037-5c1c645c77f8",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0a46a88-89e2-4d18-876e-07ff52a95576",
"FieldId": "aeb74da8-d758-4d66-8af6-cc67b28eca00",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0a46a88-89e2-4d18-876e-07ff52a95576",
"FieldId": "aeb74da8-d758-4d66-8af6-cc67b28eca00",
"FieldName": "sample string 1",
"FieldLabel": "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": "8fffa12e-b93a-45cf-bcdc-ed8e5a449cda",
"Section": {
"FormTypeSectionId": "996bd531-bd4c-4672-a35c-b3789b8e6ab4",
"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": "693badb5-77c6-4ac8-9e57-6e9713003015",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7c642cc8-7b4b-4c54-886e-5b04d305abd8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "90e936d5-01f2-43cf-8037-5c1c645c77f8",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a0a46a88-89e2-4d18-876e-07ff52a95576",
"FieldId": "aeb74da8-d758-4d66-8af6-cc67b28eca00",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a0a46a88-89e2-4d18-876e-07ff52a95576",
"FieldId": "aeb74da8-d758-4d66-8af6-cc67b28eca00",
"FieldName": "sample string 1",
"FieldLabel": "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 4",
"CompanyId": "ea5d6f45-c3f3-4ea7-a03e-31f31148abec",
"CreateDate": "2026-04-09T04:58:20.8903444-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-09T04:58:20.8903444-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}