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": "37882471-43a4-4070-ac9c-963da341458b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5472a5d4-d7ab-4ea0-a79c-1a44a3e0a328", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "48db3c12-18ac-45cb-a03d-d30add3e6809", "CreateDate": "2025-06-27T06:25:30.482359-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T06:25:30.482359-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-27T06:25:30.482359-07:00", "Fields": [ { "FormTypeFieldId": "f97a3bac-1c36-46ad-866a-c0bc57829d7c", "Section": { "FormTypeSectionId": "2ac2dca9-482b-414e-b4fd-ecdd3d3752d0", "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": "b1449b49-73d7-4eb2-a320-54027087e622", "Name": "sample string 1" }, "Unit": { "UnitId": "a07fc61f-68d1-4d0c-9126-d83f82ab6bb2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "136b1441-089a-4f34-bef3-1fcee96cbee8", "CreateDate": "2025-06-27T06:25:30.482359-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:25:30.482359-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5fb49b12-515f-408f-8d64-222bb9f80392", "FieldId": "c69095f1-d19b-4a49-944b-77647b24c242", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5fb49b12-515f-408f-8d64-222bb9f80392", "FieldId": "c69095f1-d19b-4a49-944b-77647b24c242", "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": "f97a3bac-1c36-46ad-866a-c0bc57829d7c", "Section": { "FormTypeSectionId": "2ac2dca9-482b-414e-b4fd-ecdd3d3752d0", "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": "b1449b49-73d7-4eb2-a320-54027087e622", "Name": "sample string 1" }, "Unit": { "UnitId": "a07fc61f-68d1-4d0c-9126-d83f82ab6bb2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "136b1441-089a-4f34-bef3-1fcee96cbee8", "CreateDate": "2025-06-27T06:25:30.482359-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:25:30.482359-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5fb49b12-515f-408f-8d64-222bb9f80392", "FieldId": "c69095f1-d19b-4a49-944b-77647b24c242", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5fb49b12-515f-408f-8d64-222bb9f80392", "FieldId": "c69095f1-d19b-4a49-944b-77647b24c242", "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": "617f5b64-719c-42b7-b097-d1237cf37963", "CreateDate": "2025-06-27T06:25:30.482359-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T06:25:30.482359-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }