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": "0221b97a-caf7-4494-9841-b28fc3fcf71f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7ce1b8af-420d-420a-8936-ef314b166dc2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "7c364ab3-f6b9-4ff4-9aa1-b799ec5c1081", "CreateDate": "2025-09-13T18:38:51.2709443-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:38:51.2709443-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T18:38:51.2709443-07:00", "Fields": [ { "FormTypeFieldId": "d79fefc0-56e3-4ac8-abca-d50d7285389d", "Section": { "FormTypeSectionId": "c76f2e4f-c4ae-4715-ba88-ff259998b540", "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": "5b4c3957-43d1-4764-a606-45e21397fe00", "Name": "sample string 1" }, "Unit": { "UnitId": "63287785-9694-4b80-8dd4-3cd6205b4687", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8267c242-141e-4092-9c6f-67b1b123d30f", "CreateDate": "2025-09-13T18:38:51.2709443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:38:51.2709443-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ce46dbd1-b931-44e6-95cf-1d2fb640cb7f", "FieldId": "18ba5e0f-a52f-4eae-927c-40dda5f11f7a", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ce46dbd1-b931-44e6-95cf-1d2fb640cb7f", "FieldId": "18ba5e0f-a52f-4eae-927c-40dda5f11f7a", "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": "d79fefc0-56e3-4ac8-abca-d50d7285389d", "Section": { "FormTypeSectionId": "c76f2e4f-c4ae-4715-ba88-ff259998b540", "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": "5b4c3957-43d1-4764-a606-45e21397fe00", "Name": "sample string 1" }, "Unit": { "UnitId": "63287785-9694-4b80-8dd4-3cd6205b4687", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8267c242-141e-4092-9c6f-67b1b123d30f", "CreateDate": "2025-09-13T18:38:51.2709443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:38:51.2709443-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ce46dbd1-b931-44e6-95cf-1d2fb640cb7f", "FieldId": "18ba5e0f-a52f-4eae-927c-40dda5f11f7a", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ce46dbd1-b931-44e6-95cf-1d2fb640cb7f", "FieldId": "18ba5e0f-a52f-4eae-927c-40dda5f11f7a", "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": "3fbc5ce8-0260-4b2e-ba87-90f845345696", "CreateDate": "2025-09-13T18:38:51.2709443-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:38:51.2709443-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }