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": "0baa0c70-9750-4a93-8ccd-21c4c33eadbe", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bf5acb73-eb29-465d-9c88-eb8324acae52", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ece6de98-5e79-4a20-a122-16790ecc0832", "CreateDate": "2025-07-30T23:29:15.6163102-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:29:15.6163102-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T23:29:15.6163102-07:00", "Fields": [ { "FormTypeFieldId": "48a4feb5-2bb0-4103-aae5-f9a44094f9a6", "Section": { "FormTypeSectionId": "c768662a-646d-4a10-b94b-9039a69788da", "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": "68a1f366-65f1-4530-8e4c-28d34f994617", "Name": "sample string 1" }, "Unit": { "UnitId": "c4f4b244-a423-485c-9ab9-d09d91791303", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "201032b4-53b1-4bb7-bb42-5ab5ef2b9862", "CreateDate": "2025-07-30T23:29:15.6163102-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:29:15.6163102-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "448c2a1b-377a-40e5-b233-874a2b08e288", "FieldId": "9c594f51-ce71-4903-8cda-b850b6cb6e18", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "448c2a1b-377a-40e5-b233-874a2b08e288", "FieldId": "9c594f51-ce71-4903-8cda-b850b6cb6e18", "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": "48a4feb5-2bb0-4103-aae5-f9a44094f9a6", "Section": { "FormTypeSectionId": "c768662a-646d-4a10-b94b-9039a69788da", "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": "68a1f366-65f1-4530-8e4c-28d34f994617", "Name": "sample string 1" }, "Unit": { "UnitId": "c4f4b244-a423-485c-9ab9-d09d91791303", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "201032b4-53b1-4bb7-bb42-5ab5ef2b9862", "CreateDate": "2025-07-30T23:29:15.6163102-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:29:15.6163102-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "448c2a1b-377a-40e5-b233-874a2b08e288", "FieldId": "9c594f51-ce71-4903-8cda-b850b6cb6e18", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "448c2a1b-377a-40e5-b233-874a2b08e288", "FieldId": "9c594f51-ce71-4903-8cda-b850b6cb6e18", "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": "a8db0e22-4653-44e5-83cb-11203e30e8fc", "CreateDate": "2025-07-30T23:29:15.6163102-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:29:15.6163102-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }