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": "39bcb739-4f1e-492b-91ec-219e1a98d8ff",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "28619c58-e750-42a6-abff-e5d69b0c4c8b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "00301fda-9ced-44cc-9d36-c4b10a8fc925",
"CreateDate": "2026-09-13T23:37:40.0833807-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:37:40.0833807-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-13T23:37:40.0833807-07:00",
"Fields": [
{
"FormTypeFieldId": "e982842b-722a-412b-9a89-d93d308047b3",
"Section": {
"FormTypeSectionId": "afc04692-682d-47f6-ae05-7299585708e6",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "2fa9cff8-4ab2-4796-a767-39a203c36d04",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4f6d3712-ee6e-4a05-886f-09ac4dda37f4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3060ae38-7864-4ef9-8774-bf118758222f",
"CreateDate": "2026-09-13T23:37:40.0833807-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:37:40.0833807-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0fc9703b-0edb-4b49-8d94-71fcd27bd2e8",
"FieldId": "286f3031-a6ea-4b08-91f9-f34653b873a7",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0fc9703b-0edb-4b49-8d94-71fcd27bd2e8",
"FieldId": "286f3031-a6ea-4b08-91f9-f34653b873a7",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "e982842b-722a-412b-9a89-d93d308047b3",
"Section": {
"FormTypeSectionId": "afc04692-682d-47f6-ae05-7299585708e6",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "2fa9cff8-4ab2-4796-a767-39a203c36d04",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4f6d3712-ee6e-4a05-886f-09ac4dda37f4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3060ae38-7864-4ef9-8774-bf118758222f",
"CreateDate": "2026-09-13T23:37:40.0833807-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:37:40.0833807-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0fc9703b-0edb-4b49-8d94-71fcd27bd2e8",
"FieldId": "286f3031-a6ea-4b08-91f9-f34653b873a7",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0fc9703b-0edb-4b49-8d94-71fcd27bd2e8",
"FieldId": "286f3031-a6ea-4b08-91f9-f34653b873a7",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "778adcb1-c5e8-4046-ac26-e240295dfc9b",
"CreateDate": "2026-09-13T23:37:40.0833807-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:37:40.0833807-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}