GET FormTypes?formTypeId={formTypeId}
Retrieves a form type by its Id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formTypeId |
Id of the form type |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the 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": "94cc9ecf-567e-4e4d-a154-519f71f77bdd", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "86ca6ffb-9991-4468-bcd9-4f2274c293af", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e72cf839-13af-48ac-8228-c77e88b54502", "CreateDate": "2025-10-13T15:16:39.5012176-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:16:39.5012176-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:16:39.5012176-07:00", "Fields": [ { "FormTypeFieldId": "98806e21-e114-4144-bdd9-423a12f1656c", "Section": { "FormTypeSectionId": "0f7b73fa-8d9e-4f11-86a2-100e3293e898", "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": "6d4521d8-49d9-4923-b878-66b582afeeda", "Name": "sample string 1" }, "Unit": { "UnitId": "73f97833-df42-4328-aa87-f77e2c6ece23", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "275fc298-5aa1-4534-a272-0089a25757cd", "CreateDate": "2025-10-13T15:16:39.5012176-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.5012176-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6917fac-5c18-4e5f-960b-1a79feb9a744", "FieldId": "894e4e69-4a08-4f3b-96a7-40344fc66dca", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6917fac-5c18-4e5f-960b-1a79feb9a744", "FieldId": "894e4e69-4a08-4f3b-96a7-40344fc66dca", "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": "98806e21-e114-4144-bdd9-423a12f1656c", "Section": { "FormTypeSectionId": "0f7b73fa-8d9e-4f11-86a2-100e3293e898", "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": "6d4521d8-49d9-4923-b878-66b582afeeda", "Name": "sample string 1" }, "Unit": { "UnitId": "73f97833-df42-4328-aa87-f77e2c6ece23", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "275fc298-5aa1-4534-a272-0089a25757cd", "CreateDate": "2025-10-13T15:16:39.5012176-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.5012176-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6917fac-5c18-4e5f-960b-1a79feb9a744", "FieldId": "894e4e69-4a08-4f3b-96a7-40344fc66dca", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6917fac-5c18-4e5f-960b-1a79feb9a744", "FieldId": "894e4e69-4a08-4f3b-96a7-40344fc66dca", "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": "0834ffa7-5590-483e-bf28-748ba80d8937", "CreateDate": "2025-10-13T15:16:39.5012176-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.5012176-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }