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. |
|
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": "8e253ec6-eaaf-448f-9584-4bf6a6413773", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7d0a8299-272f-43dc-a233-faf6670366d4", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f3388789-f2d4-4607-a99c-27bdf9ecf3d1", "CreateDate": "2025-07-14T21:07:01.1114212-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-14T21:07:01.1114212-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-14T21:07:01.1114212-07:00", "Fields": [ { "FormTypeFieldId": "5ec9c262-65a0-48b3-9268-166c4e0f484f", "Section": { "FormTypeSectionId": "75323f41-0d79-4d0c-9c66-1c55182e6dbf", "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": "c296ac03-5060-4632-a2f7-1daf0d4fa39c", "Name": "sample string 1" }, "Unit": { "UnitId": "b045f318-5340-4ebe-afda-60f3c67a725c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a8f4aa89-c3f3-49fc-8961-e421f6296b2f", "CreateDate": "2025-07-14T21:07:01.1114212-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-14T21:07:01.1114212-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "60097eeb-abeb-44f2-bf00-4c8e738e0b77", "FieldId": "701879ac-a9fc-4de2-9685-d2f5e119f1ab", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "60097eeb-abeb-44f2-bf00-4c8e738e0b77", "FieldId": "701879ac-a9fc-4de2-9685-d2f5e119f1ab", "FieldName": "sample string 1", "FieldLable": "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": "5ec9c262-65a0-48b3-9268-166c4e0f484f", "Section": { "FormTypeSectionId": "75323f41-0d79-4d0c-9c66-1c55182e6dbf", "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": "c296ac03-5060-4632-a2f7-1daf0d4fa39c", "Name": "sample string 1" }, "Unit": { "UnitId": "b045f318-5340-4ebe-afda-60f3c67a725c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a8f4aa89-c3f3-49fc-8961-e421f6296b2f", "CreateDate": "2025-07-14T21:07:01.1114212-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-14T21:07:01.1114212-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "60097eeb-abeb-44f2-bf00-4c8e738e0b77", "FieldId": "701879ac-a9fc-4de2-9685-d2f5e119f1ab", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "60097eeb-abeb-44f2-bf00-4c8e738e0b77", "FieldId": "701879ac-a9fc-4de2-9685-d2f5e119f1ab", "FieldName": "sample string 1", "FieldLable": "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 3", "CompanyId": "2d53d59a-1578-4297-a3a0-45a7a4b273af", "CreateDate": "2025-07-14T21:07:01.1114212-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-14T21:07:01.1114212-07:00", "LastModifiedUser": "sample string 6" }
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": "f635fe0a-9e18-4efa-9bf4-4f11766d86c5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d4c53662-c67b-4667-9239-44600aa6a2a2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "236da896-266b-4bb9-8a39-66da46958e23", "CreateDate": "2025-07-14T21:07:01.1269673-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-14T21:07:01.1269673-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-14T21:07:01.1269673-07:00", "Fields": [ { "FormTypeFieldId": "57e2dda2-1f0a-4581-af63-f0c8f5209165", "Section": { "FormTypeSectionId": "8a8f99de-837a-45c7-a01c-8eb343828a3c", "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": "0d0f155f-4f76-4401-bc65-7d6dd6201e45", "Name": "sample string 1" }, "Unit": { "UnitId": "aba89487-3ddc-4066-acd7-aaf33460ee0a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9e566c03-80f8-4040-931f-87b84d63d58c", "CreateDate": "2025-07-14T21:07:01.1269673-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-14T21:07:01.1269673-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "acaab5ca-3e4d-4d2e-be88-9b582efebcda", "FieldId": "3cca71a4-d9c4-4ffd-9f10-d44adb00aad6", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "acaab5ca-3e4d-4d2e-be88-9b582efebcda", "FieldId": "3cca71a4-d9c4-4ffd-9f10-d44adb00aad6", "FieldName": "sample string 1", "FieldLable": "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": "57e2dda2-1f0a-4581-af63-f0c8f5209165", "Section": { "FormTypeSectionId": "8a8f99de-837a-45c7-a01c-8eb343828a3c", "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": "0d0f155f-4f76-4401-bc65-7d6dd6201e45", "Name": "sample string 1" }, "Unit": { "UnitId": "aba89487-3ddc-4066-acd7-aaf33460ee0a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9e566c03-80f8-4040-931f-87b84d63d58c", "CreateDate": "2025-07-14T21:07:01.1269673-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-14T21:07:01.1269673-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "acaab5ca-3e4d-4d2e-be88-9b582efebcda", "FieldId": "3cca71a4-d9c4-4ffd-9f10-d44adb00aad6", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "acaab5ca-3e4d-4d2e-be88-9b582efebcda", "FieldId": "3cca71a4-d9c4-4ffd-9f10-d44adb00aad6", "FieldName": "sample string 1", "FieldLable": "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 3", "CompanyId": "93e06139-cd70-4015-a231-087c1cbed6e2", "CreateDate": "2025-07-14T21:07:01.1269673-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-14T21:07:01.1269673-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }