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": "5f973ab2-d49a-429c-b0b6-33b87125fc7e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "15102e8e-ff9a-4035-b21b-34fb09b424a3", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a3c6408-8a88-4f16-942d-747d545b2448", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:50:21.7431688-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-19T04:50:21.7431688-07:00", "Fields": [ { "FormTypeFieldId": "3a43ce8f-9f96-4d42-b832-2914234deb7c", "Section": { "FormTypeSectionId": "6b05e242-924a-4552-b28e-8c0e0060cb75", "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": "820c2045-cf40-4e07-a932-663cf60539bf", "Name": "sample string 1" }, "Unit": { "UnitId": "f3d6641d-9de4-43d0-a2bb-fdc77a9238bd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ad4a5506-8f1b-44b5-9a13-6c64e3ac80f3", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:50:21.7431688-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b044fe6f-0023-4802-ba8b-ffd6476b7825", "FieldId": "9f8afe89-7d5e-4b87-a1d8-945d539bf875", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b044fe6f-0023-4802-ba8b-ffd6476b7825", "FieldId": "9f8afe89-7d5e-4b87-a1d8-945d539bf875", "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": "3a43ce8f-9f96-4d42-b832-2914234deb7c", "Section": { "FormTypeSectionId": "6b05e242-924a-4552-b28e-8c0e0060cb75", "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": "820c2045-cf40-4e07-a932-663cf60539bf", "Name": "sample string 1" }, "Unit": { "UnitId": "f3d6641d-9de4-43d0-a2bb-fdc77a9238bd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ad4a5506-8f1b-44b5-9a13-6c64e3ac80f3", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:50:21.7431688-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b044fe6f-0023-4802-ba8b-ffd6476b7825", "FieldId": "9f8afe89-7d5e-4b87-a1d8-945d539bf875", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b044fe6f-0023-4802-ba8b-ffd6476b7825", "FieldId": "9f8afe89-7d5e-4b87-a1d8-945d539bf875", "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": "09977e1b-9c01-48b4-b019-92ad5c4cf123", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:50:21.7431688-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": "5f6da8f6-51e1-41af-a147-785e257e0546", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "13bef100-5261-4be7-a3d7-2d0941ac8278", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "247cc9bb-f7be-4bf8-a0e5-47680a4a7269", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:50:21.7431688-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-19T04:50:21.7431688-07:00", "Fields": [ { "FormTypeFieldId": "ba4ff141-db6c-40bd-8178-27aef374ca6a", "Section": { "FormTypeSectionId": "e5ae5856-c5fe-4a82-a986-52f9943c2061", "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": "da6b587b-73df-44fa-8ac6-1cf14220502e", "Name": "sample string 1" }, "Unit": { "UnitId": "a931b830-16d4-4549-b0c4-f105ea04de83", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cf663438-043d-4250-b611-c5ce245f4372", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:50:21.7431688-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "31cb35e8-5547-4a93-9486-7c0e38643f41", "FieldId": "12fab9f9-3150-4455-a279-82165c914f2b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "31cb35e8-5547-4a93-9486-7c0e38643f41", "FieldId": "12fab9f9-3150-4455-a279-82165c914f2b", "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": "ba4ff141-db6c-40bd-8178-27aef374ca6a", "Section": { "FormTypeSectionId": "e5ae5856-c5fe-4a82-a986-52f9943c2061", "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": "da6b587b-73df-44fa-8ac6-1cf14220502e", "Name": "sample string 1" }, "Unit": { "UnitId": "a931b830-16d4-4549-b0c4-f105ea04de83", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cf663438-043d-4250-b611-c5ce245f4372", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:50:21.7431688-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "31cb35e8-5547-4a93-9486-7c0e38643f41", "FieldId": "12fab9f9-3150-4455-a279-82165c914f2b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "31cb35e8-5547-4a93-9486-7c0e38643f41", "FieldId": "12fab9f9-3150-4455-a279-82165c914f2b", "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": "70c94761-a696-4fe7-b165-22ce3d9e7891", "CreateDate": "2025-07-19T04:50:21.7431688-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:50:21.7431688-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }