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": "acaa1b19-67d8-45f3-a223-f1c201ccefbd",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5c3e72f7-14ea-4b0b-beb8-65337c304d73",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0edcecc6-f187-4ac6-b251-a09fa5d993bd",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T17:26:14.049794-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-27T17:26:14.049794-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "68674893-0361-4466-b145-84d9149f3f26",
"Section": {
"FormTypeSectionId": "0304e619-ae42-4bb5-94aa-98ed491e7339",
"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": "409ae469-8e37-4060-aebf-0feafcb19a2a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "25cbb21e-045b-4a1b-a3b0-04e195201c67",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d7f9eacf-f219-41bf-bf93-7c4f85bdf987",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T17:26:14.049794-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4110b91e-de5e-4486-99b3-d1733eb73c97",
"FieldId": "37c744db-293c-4da8-985a-1cbcc83a9265",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4110b91e-de5e-4486-99b3-d1733eb73c97",
"FieldId": "37c744db-293c-4da8-985a-1cbcc83a9265",
"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": "68674893-0361-4466-b145-84d9149f3f26",
"Section": {
"FormTypeSectionId": "0304e619-ae42-4bb5-94aa-98ed491e7339",
"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": "409ae469-8e37-4060-aebf-0feafcb19a2a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "25cbb21e-045b-4a1b-a3b0-04e195201c67",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d7f9eacf-f219-41bf-bf93-7c4f85bdf987",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T17:26:14.049794-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4110b91e-de5e-4486-99b3-d1733eb73c97",
"FieldId": "37c744db-293c-4da8-985a-1cbcc83a9265",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4110b91e-de5e-4486-99b3-d1733eb73c97",
"FieldId": "37c744db-293c-4da8-985a-1cbcc83a9265",
"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": "6b126e8c-5033-437c-a4b8-e9a5351a7e77",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T17:26:14.049794-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": "2aad6eac-8e54-491e-ac00-34860b02d585",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "25704e10-5741-4a74-bed1-2938ae24172b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bc1b50bc-1831-4066-9223-a638d03c4e0c",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T17:26:14.049794-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-27T17:26:14.049794-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "fb182f9e-2101-4956-9df0-dc1b76219bd8",
"Section": {
"FormTypeSectionId": "3598a590-2b01-4f2e-8bfc-a7b0b6fc4aa0",
"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": "6fdaadd3-b490-4e30-ab80-e781448b821c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0880a959-0e87-4d92-872c-d3f8abee59c1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e990168-2ade-4cca-a945-01af108948f8",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T17:26:14.049794-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0567cbee-f372-4281-9b24-7fb482b02a88",
"FieldId": "777707cf-a2bd-4fbc-994c-e22d3174b5d5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0567cbee-f372-4281-9b24-7fb482b02a88",
"FieldId": "777707cf-a2bd-4fbc-994c-e22d3174b5d5",
"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": "fb182f9e-2101-4956-9df0-dc1b76219bd8",
"Section": {
"FormTypeSectionId": "3598a590-2b01-4f2e-8bfc-a7b0b6fc4aa0",
"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": "6fdaadd3-b490-4e30-ab80-e781448b821c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "0880a959-0e87-4d92-872c-d3f8abee59c1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e990168-2ade-4cca-a945-01af108948f8",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T17:26:14.049794-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0567cbee-f372-4281-9b24-7fb482b02a88",
"FieldId": "777707cf-a2bd-4fbc-994c-e22d3174b5d5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0567cbee-f372-4281-9b24-7fb482b02a88",
"FieldId": "777707cf-a2bd-4fbc-994c-e22d3174b5d5",
"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": "9111517c-bc77-4f77-90ca-9737a4c38b83",
"CreateDate": "2026-10-27T17:26:14.049794-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T17:26:14.049794-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}