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": "3c949bd3-8ffa-4dca-8484-92105878394b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "607d3d2a-4820-42e3-ab2a-1d21612ef74a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "fb7835db-8237-4c8b-a359-6d7c0d591842", "CreateDate": "2025-04-03T18:41:48.1528179-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-03T18:41:48.1528179-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-03T18:41:48.1528179-07:00", "Fields": [ { "FormTypeFieldId": "91b31b80-50af-4c34-b24d-2c7b622d597d", "Section": { "FormTypeSectionId": "089c3159-3a05-4fc5-909b-6b4092c1b437", "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": "7ec5a86f-64a4-4bc2-b529-6898b6e61708", "Name": "sample string 1" }, "Unit": { "UnitId": "7e15d577-7325-4082-a67f-e158b82b30b5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8c326e02-90ef-44a0-b446-7c80faa8846c", "CreateDate": "2025-04-03T18:41:48.1528179-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T18:41:48.1528179-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "2d178f69-2406-40bb-9172-37f1bc5fda80", "FieldId": "690a9fb1-494f-4c56-88b7-c9a1399a6a09", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "2d178f69-2406-40bb-9172-37f1bc5fda80", "FieldId": "690a9fb1-494f-4c56-88b7-c9a1399a6a09", "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": "91b31b80-50af-4c34-b24d-2c7b622d597d", "Section": { "FormTypeSectionId": "089c3159-3a05-4fc5-909b-6b4092c1b437", "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": "7ec5a86f-64a4-4bc2-b529-6898b6e61708", "Name": "sample string 1" }, "Unit": { "UnitId": "7e15d577-7325-4082-a67f-e158b82b30b5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8c326e02-90ef-44a0-b446-7c80faa8846c", "CreateDate": "2025-04-03T18:41:48.1528179-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T18:41:48.1528179-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "2d178f69-2406-40bb-9172-37f1bc5fda80", "FieldId": "690a9fb1-494f-4c56-88b7-c9a1399a6a09", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "2d178f69-2406-40bb-9172-37f1bc5fda80", "FieldId": "690a9fb1-494f-4c56-88b7-c9a1399a6a09", "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": "bbef89c6-2b04-42ec-962a-8cf412a01202", "CreateDate": "2025-04-03T18:41:48.1528179-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T18:41:48.1528179-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }