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": "c9baa178-78a2-49f4-8bb6-986848cf8c7e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f149ed8d-b294-4a29-a3b0-b597eb3335a9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "eb166cff-6eec-4ff4-88bd-bcaa45690d3b",
"CreateDate": "2026-03-15T17:59:04.1660492-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:59:04.1660492-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-15T17:59:04.1660492-07:00",
"Fields": [
{
"FormTypeFieldId": "6b316729-080c-4003-9885-e49ba8184964",
"Section": {
"FormTypeSectionId": "44b87a81-0e2c-4494-8240-b1d8fee92354",
"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": "b8d53191-a8db-48d6-98df-daeae9d8a790",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd420b8-6baa-443e-92ac-b685289b199f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ef44f2da-5aff-440e-9269-a54997eb399d",
"CreateDate": "2026-03-15T17:59:04.1660492-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:59:04.1660492-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "38d8d1e9-a34d-468a-ab57-8495fe60c460",
"FieldId": "9001952b-d101-4746-994d-3c077f66ab31",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "38d8d1e9-a34d-468a-ab57-8495fe60c460",
"FieldId": "9001952b-d101-4746-994d-3c077f66ab31",
"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": "6b316729-080c-4003-9885-e49ba8184964",
"Section": {
"FormTypeSectionId": "44b87a81-0e2c-4494-8240-b1d8fee92354",
"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": "b8d53191-a8db-48d6-98df-daeae9d8a790",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd420b8-6baa-443e-92ac-b685289b199f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ef44f2da-5aff-440e-9269-a54997eb399d",
"CreateDate": "2026-03-15T17:59:04.1660492-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:59:04.1660492-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "38d8d1e9-a34d-468a-ab57-8495fe60c460",
"FieldId": "9001952b-d101-4746-994d-3c077f66ab31",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "38d8d1e9-a34d-468a-ab57-8495fe60c460",
"FieldId": "9001952b-d101-4746-994d-3c077f66ab31",
"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": "ad4bbbf8-c220-4533-a26f-143e6e314e62",
"CreateDate": "2026-03-15T17:59:04.1660492-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:59:04.1660492-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}