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": "a3ec610a-a8f8-485d-8a80-0443870fc003", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "62105467-2488-4370-84c1-326985a1878c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f1c0a416-766c-4042-80c9-2ae5970f6d82", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-14T22:02:55.140665-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-14T22:02:55.140665-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "5da6c598-389b-47d6-962c-2f9daa4b9ada", "Section": { "FormTypeSectionId": "8f85c54f-254e-49ce-b37f-74e734fb6a01", "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": "5c2066d6-51ed-41eb-b317-a3b14fa9895d", "Name": "sample string 1" }, "Unit": { "UnitId": "5d7e3242-7ef0-4eb5-9b73-bb134609e022", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b652c373-abfd-45c5-a49e-10d3063cb31a", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-14T22:02:55.140665-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5d6790f1-5adb-4caf-8664-2b21dba4d01d", "FieldId": "8dd49706-846e-4057-be94-71b5d8cbe1d4", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5d6790f1-5adb-4caf-8664-2b21dba4d01d", "FieldId": "8dd49706-846e-4057-be94-71b5d8cbe1d4", "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": "5da6c598-389b-47d6-962c-2f9daa4b9ada", "Section": { "FormTypeSectionId": "8f85c54f-254e-49ce-b37f-74e734fb6a01", "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": "5c2066d6-51ed-41eb-b317-a3b14fa9895d", "Name": "sample string 1" }, "Unit": { "UnitId": "5d7e3242-7ef0-4eb5-9b73-bb134609e022", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b652c373-abfd-45c5-a49e-10d3063cb31a", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-14T22:02:55.140665-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5d6790f1-5adb-4caf-8664-2b21dba4d01d", "FieldId": "8dd49706-846e-4057-be94-71b5d8cbe1d4", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5d6790f1-5adb-4caf-8664-2b21dba4d01d", "FieldId": "8dd49706-846e-4057-be94-71b5d8cbe1d4", "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": "48abffce-d596-49be-9235-67c6af183b8a", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-14T22:02:55.140665-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": "22391909-eb97-44bf-a485-5af3ebfd2793", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6b80ca3b-abc6-4785-901d-f42f810fd85c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7505d673-dfe0-4ab8-b10b-f8df9dffbec5", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-14T22:02:55.140665-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-14T22:02:55.140665-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "95260106-f706-4d5b-9102-9b7f4ffdb595", "Section": { "FormTypeSectionId": "c59e8b66-cde6-477d-b4b3-8e851af5bc0e", "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": "499dd78c-f7c0-4825-a801-2a17b955dcfd", "Name": "sample string 1" }, "Unit": { "UnitId": "1d1b8853-cf11-4356-8caf-121b751c5354", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bb7c2d28-4fde-46bb-96e5-9ccd56d1afcd", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-14T22:02:55.140665-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a648fab4-6be3-49bb-a8bc-b4af491ecc73", "FieldId": "ce5a3abc-e062-4c53-a54a-4f8ae537015b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a648fab4-6be3-49bb-a8bc-b4af491ecc73", "FieldId": "ce5a3abc-e062-4c53-a54a-4f8ae537015b", "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": "95260106-f706-4d5b-9102-9b7f4ffdb595", "Section": { "FormTypeSectionId": "c59e8b66-cde6-477d-b4b3-8e851af5bc0e", "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": "499dd78c-f7c0-4825-a801-2a17b955dcfd", "Name": "sample string 1" }, "Unit": { "UnitId": "1d1b8853-cf11-4356-8caf-121b751c5354", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bb7c2d28-4fde-46bb-96e5-9ccd56d1afcd", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-14T22:02:55.140665-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a648fab4-6be3-49bb-a8bc-b4af491ecc73", "FieldId": "ce5a3abc-e062-4c53-a54a-4f8ae537015b", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a648fab4-6be3-49bb-a8bc-b4af491ecc73", "FieldId": "ce5a3abc-e062-4c53-a54a-4f8ae537015b", "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": "4e0aaed3-3889-4f6d-a4cc-d5fdf95b6d73", "CreateDate": "2025-10-14T22:02:55.140665-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-14T22:02:55.140665-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }