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": "d49ad89b-c923-46d9-9504-28c080df8f97",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b21741ac-804f-4ab2-8e7f-9e1ff70df3eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7d0f4b50-d290-4ab3-a5da-3f26e529af01",
"CreateDate": "2026-04-26T20:46:33.7465311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-26T20:46:33.7465311-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-26T20:46:33.7465311-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "04c3e8bf-6252-4510-ae34-570d15f435b5",
"Section": {
"FormTypeSectionId": "a6708343-781a-4992-8b2d-5214e6c9b1ff",
"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": "0c5fb7cb-7283-453b-b1fc-88f53d9c9337",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d53a4631-e6ca-4ebb-b015-5acecc2a35c5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e670d2d-da9b-4b3a-ae29-2112a5dab705",
"CreateDate": "2026-04-26T20:46:33.7465311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-26T20:46:33.7465311-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "44cbff94-0747-4b8c-a53a-6f00db50c795",
"FieldId": "256ca412-03cd-488e-8ea0-4a9f2e9f22d7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "44cbff94-0747-4b8c-a53a-6f00db50c795",
"FieldId": "256ca412-03cd-488e-8ea0-4a9f2e9f22d7",
"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": "04c3e8bf-6252-4510-ae34-570d15f435b5",
"Section": {
"FormTypeSectionId": "a6708343-781a-4992-8b2d-5214e6c9b1ff",
"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": "0c5fb7cb-7283-453b-b1fc-88f53d9c9337",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d53a4631-e6ca-4ebb-b015-5acecc2a35c5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e670d2d-da9b-4b3a-ae29-2112a5dab705",
"CreateDate": "2026-04-26T20:46:33.7465311-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-26T20:46:33.7465311-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "44cbff94-0747-4b8c-a53a-6f00db50c795",
"FieldId": "256ca412-03cd-488e-8ea0-4a9f2e9f22d7",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "44cbff94-0747-4b8c-a53a-6f00db50c795",
"FieldId": "256ca412-03cd-488e-8ea0-4a9f2e9f22d7",
"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": "524b693b-f1c2-4db0-9595-d736f814adb6",
"CreateDate": "2026-04-26T20:46:33.7465311-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-26T20:46:33.7465311-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}