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": "558d90e8-90f1-4730-95a7-094ce64c94d4",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "04190253-6edb-415a-8e58-490ec21aef88",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3aa3e18e-982d-445f-9d04-7d30efd93e71",
"CreateDate": "2026-10-29T15:39:54.9718012-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-29T15:39:54.9718012-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-29T15:39:54.9718012-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "1829c691-31ce-42d0-a28f-ef5952d58597",
"Section": {
"FormTypeSectionId": "0e20daf5-2a0b-4c61-8b9f-ba26d108ceca",
"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": "3a7d3634-c46c-4c16-addc-c711529af3f6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ab1a6859-fa31-4186-b1aa-98bfed08642a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b6ad8fe9-3282-41b0-8674-9774f380cf50",
"CreateDate": "2026-10-29T15:39:54.9718012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-29T15:39:54.9718012-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "52e5d085-c8c7-46a7-abf3-12c37446ab45",
"FieldId": "5c98c57f-ba2e-4ad6-bc82-ca803db63cd1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "52e5d085-c8c7-46a7-abf3-12c37446ab45",
"FieldId": "5c98c57f-ba2e-4ad6-bc82-ca803db63cd1",
"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": "1829c691-31ce-42d0-a28f-ef5952d58597",
"Section": {
"FormTypeSectionId": "0e20daf5-2a0b-4c61-8b9f-ba26d108ceca",
"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": "3a7d3634-c46c-4c16-addc-c711529af3f6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ab1a6859-fa31-4186-b1aa-98bfed08642a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b6ad8fe9-3282-41b0-8674-9774f380cf50",
"CreateDate": "2026-10-29T15:39:54.9718012-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-29T15:39:54.9718012-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "52e5d085-c8c7-46a7-abf3-12c37446ab45",
"FieldId": "5c98c57f-ba2e-4ad6-bc82-ca803db63cd1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "52e5d085-c8c7-46a7-abf3-12c37446ab45",
"FieldId": "5c98c57f-ba2e-4ad6-bc82-ca803db63cd1",
"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": "5ee8a9ce-4f1c-418d-b6bd-7c37532c36a9",
"CreateDate": "2026-10-29T15:39:54.9718012-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-29T15:39:54.9718012-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}