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": "6336cc8f-6718-4295-991e-798c6af9b819",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0cd542d3-c355-4686-a3a6-7b683bdd46d8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1727c3c9-eecd-4883-ab75-ed86946ff747",
"CreateDate": "2026-10-12T10:16:34.5116599-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:16:34.5116599-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-12T10:16:34.5116599-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "aabc3510-36ef-45a6-b314-66d20058c860",
"Section": {
"FormTypeSectionId": "347544b6-354b-4e39-b1b3-998b70e071a1",
"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": "132f33b2-043c-40b4-9bf5-aff58ed1d806",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fe418cde-0a6e-437d-8bb0-4213a0979486",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "18882291-67bf-458e-a3c1-afe40c73abe5",
"CreateDate": "2026-10-12T10:16:34.5272855-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:16:34.5272855-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c8892d0e-7772-4bd0-b02d-50f33332aa0c",
"FieldId": "55a929d7-f5e8-4fb8-9500-1eef3ceca8d3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c8892d0e-7772-4bd0-b02d-50f33332aa0c",
"FieldId": "55a929d7-f5e8-4fb8-9500-1eef3ceca8d3",
"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": "aabc3510-36ef-45a6-b314-66d20058c860",
"Section": {
"FormTypeSectionId": "347544b6-354b-4e39-b1b3-998b70e071a1",
"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": "132f33b2-043c-40b4-9bf5-aff58ed1d806",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fe418cde-0a6e-437d-8bb0-4213a0979486",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "18882291-67bf-458e-a3c1-afe40c73abe5",
"CreateDate": "2026-10-12T10:16:34.5272855-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:16:34.5272855-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c8892d0e-7772-4bd0-b02d-50f33332aa0c",
"FieldId": "55a929d7-f5e8-4fb8-9500-1eef3ceca8d3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c8892d0e-7772-4bd0-b02d-50f33332aa0c",
"FieldId": "55a929d7-f5e8-4fb8-9500-1eef3ceca8d3",
"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": "9893fc34-4d6c-429e-9f76-27fc5e6cef35",
"CreateDate": "2026-10-12T10:16:34.5272855-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:16:34.5272855-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": "8b138675-684d-4256-bd57-c84edd6fafe7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "99848346-e846-43be-a369-accf5d2d044d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d668de78-32a7-494a-bd5d-ff8218d42c2d",
"CreateDate": "2026-10-12T10:16:34.5272855-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:16:34.5272855-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-12T10:16:34.5272855-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "506691f6-6a0a-48ab-b1cb-04e305db9686",
"Section": {
"FormTypeSectionId": "146966f4-dfdd-492c-82f5-a31307b50c84",
"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": "1af769bf-5af0-41ff-a10b-1c4563005e12",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1162707c-bf95-43bf-b232-7365bc5f2381",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "55a12112-d531-4958-b1f9-7b9accbcec01",
"CreateDate": "2026-10-12T10:16:34.5272855-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:16:34.5272855-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f48b19d9-0645-4c79-ab07-a765ffd58b6b",
"FieldId": "bfe0a80e-eb66-4896-b3a9-6aa70ee73b76",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f48b19d9-0645-4c79-ab07-a765ffd58b6b",
"FieldId": "bfe0a80e-eb66-4896-b3a9-6aa70ee73b76",
"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": "506691f6-6a0a-48ab-b1cb-04e305db9686",
"Section": {
"FormTypeSectionId": "146966f4-dfdd-492c-82f5-a31307b50c84",
"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": "1af769bf-5af0-41ff-a10b-1c4563005e12",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1162707c-bf95-43bf-b232-7365bc5f2381",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "55a12112-d531-4958-b1f9-7b9accbcec01",
"CreateDate": "2026-10-12T10:16:34.5272855-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:16:34.5272855-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f48b19d9-0645-4c79-ab07-a765ffd58b6b",
"FieldId": "bfe0a80e-eb66-4896-b3a9-6aa70ee73b76",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f48b19d9-0645-4c79-ab07-a765ffd58b6b",
"FieldId": "bfe0a80e-eb66-4896-b3a9-6aa70ee73b76",
"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": "53703428-5fec-41f1-afbe-516684407c09",
"CreateDate": "2026-10-12T10:16:34.5272855-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:16:34.5272855-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}