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": "585d1b04-e99a-4d08-8357-8b5c329dd8ab",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3afa4027-b1e8-4249-a07c-9190802e70d9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "080b2dc8-83ed-4bef-8a12-8a8e0f347843",
"CreateDate": "2025-11-17T18:49:23.3098539-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:49:23.3098539-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-17T18:49:23.3098539-08:00",
"Fields": [
{
"FormTypeFieldId": "c580c892-b7ad-455b-9575-3d561c367c11",
"Section": {
"FormTypeSectionId": "be37d247-b5d3-435e-8039-c470b6c2f437",
"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": "aab5acf5-5bf1-4b63-8bd3-65cf0e22e9f2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "147e3dbe-8b1a-4eef-85e2-f6ca94435ed7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d6129c4c-da5f-4818-949a-4c6f85990807",
"CreateDate": "2025-11-17T18:49:23.3098539-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:49:23.3098539-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f3b81e0b-53c5-4c33-ad23-155cb1ee85a7",
"FieldId": "2e3d0916-8372-4fe4-9a0b-b0dcc52c279e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f3b81e0b-53c5-4c33-ad23-155cb1ee85a7",
"FieldId": "2e3d0916-8372-4fe4-9a0b-b0dcc52c279e",
"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": "c580c892-b7ad-455b-9575-3d561c367c11",
"Section": {
"FormTypeSectionId": "be37d247-b5d3-435e-8039-c470b6c2f437",
"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": "aab5acf5-5bf1-4b63-8bd3-65cf0e22e9f2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "147e3dbe-8b1a-4eef-85e2-f6ca94435ed7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d6129c4c-da5f-4818-949a-4c6f85990807",
"CreateDate": "2025-11-17T18:49:23.3098539-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:49:23.3098539-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f3b81e0b-53c5-4c33-ad23-155cb1ee85a7",
"FieldId": "2e3d0916-8372-4fe4-9a0b-b0dcc52c279e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f3b81e0b-53c5-4c33-ad23-155cb1ee85a7",
"FieldId": "2e3d0916-8372-4fe4-9a0b-b0dcc52c279e",
"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": "f68bad65-e6d2-4850-8f1d-5b983b71d413",
"CreateDate": "2025-11-17T18:49:23.3098539-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:49:23.3098539-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}