PUT FormTypes
Updates the given form type.
Request Information
URI Parameters
None.
Body Parameters
Form type to update
FormTypeName | 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": "3a4bad72-64d6-488b-bb72-6f8606771ae7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "fb75f421-1aaa-4923-b96f-3bdb1cc0970e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4cf07d27-8c86-469c-ab7e-b71a7644d55a", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:01:00.16141-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:01:00.16141-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "8249c361-0895-4062-855e-1853408ef224", "Section": { "FormTypeSectionId": "8810c55c-2e98-4fe9-b77e-2ad15f61886a", "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": "b9834eff-d560-43fd-acdb-98b686195f0b", "Name": "sample string 1" }, "Unit": { "UnitId": "b9b99069-15ce-46c3-9ed5-79edf1fe8264", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f0c86e47-5852-4c1c-86bb-7da3dbd0d2fb", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:01:00.16141-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bf1341c6-ae73-46c9-a1b6-444670bc59b4", "FieldId": "c11c58e5-13fb-4f8f-a900-069b1bc8d0fb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bf1341c6-ae73-46c9-a1b6-444670bc59b4", "FieldId": "c11c58e5-13fb-4f8f-a900-069b1bc8d0fb", "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": "8249c361-0895-4062-855e-1853408ef224", "Section": { "FormTypeSectionId": "8810c55c-2e98-4fe9-b77e-2ad15f61886a", "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": "b9834eff-d560-43fd-acdb-98b686195f0b", "Name": "sample string 1" }, "Unit": { "UnitId": "b9b99069-15ce-46c3-9ed5-79edf1fe8264", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f0c86e47-5852-4c1c-86bb-7da3dbd0d2fb", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:01:00.16141-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bf1341c6-ae73-46c9-a1b6-444670bc59b4", "FieldId": "c11c58e5-13fb-4f8f-a900-069b1bc8d0fb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bf1341c6-ae73-46c9-a1b6-444670bc59b4", "FieldId": "c11c58e5-13fb-4f8f-a900-069b1bc8d0fb", "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": "2121571c-36c6-4432-a942-db49e5d89ef6", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:01:00.16141-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": "b4ad99a4-4f00-4aa2-82de-9b3dc5176c4c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "ac1d8ab4-7167-40df-a197-db2e149a00ca", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0b30d0ef-89f5-48c4-983d-90f465091516", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:01:00.16141-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:01:00.16141-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "b52f1d68-fcdf-4d9c-8956-b8652e1f5282", "Section": { "FormTypeSectionId": "e66dc221-f510-4cca-a1b1-ec61e9f1a0ad", "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": "0cc65c53-ab05-40c9-8460-e61c3013d60d", "Name": "sample string 1" }, "Unit": { "UnitId": "fe43015b-9af5-424f-8e3a-7981d0b04293", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "06ac458c-7ec9-47b2-8c6c-b08577b70895", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:01:00.16141-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a38ec45e-19e1-4d26-92eb-2f0dbc5e1091", "FieldId": "ec8dd6db-1de4-4a4f-84ec-e8817de03353", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a38ec45e-19e1-4d26-92eb-2f0dbc5e1091", "FieldId": "ec8dd6db-1de4-4a4f-84ec-e8817de03353", "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": "b52f1d68-fcdf-4d9c-8956-b8652e1f5282", "Section": { "FormTypeSectionId": "e66dc221-f510-4cca-a1b1-ec61e9f1a0ad", "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": "0cc65c53-ab05-40c9-8460-e61c3013d60d", "Name": "sample string 1" }, "Unit": { "UnitId": "fe43015b-9af5-424f-8e3a-7981d0b04293", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "06ac458c-7ec9-47b2-8c6c-b08577b70895", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:01:00.16141-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a38ec45e-19e1-4d26-92eb-2f0dbc5e1091", "FieldId": "ec8dd6db-1de4-4a4f-84ec-e8817de03353", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a38ec45e-19e1-4d26-92eb-2f0dbc5e1091", "FieldId": "ec8dd6db-1de4-4a4f-84ec-e8817de03353", "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": "a6b4a84c-b6e3-4446-b6dd-86ec1ccf6208", "CreateDate": "2025-09-13T21:01:00.16141-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:01:00.16141-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }