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": "f2344e21-13e6-4ed7-a348-46f26c8d219b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9221833f-d176-4c82-aafc-514b68971733", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "740f7c00-f9a6-4128-9b1a-175c7106108d", "CreateDate": "2025-04-01T18:23:33.7343739-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-01T18:23:33.7343739-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-01T18:23:33.7343739-07:00", "Fields": [ { "FormTypeFieldId": "9dc90144-1c98-4134-8b18-aa24076766f7", "Section": { "FormTypeSectionId": "ddbdd21c-b55a-4a9b-9b2a-792b15b4aba0", "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": "d532908d-568a-4c97-8414-67f9dcd9aa43", "Name": "sample string 1" }, "Unit": { "UnitId": "4a610e78-b685-408d-93af-57c8d0bfabe2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0468a541-e8b6-41da-9410-e246d79bc6f9", "CreateDate": "2025-04-01T18:23:33.7343739-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-01T18:23:33.7343739-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5bd307c4-ac83-45dd-8aa6-3a4aed707c6e", "FieldId": "e2d74bde-d7bd-4432-a91d-a458bcea4e1f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5bd307c4-ac83-45dd-8aa6-3a4aed707c6e", "FieldId": "e2d74bde-d7bd-4432-a91d-a458bcea4e1f", "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": "9dc90144-1c98-4134-8b18-aa24076766f7", "Section": { "FormTypeSectionId": "ddbdd21c-b55a-4a9b-9b2a-792b15b4aba0", "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": "d532908d-568a-4c97-8414-67f9dcd9aa43", "Name": "sample string 1" }, "Unit": { "UnitId": "4a610e78-b685-408d-93af-57c8d0bfabe2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0468a541-e8b6-41da-9410-e246d79bc6f9", "CreateDate": "2025-04-01T18:23:33.7343739-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-01T18:23:33.7343739-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5bd307c4-ac83-45dd-8aa6-3a4aed707c6e", "FieldId": "e2d74bde-d7bd-4432-a91d-a458bcea4e1f", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5bd307c4-ac83-45dd-8aa6-3a4aed707c6e", "FieldId": "e2d74bde-d7bd-4432-a91d-a458bcea4e1f", "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": "e717852b-3fc3-4d6d-a083-214195e37461", "CreateDate": "2025-04-01T18:23:33.7343739-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-01T18:23:33.7343739-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }