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": "1fa70b03-f462-4bc6-a783-295c0c82222f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f857fd0d-a5da-490a-a51f-3022bc77bc3e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "036e5a09-8d42-4000-aaba-554cc42cf46f",
"CreateDate": "2026-07-15T03:52:13.745663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T03:52:13.745663-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-15T03:52:13.745663-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "56d77673-ae4d-415d-9f4f-c6e1fe049f1e",
"Section": {
"FormTypeSectionId": "3a56aad1-8802-4e99-9598-a104868c6a80",
"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": "09cd468d-5d14-47d6-8603-7cbc2135366e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b7be9e17-09d7-45b3-bbf3-550e01f744c6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "13cd4879-dae4-4b57-8d4b-39b59af0c984",
"CreateDate": "2026-07-15T03:52:13.745663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T03:52:13.745663-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "17ce5738-e6df-404d-91c6-563ac184c5c1",
"FieldId": "5f4abc9d-beac-4207-8613-c75af35ad3c3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "17ce5738-e6df-404d-91c6-563ac184c5c1",
"FieldId": "5f4abc9d-beac-4207-8613-c75af35ad3c3",
"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": "56d77673-ae4d-415d-9f4f-c6e1fe049f1e",
"Section": {
"FormTypeSectionId": "3a56aad1-8802-4e99-9598-a104868c6a80",
"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": "09cd468d-5d14-47d6-8603-7cbc2135366e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b7be9e17-09d7-45b3-bbf3-550e01f744c6",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "13cd4879-dae4-4b57-8d4b-39b59af0c984",
"CreateDate": "2026-07-15T03:52:13.745663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-15T03:52:13.745663-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "17ce5738-e6df-404d-91c6-563ac184c5c1",
"FieldId": "5f4abc9d-beac-4207-8613-c75af35ad3c3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "17ce5738-e6df-404d-91c6-563ac184c5c1",
"FieldId": "5f4abc9d-beac-4207-8613-c75af35ad3c3",
"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": "3bbad360-063a-48b5-be13-5c8d35b2608d",
"CreateDate": "2026-07-15T03:52:13.745663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-15T03:52:13.745663-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}