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": "3c47941f-74e0-469d-8e61-5ad821fa5e70", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "3936dd7d-e503-4ea2-9f59-993a111ef3b1", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "15d7ee63-ee50-4c32-bf4f-b2eade1cde8e", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:52:22.6281566-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:52:22.6281566-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "07829972-435b-462e-aefe-de09d3a7945a", "Section": { "FormTypeSectionId": "0fa0c9d7-6618-4603-b625-9df1adaf9922", "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": "1225aa24-97fa-4773-b167-412840baea6b", "Name": "sample string 1" }, "Unit": { "UnitId": "d031811f-1c76-4141-a50c-5f8629fe65c9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "de8db2d5-c093-4843-aba1-a74b74d92c37", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:52:22.6281566-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7c38db8a-c1eb-4560-91cc-e6d1e1b3a0a0", "FieldId": "cd08a94d-546e-423e-b2e4-154e3c936e86", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7c38db8a-c1eb-4560-91cc-e6d1e1b3a0a0", "FieldId": "cd08a94d-546e-423e-b2e4-154e3c936e86", "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": "07829972-435b-462e-aefe-de09d3a7945a", "Section": { "FormTypeSectionId": "0fa0c9d7-6618-4603-b625-9df1adaf9922", "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": "1225aa24-97fa-4773-b167-412840baea6b", "Name": "sample string 1" }, "Unit": { "UnitId": "d031811f-1c76-4141-a50c-5f8629fe65c9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "de8db2d5-c093-4843-aba1-a74b74d92c37", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:52:22.6281566-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7c38db8a-c1eb-4560-91cc-e6d1e1b3a0a0", "FieldId": "cd08a94d-546e-423e-b2e4-154e3c936e86", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7c38db8a-c1eb-4560-91cc-e6d1e1b3a0a0", "FieldId": "cd08a94d-546e-423e-b2e4-154e3c936e86", "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": "e51262b1-fc0b-4c6f-a0f2-c89f846e2443", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:52:22.6281566-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": "e135ba37-fc7a-445d-848d-1f5c91442784", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bd46927a-85db-4bdd-8680-a10200822976", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "13fe6169-2c3f-4899-a4a6-d33bcd79a81c", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:52:22.6281566-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:52:22.6281566-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "b1d65333-a5fc-4d79-9b4a-fd0d71ffc4cf", "Section": { "FormTypeSectionId": "633e6d89-bd13-466b-aa31-b548083e0622", "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": "aaa2e02f-835b-43fe-99b1-1f4f29de6d66", "Name": "sample string 1" }, "Unit": { "UnitId": "3c0da6c9-c1e0-445b-9a48-b40646f184ae", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "61ace8cb-b845-4792-81c5-b7b8503e1aa0", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:52:22.6281566-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "035773d8-d704-4d4a-9aac-9a0f4d98d8ee", "FieldId": "71896983-4ed0-4693-a815-adba373ca0d2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "035773d8-d704-4d4a-9aac-9a0f4d98d8ee", "FieldId": "71896983-4ed0-4693-a815-adba373ca0d2", "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": "b1d65333-a5fc-4d79-9b4a-fd0d71ffc4cf", "Section": { "FormTypeSectionId": "633e6d89-bd13-466b-aa31-b548083e0622", "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": "aaa2e02f-835b-43fe-99b1-1f4f29de6d66", "Name": "sample string 1" }, "Unit": { "UnitId": "3c0da6c9-c1e0-445b-9a48-b40646f184ae", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "61ace8cb-b845-4792-81c5-b7b8503e1aa0", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:52:22.6281566-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "035773d8-d704-4d4a-9aac-9a0f4d98d8ee", "FieldId": "71896983-4ed0-4693-a815-adba373ca0d2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "035773d8-d704-4d4a-9aac-9a0f4d98d8ee", "FieldId": "71896983-4ed0-4693-a815-adba373ca0d2", "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": "063f2404-de23-4349-a323-f59485435adc", "CreateDate": "2025-10-10T14:52:22.6281566-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:52:22.6281566-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }