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": "ade19973-8da0-4fb6-946b-1528bec8edde", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bb6cf48c-29ee-432a-9ee8-3c47bc154a90", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2da2ee4d-559b-41a2-8d01-51e9db0061d8", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T01:04:35.7774917-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-27T01:04:35.7774917-07:00", "Fields": [ { "FormTypeFieldId": "bffd218c-2272-457c-b22f-193b78a84123", "Section": { "FormTypeSectionId": "bb0a8761-00dc-4bb8-bedc-25d75e73a34a", "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": "32f87597-fd2e-4fcb-a989-ae78e1ec4707", "Name": "sample string 1" }, "Unit": { "UnitId": "ca5182bf-3b20-49a0-9175-884da18d7180", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "714df931-e0e6-4b6b-862c-b8c9c60b031b", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T01:04:35.7774917-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1d655420-6d32-4464-befd-935cbfda356b", "FieldId": "e2e68daa-b9ee-4ab4-9ab4-5c1b0b74ae6b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1d655420-6d32-4464-befd-935cbfda356b", "FieldId": "e2e68daa-b9ee-4ab4-9ab4-5c1b0b74ae6b", "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": "bffd218c-2272-457c-b22f-193b78a84123", "Section": { "FormTypeSectionId": "bb0a8761-00dc-4bb8-bedc-25d75e73a34a", "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": "32f87597-fd2e-4fcb-a989-ae78e1ec4707", "Name": "sample string 1" }, "Unit": { "UnitId": "ca5182bf-3b20-49a0-9175-884da18d7180", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "714df931-e0e6-4b6b-862c-b8c9c60b031b", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T01:04:35.7774917-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1d655420-6d32-4464-befd-935cbfda356b", "FieldId": "e2e68daa-b9ee-4ab4-9ab4-5c1b0b74ae6b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1d655420-6d32-4464-befd-935cbfda356b", "FieldId": "e2e68daa-b9ee-4ab4-9ab4-5c1b0b74ae6b", "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": "59d1da91-989c-40e7-81cd-3ec802c7b8c0", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T01:04:35.7774917-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": "04aa268a-03c3-4331-9d7c-3482d4f62a8b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5f2117ba-5fed-4b28-a2f4-0fa73fb27645", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6dff6b04-9863-4ad5-bc27-7e624bb02f08", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T01:04:35.7774917-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-27T01:04:35.7774917-07:00", "Fields": [ { "FormTypeFieldId": "bb3f7443-199c-4ec4-8dc9-697cd8b62576", "Section": { "FormTypeSectionId": "502a0bd2-052d-4ca0-8864-8d1a0a8c6554", "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": "28793ac9-28e2-4e8a-bc15-e9abf093d164", "Name": "sample string 1" }, "Unit": { "UnitId": "f43ac362-2c81-4b12-84a9-18629e55f417", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c3401bbd-2caf-45d1-91a6-c9fee8dab3b9", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T01:04:35.7774917-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6b37d151-7126-461b-a664-3fb8b86837bf", "FieldId": "f09d432d-394c-4953-a383-31619065aa60", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6b37d151-7126-461b-a664-3fb8b86837bf", "FieldId": "f09d432d-394c-4953-a383-31619065aa60", "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": "bb3f7443-199c-4ec4-8dc9-697cd8b62576", "Section": { "FormTypeSectionId": "502a0bd2-052d-4ca0-8864-8d1a0a8c6554", "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": "28793ac9-28e2-4e8a-bc15-e9abf093d164", "Name": "sample string 1" }, "Unit": { "UnitId": "f43ac362-2c81-4b12-84a9-18629e55f417", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c3401bbd-2caf-45d1-91a6-c9fee8dab3b9", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T01:04:35.7774917-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6b37d151-7126-461b-a664-3fb8b86837bf", "FieldId": "f09d432d-394c-4953-a383-31619065aa60", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6b37d151-7126-461b-a664-3fb8b86837bf", "FieldId": "f09d432d-394c-4953-a383-31619065aa60", "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": "035fe463-4118-40b4-a63c-c2f58dfd6343", "CreateDate": "2025-06-27T01:04:35.7774917-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T01:04:35.7774917-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }