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": "6aaef1ff-9c75-4da2-986a-3a5aada7a361", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e86e4458-6e7a-45ac-94b4-a5866fc544b1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4e27f71c-9762-47ff-a8dc-c5bf502b586d", "CreateDate": "2025-06-06T14:28:31.9822052-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-06T14:28:31.9822052-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-06T14:28:31.9822052-07:00", "Fields": [ { "FormTypeFieldId": "250edf0f-9cd1-41f1-9ceb-007bcf40ecb5", "Section": { "FormTypeSectionId": "8107922c-aa95-4c03-bfe2-febbe17d3041", "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": "940d6823-1322-400d-9ccf-1fbccf8640cb", "Name": "sample string 1" }, "Unit": { "UnitId": "62613a49-0e68-4ba0-a45f-17bdbb8d80fc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b5984dc9-1227-464a-9e2c-b19da1f362d7", "CreateDate": "2025-06-06T14:28:31.9822052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-06T14:28:31.9822052-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "de6fd18e-9f4e-4a1a-88a9-b9bfcb88e53d", "FieldId": "ec353e63-3214-4ec2-838f-b0ca37666e0f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "de6fd18e-9f4e-4a1a-88a9-b9bfcb88e53d", "FieldId": "ec353e63-3214-4ec2-838f-b0ca37666e0f", "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": "250edf0f-9cd1-41f1-9ceb-007bcf40ecb5", "Section": { "FormTypeSectionId": "8107922c-aa95-4c03-bfe2-febbe17d3041", "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": "940d6823-1322-400d-9ccf-1fbccf8640cb", "Name": "sample string 1" }, "Unit": { "UnitId": "62613a49-0e68-4ba0-a45f-17bdbb8d80fc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b5984dc9-1227-464a-9e2c-b19da1f362d7", "CreateDate": "2025-06-06T14:28:31.9822052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-06T14:28:31.9822052-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "de6fd18e-9f4e-4a1a-88a9-b9bfcb88e53d", "FieldId": "ec353e63-3214-4ec2-838f-b0ca37666e0f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "de6fd18e-9f4e-4a1a-88a9-b9bfcb88e53d", "FieldId": "ec353e63-3214-4ec2-838f-b0ca37666e0f", "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": "e8272f1d-1a8c-46c6-b9aa-5e7427874ddf", "CreateDate": "2025-06-06T14:28:31.9822052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-06T14:28:31.9822052-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": "1d001b95-73bb-4398-b483-b40de19889e7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d704a5f2-2ca8-4df6-aa08-d1d2e698082f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "61730ebe-ca47-4c13-8ee4-89e46ac65d1b", "CreateDate": "2025-06-06T14:28:31.9978231-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-06T14:28:31.9978231-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-06T14:28:31.9978231-07:00", "Fields": [ { "FormTypeFieldId": "cbe6dcf2-4dcb-4d44-8c6e-17daf8fca52f", "Section": { "FormTypeSectionId": "c0815e58-a446-4f97-9d4e-ad281696ae9b", "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": "c0cabb83-567c-46fa-aede-4b8bc4c36066", "Name": "sample string 1" }, "Unit": { "UnitId": "7e3e82c0-58e9-452c-b9db-e98b08d03585", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5884df40-561d-4da0-88d2-60e2d5f054e7", "CreateDate": "2025-06-06T14:28:31.9978231-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-06T14:28:31.9978231-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "9b6e12fa-cf80-47d3-9a20-3d3a608ab358", "FieldId": "91f9902d-e3f1-4743-a2c7-9dad6b755a0f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "9b6e12fa-cf80-47d3-9a20-3d3a608ab358", "FieldId": "91f9902d-e3f1-4743-a2c7-9dad6b755a0f", "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": "cbe6dcf2-4dcb-4d44-8c6e-17daf8fca52f", "Section": { "FormTypeSectionId": "c0815e58-a446-4f97-9d4e-ad281696ae9b", "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": "c0cabb83-567c-46fa-aede-4b8bc4c36066", "Name": "sample string 1" }, "Unit": { "UnitId": "7e3e82c0-58e9-452c-b9db-e98b08d03585", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5884df40-561d-4da0-88d2-60e2d5f054e7", "CreateDate": "2025-06-06T14:28:31.9978231-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-06T14:28:31.9978231-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "9b6e12fa-cf80-47d3-9a20-3d3a608ab358", "FieldId": "91f9902d-e3f1-4743-a2c7-9dad6b755a0f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "9b6e12fa-cf80-47d3-9a20-3d3a608ab358", "FieldId": "91f9902d-e3f1-4743-a2c7-9dad6b755a0f", "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": "9b48334e-077e-4615-a85d-7b671d9d793a", "CreateDate": "2025-06-06T14:28:31.9978231-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-06T14:28:31.9978231-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }