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": "0d2b72d7-d1d9-4028-b423-1c6759d96581", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8e5d38bf-4e30-49aa-a9e1-5c931fe25ed0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2d9ddb96-4d96-414c-ab7e-55261b3a6620", "CreateDate": "2025-01-02T11:33:00.7378891-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-02T11:33:00.7378891-08:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-01-02T11:33:00.7378891-08:00", "Fields": [ { "FormTypeFieldId": "332df787-7754-4c05-960d-952f8db6ac60", "Section": { "FormTypeSectionId": "6932bc84-5d7b-4eea-8c73-564a42544a26", "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": "a17617ad-8959-4ee8-8e4a-f55e36ae25ce", "Name": "sample string 1" }, "Unit": { "UnitId": "9c94412e-8c8c-4e93-b22e-da666ff9a976", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c03664af-1515-46f2-876f-888c25a36bc0", "CreateDate": "2025-01-02T11:33:00.7378891-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:33:00.7378891-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e53188f9-a01e-46fc-a918-3269a38aae0a", "FieldId": "a0aa733e-3545-4bab-b3d3-1fe39a73ae16", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e53188f9-a01e-46fc-a918-3269a38aae0a", "FieldId": "a0aa733e-3545-4bab-b3d3-1fe39a73ae16", "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": "332df787-7754-4c05-960d-952f8db6ac60", "Section": { "FormTypeSectionId": "6932bc84-5d7b-4eea-8c73-564a42544a26", "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": "a17617ad-8959-4ee8-8e4a-f55e36ae25ce", "Name": "sample string 1" }, "Unit": { "UnitId": "9c94412e-8c8c-4e93-b22e-da666ff9a976", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c03664af-1515-46f2-876f-888c25a36bc0", "CreateDate": "2025-01-02T11:33:00.7378891-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:33:00.7378891-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e53188f9-a01e-46fc-a918-3269a38aae0a", "FieldId": "a0aa733e-3545-4bab-b3d3-1fe39a73ae16", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e53188f9-a01e-46fc-a918-3269a38aae0a", "FieldId": "a0aa733e-3545-4bab-b3d3-1fe39a73ae16", "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": "7e47e8a9-8ac5-4ff4-948b-2b5ceba8bc2e", "CreateDate": "2025-01-02T11:33:00.7378891-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-02T11:33:00.7378891-08:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }