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": "400f5e4a-efe5-4304-bb0b-e1d7da3f6ae4", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2e6241e4-2467-44d1-b0f4-4c7985050dc8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cc8f4007-3c92-47ee-bc18-d831a75a19aa", "CreateDate": "2024-03-29T08:59:22.7067415-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T08:59:22.7067415-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-29T08:59:22.7067415-07:00", "Fields": [ { "FormTypeFieldId": "7422fe1c-6d0e-4789-9839-c54f855e0237", "Section": { "FormTypeSectionId": "74cad9e5-10c0-432b-90c1-9a1ca9b01905", "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": "67679df3-0f95-454d-a9a4-e3dbe6ea47c0", "Name": "sample string 1" }, "Unit": { "UnitId": "df978da9-8d19-4f9e-a89f-fecaeaec92ed", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28712b94-be4d-45ba-8b93-d071a0e1f1d4", "CreateDate": "2024-03-29T08:59:22.7067415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:59:22.7067415-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "7422fe1c-6d0e-4789-9839-c54f855e0237", "Section": { "FormTypeSectionId": "74cad9e5-10c0-432b-90c1-9a1ca9b01905", "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": "67679df3-0f95-454d-a9a4-e3dbe6ea47c0", "Name": "sample string 1" }, "Unit": { "UnitId": "df978da9-8d19-4f9e-a89f-fecaeaec92ed", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28712b94-be4d-45ba-8b93-d071a0e1f1d4", "CreateDate": "2024-03-29T08:59:22.7067415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:59:22.7067415-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "74d4f16d-29a6-43b7-b4ce-dd8485ef0b22", "CreateDate": "2024-03-29T08:59:22.7067415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:59:22.7067415-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }