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": "7e442cbf-46fe-467c-b6b1-d7a869c9e69e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d0122e05-1bb3-44a9-9414-144ce8119d64", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8396cc6a-2228-41d9-9225-63753579c9b7", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T18:16:44.4062139-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-01T18:16:44.4062139-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "11ed6342-d9b7-44cb-8759-5f251e4d8a11", "Section": { "FormTypeSectionId": "2121ef09-02df-4f6d-a7c6-71bfcf7a13fb", "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": "99123ec6-1d60-4159-8cff-e420a43a0579", "Name": "sample string 1" }, "Unit": { "UnitId": "6d105f15-1b7a-4ea1-ae9e-ae94c7970644", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "83cafab2-b08b-4d69-aea5-a5e0b9d4bbd7", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T18:16:44.4062139-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ef7d54ef-92d7-48fe-a427-4390650188df", "FieldId": "2e4cafe1-429e-4042-9d5d-590dfffb83e3", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ef7d54ef-92d7-48fe-a427-4390650188df", "FieldId": "2e4cafe1-429e-4042-9d5d-590dfffb83e3", "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": "11ed6342-d9b7-44cb-8759-5f251e4d8a11", "Section": { "FormTypeSectionId": "2121ef09-02df-4f6d-a7c6-71bfcf7a13fb", "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": "99123ec6-1d60-4159-8cff-e420a43a0579", "Name": "sample string 1" }, "Unit": { "UnitId": "6d105f15-1b7a-4ea1-ae9e-ae94c7970644", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "83cafab2-b08b-4d69-aea5-a5e0b9d4bbd7", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T18:16:44.4062139-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ef7d54ef-92d7-48fe-a427-4390650188df", "FieldId": "2e4cafe1-429e-4042-9d5d-590dfffb83e3", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ef7d54ef-92d7-48fe-a427-4390650188df", "FieldId": "2e4cafe1-429e-4042-9d5d-590dfffb83e3", "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": "77deda70-8b96-4f5c-84f6-0914e1aad9b7", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T18:16:44.4062139-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": "4c65cbe4-8099-482a-ad1e-d822f3b586a2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a05ea519-fb06-4467-9f05-f692b8e1d329", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3bb05396-8435-4a6c-8092-777505131083", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T18:16:44.4062139-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-01T18:16:44.4062139-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "39abb2f9-3e69-4b70-8085-780737e5af81", "Section": { "FormTypeSectionId": "26f6d5e0-80b0-4b17-b806-f77849d68a6b", "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": "6c6ac611-f1d9-4afc-950e-e081c12ff2db", "Name": "sample string 1" }, "Unit": { "UnitId": "e930bf78-96a8-4bf8-9444-488c8fb50770", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0bf06d14-6ae1-41c0-a39f-5ef30962f343", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T18:16:44.4062139-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "8b358b3f-0afb-4d54-9e7f-30118d063bfd", "FieldId": "aa33d9f4-f7be-46b1-9409-8cfa3607a926", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "8b358b3f-0afb-4d54-9e7f-30118d063bfd", "FieldId": "aa33d9f4-f7be-46b1-9409-8cfa3607a926", "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": "39abb2f9-3e69-4b70-8085-780737e5af81", "Section": { "FormTypeSectionId": "26f6d5e0-80b0-4b17-b806-f77849d68a6b", "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": "6c6ac611-f1d9-4afc-950e-e081c12ff2db", "Name": "sample string 1" }, "Unit": { "UnitId": "e930bf78-96a8-4bf8-9444-488c8fb50770", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0bf06d14-6ae1-41c0-a39f-5ef30962f343", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T18:16:44.4062139-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "8b358b3f-0afb-4d54-9e7f-30118d063bfd", "FieldId": "aa33d9f4-f7be-46b1-9409-8cfa3607a926", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "8b358b3f-0afb-4d54-9e7f-30118d063bfd", "FieldId": "aa33d9f4-f7be-46b1-9409-8cfa3607a926", "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": "1a5e4b0e-329e-4caf-abeb-86d4206747cf", "CreateDate": "2025-07-01T18:16:44.4062139-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T18:16:44.4062139-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }