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": "8c71e686-d639-49b1-a1cf-15de3fcdf355",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0f9f56bf-cd0a-4e8f-9d26-d01775382534",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "34deea47-6ebf-470e-ad21-e6035ce78d10",
"CreateDate": "2026-10-17T12:22:44.7834436-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-17T12:22:44.7834436-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-17T12:22:44.7834436-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "0cb9af9c-b710-4107-8ab0-beab39a4be20",
"Section": {
"FormTypeSectionId": "54e8ad68-d78e-4881-92c9-8e07846f32f3",
"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": "a8b919f3-ffda-4d4b-a3cc-e8885b4fd61e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a514fc66-8670-4783-9e8b-3f58017fccae",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8e003a0f-a472-49bf-939a-c45a3ab69c68",
"CreateDate": "2026-10-17T12:22:44.7834436-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T12:22:44.7834436-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f359a93c-f4b2-4e8f-b01a-3d85b0150f50",
"FieldId": "48249373-aab4-4c17-80f2-86f2cb9ec913",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f359a93c-f4b2-4e8f-b01a-3d85b0150f50",
"FieldId": "48249373-aab4-4c17-80f2-86f2cb9ec913",
"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": "0cb9af9c-b710-4107-8ab0-beab39a4be20",
"Section": {
"FormTypeSectionId": "54e8ad68-d78e-4881-92c9-8e07846f32f3",
"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": "a8b919f3-ffda-4d4b-a3cc-e8885b4fd61e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a514fc66-8670-4783-9e8b-3f58017fccae",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8e003a0f-a472-49bf-939a-c45a3ab69c68",
"CreateDate": "2026-10-17T12:22:44.7834436-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-17T12:22:44.7834436-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f359a93c-f4b2-4e8f-b01a-3d85b0150f50",
"FieldId": "48249373-aab4-4c17-80f2-86f2cb9ec913",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f359a93c-f4b2-4e8f-b01a-3d85b0150f50",
"FieldId": "48249373-aab4-4c17-80f2-86f2cb9ec913",
"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": "6f712f29-e1e2-4c92-8098-cf04f8ef4b5a",
"CreateDate": "2026-10-17T12:22:44.7834436-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-17T12:22:44.7834436-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}