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": "788496ad-28d1-4457-a10a-dc7343387c7b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c9856bc2-d5bd-40d7-91f1-933fb8902f01",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6c456993-fc76-471c-b402-773ee7dfc222",
"CreateDate": "2026-08-05T10:32:31.8195027-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-05T10:32:31.8195027-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-05T10:32:31.8195027-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "edc15387-86f7-4591-945b-6efd265b21cc",
"Section": {
"FormTypeSectionId": "0ad6a029-7093-43e6-826d-fd3adecfe45d",
"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": "b320dd7f-118a-4744-b65f-0eaf779ae698",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "19cfb366-86ea-48f1-87e8-628989ccbc5e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2edb12a9-1285-47bd-b5ca-45781ce869c1",
"CreateDate": "2026-08-05T10:32:31.8195027-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-05T10:32:31.8195027-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0d372ad0-f54e-4510-a58f-4d6e59996d23",
"FieldId": "fb1caa46-733e-4a3d-bd5f-8d37fa715c03",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0d372ad0-f54e-4510-a58f-4d6e59996d23",
"FieldId": "fb1caa46-733e-4a3d-bd5f-8d37fa715c03",
"FieldName": "sample string 1",
"FieldLabel": "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": "edc15387-86f7-4591-945b-6efd265b21cc",
"Section": {
"FormTypeSectionId": "0ad6a029-7093-43e6-826d-fd3adecfe45d",
"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": "b320dd7f-118a-4744-b65f-0eaf779ae698",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "19cfb366-86ea-48f1-87e8-628989ccbc5e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2edb12a9-1285-47bd-b5ca-45781ce869c1",
"CreateDate": "2026-08-05T10:32:31.8195027-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-05T10:32:31.8195027-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0d372ad0-f54e-4510-a58f-4d6e59996d23",
"FieldId": "fb1caa46-733e-4a3d-bd5f-8d37fa715c03",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0d372ad0-f54e-4510-a58f-4d6e59996d23",
"FieldId": "fb1caa46-733e-4a3d-bd5f-8d37fa715c03",
"FieldName": "sample string 1",
"FieldLabel": "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 4",
"CompanyId": "c45661c8-bdcb-4c47-94f1-5bce8c1293a7",
"CreateDate": "2026-08-05T10:32:31.8195027-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-05T10:32:31.8195027-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}