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": "14e8bf78-86a2-4d4c-819a-8724d3fb9844",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3f53ebd7-53eb-4413-afc4-19c01fc88e9d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b2515fe0-7d57-45c7-9131-a14ec1a67279",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-19T14:36:11.1559986-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "b8c0f8c0-8035-4d89-89ee-098b689cd274",
"Section": {
"FormTypeSectionId": "20860e7f-76c3-45ce-91f4-df5ccf7913b0",
"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": "e846e00a-59f5-469d-8cae-119efc0e8f75",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7ed89e0e-3af3-4117-b997-935e2a2415f6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "252524d5-e736-4933-b807-b3105f5130b0",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "71fd1e06-b641-4eb4-8547-ba6b755c3d9a",
"FieldId": "02530dba-e2c1-4ca3-a5fd-5feda5b291c4",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "71fd1e06-b641-4eb4-8547-ba6b755c3d9a",
"FieldId": "02530dba-e2c1-4ca3-a5fd-5feda5b291c4",
"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": "b8c0f8c0-8035-4d89-89ee-098b689cd274",
"Section": {
"FormTypeSectionId": "20860e7f-76c3-45ce-91f4-df5ccf7913b0",
"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": "e846e00a-59f5-469d-8cae-119efc0e8f75",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7ed89e0e-3af3-4117-b997-935e2a2415f6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "252524d5-e736-4933-b807-b3105f5130b0",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "71fd1e06-b641-4eb4-8547-ba6b755c3d9a",
"FieldId": "02530dba-e2c1-4ca3-a5fd-5feda5b291c4",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "71fd1e06-b641-4eb4-8547-ba6b755c3d9a",
"FieldId": "02530dba-e2c1-4ca3-a5fd-5feda5b291c4",
"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": "9c81dd95-8879-488d-8ad3-1b49196c8df7",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08: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": "0db51f2f-f032-46c7-a9c5-82f0bac37772",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2c8bfd87-8bb7-44a8-9321-03efc693f939",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "99a84e68-7b02-4ed9-b9f4-f22c0bf9933d",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-19T14:36:11.1559986-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "1537c686-55be-463d-9193-1335717804f2",
"Section": {
"FormTypeSectionId": "fe23c149-4c45-4bd8-879f-08bd235ca1ba",
"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": "c5a4d05c-cdb2-4f49-baff-316e82392d40",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "95996c6c-7ef2-41f6-bdc2-868604d52c46",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "acf09367-1498-41fd-bc70-92fab8bc3e37",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7f03dc9e-523f-4710-844b-7a04880aca33",
"FieldId": "f4c32805-d8bf-45b0-98c5-2f18f551a700",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7f03dc9e-523f-4710-844b-7a04880aca33",
"FieldId": "f4c32805-d8bf-45b0-98c5-2f18f551a700",
"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": "1537c686-55be-463d-9193-1335717804f2",
"Section": {
"FormTypeSectionId": "fe23c149-4c45-4bd8-879f-08bd235ca1ba",
"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": "c5a4d05c-cdb2-4f49-baff-316e82392d40",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "95996c6c-7ef2-41f6-bdc2-868604d52c46",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "acf09367-1498-41fd-bc70-92fab8bc3e37",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7f03dc9e-523f-4710-844b-7a04880aca33",
"FieldId": "f4c32805-d8bf-45b0-98c5-2f18f551a700",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7f03dc9e-523f-4710-844b-7a04880aca33",
"FieldId": "f4c32805-d8bf-45b0-98c5-2f18f551a700",
"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": "9defa1f7-68a4-4703-b144-ba42d423faea",
"CreateDate": "2026-11-19T14:36:11.1559986-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-19T14:36:11.1559986-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}