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": "47d4bed9-f5c9-470c-a7d3-2bfbadc2017e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "37501658-964d-4379-b3a9-75f109c2b190",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9010f97c-6096-4ed6-b367-b7bc309bbf00",
"CreateDate": "2026-11-01T14:55:51.3200146-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T14:55:51.3200146-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-01T14:55:51.3200146-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "59b7c574-5ce4-4760-95cd-4d99c405f40d",
"Section": {
"FormTypeSectionId": "89d4f4f7-69c4-49ba-843b-8bc60ad0a8af",
"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": "4f82a0d3-b890-49f9-9b78-37d7cedc736e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7cbfdd2f-6a06-4d44-babf-3c64e3307118",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "91103c75-32dc-4538-ac40-fd3e570d58c8",
"CreateDate": "2026-11-01T14:55:51.3200146-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T14:55:51.3200146-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "dc6f1b27-e1e6-4f4e-ae12-fb882f2a299c",
"FieldId": "023b2833-a822-423e-af74-d440ffceb6c0",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "dc6f1b27-e1e6-4f4e-ae12-fb882f2a299c",
"FieldId": "023b2833-a822-423e-af74-d440ffceb6c0",
"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": "59b7c574-5ce4-4760-95cd-4d99c405f40d",
"Section": {
"FormTypeSectionId": "89d4f4f7-69c4-49ba-843b-8bc60ad0a8af",
"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": "4f82a0d3-b890-49f9-9b78-37d7cedc736e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7cbfdd2f-6a06-4d44-babf-3c64e3307118",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "91103c75-32dc-4538-ac40-fd3e570d58c8",
"CreateDate": "2026-11-01T14:55:51.3200146-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T14:55:51.3200146-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "dc6f1b27-e1e6-4f4e-ae12-fb882f2a299c",
"FieldId": "023b2833-a822-423e-af74-d440ffceb6c0",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "dc6f1b27-e1e6-4f4e-ae12-fb882f2a299c",
"FieldId": "023b2833-a822-423e-af74-d440ffceb6c0",
"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": "446e9820-a694-4ee7-88de-151baf2729f8",
"CreateDate": "2026-11-01T14:55:51.3200146-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T14:55:51.3200146-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}