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": "abc06720-2dcd-4563-87d5-5662f5844f05", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "fa619076-c26b-4d60-8902-b62b83a4328e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "13ca0209-9a36-4af3-9fc1-229099efda35", "CreateDate": "2025-08-29T17:10:41.0683055-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:10:41.0683055-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-29T17:10:41.0683055-07:00", "Fields": [ { "FormTypeFieldId": "54386004-0be2-4ffb-b9bb-2553c0673e68", "Section": { "FormTypeSectionId": "b516721a-8676-45b0-8689-283cfa88b28e", "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": "cc4eaa56-1e18-42ea-bb4d-a53b0e3e41ed", "Name": "sample string 1" }, "Unit": { "UnitId": "1ec1314c-054f-4871-aae1-9209e1c13db1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28fcb4d3-e101-47be-a367-a073aeef0971", "CreateDate": "2025-08-29T17:10:41.0683055-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:10:41.0683055-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ff3d5842-c734-4b35-a940-0475aadf8a5f", "FieldId": "59840710-6f69-4fea-95d7-8ecee3647422", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ff3d5842-c734-4b35-a940-0475aadf8a5f", "FieldId": "59840710-6f69-4fea-95d7-8ecee3647422", "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": "54386004-0be2-4ffb-b9bb-2553c0673e68", "Section": { "FormTypeSectionId": "b516721a-8676-45b0-8689-283cfa88b28e", "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": "cc4eaa56-1e18-42ea-bb4d-a53b0e3e41ed", "Name": "sample string 1" }, "Unit": { "UnitId": "1ec1314c-054f-4871-aae1-9209e1c13db1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28fcb4d3-e101-47be-a367-a073aeef0971", "CreateDate": "2025-08-29T17:10:41.0683055-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:10:41.0683055-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ff3d5842-c734-4b35-a940-0475aadf8a5f", "FieldId": "59840710-6f69-4fea-95d7-8ecee3647422", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ff3d5842-c734-4b35-a940-0475aadf8a5f", "FieldId": "59840710-6f69-4fea-95d7-8ecee3647422", "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": "e9f12f7c-9119-43a8-bd0a-d2d9bcb826f3", "CreateDate": "2025-08-29T17:10:41.0683055-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:10:41.0683055-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }