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": "bdfc9d88-0bf2-4a8d-9077-2ae2155c8009", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7894cc8b-ab45-4091-8251-8cf3f0fc829d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ca594543-b02a-4543-91ec-751edc0bd9c7", "CreateDate": "2025-05-09T00:29:43.4882608-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:29:43.4882608-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:29:43.4882608-07:00", "Fields": [ { "FormTypeFieldId": "41f71678-3a58-48d0-b579-d943326a7498", "Section": { "FormTypeSectionId": "c12baeec-400f-4249-8568-d9f5aa3652e6", "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": "036a8e3d-63f3-4e5f-a039-af6ed9b47a85", "Name": "sample string 1" }, "Unit": { "UnitId": "389141ab-a54f-4dd7-b688-931c24fa1f27", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4c3c9c51-002f-4a0e-8ffc-c50b57a656f0", "CreateDate": "2025-05-09T00:29:43.4882608-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:29:43.4882608-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c2534902-0232-4ce6-8ef7-6494f9fa185d", "FieldId": "2465b8db-86b3-4726-9cd4-d725e5108dc9", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c2534902-0232-4ce6-8ef7-6494f9fa185d", "FieldId": "2465b8db-86b3-4726-9cd4-d725e5108dc9", "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": "41f71678-3a58-48d0-b579-d943326a7498", "Section": { "FormTypeSectionId": "c12baeec-400f-4249-8568-d9f5aa3652e6", "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": "036a8e3d-63f3-4e5f-a039-af6ed9b47a85", "Name": "sample string 1" }, "Unit": { "UnitId": "389141ab-a54f-4dd7-b688-931c24fa1f27", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4c3c9c51-002f-4a0e-8ffc-c50b57a656f0", "CreateDate": "2025-05-09T00:29:43.4882608-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:29:43.4882608-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c2534902-0232-4ce6-8ef7-6494f9fa185d", "FieldId": "2465b8db-86b3-4726-9cd4-d725e5108dc9", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c2534902-0232-4ce6-8ef7-6494f9fa185d", "FieldId": "2465b8db-86b3-4726-9cd4-d725e5108dc9", "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": "c7a2d1f9-6476-4e9e-95e2-c3b88fda380f", "CreateDate": "2025-05-09T00:29:43.4882608-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:29:43.4882608-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }