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": "8f088851-bd2a-43ae-9cc8-af48a65ce790",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "04044a17-0e7e-441b-91f0-c18244553945",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c3e6e260-c336-42d8-ab8b-da2ea19c779a",
"CreateDate": "2026-11-16T18:56:33.9127826-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-16T18:56:33.9127826-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-16T18:56:33.9127826-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "3749bdd1-cffc-432b-92a6-d1fbffaba2d4",
"Section": {
"FormTypeSectionId": "f8b55043-5965-4465-893b-54ce267da79f",
"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": "5ce5b641-1af3-45c9-bbb2-e5fa0dc0c762",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6c5f70da-dbc7-43ec-9f1d-f65bd65c4d13",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "556bbc06-9cd2-467b-9373-090925847887",
"CreateDate": "2026-11-16T18:56:33.9127826-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T18:56:33.9127826-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d55859ef-a31a-4d57-b47b-0c37ae02db6b",
"FieldId": "cc5e2623-c195-478a-a559-c77cb55ecdf9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d55859ef-a31a-4d57-b47b-0c37ae02db6b",
"FieldId": "cc5e2623-c195-478a-a559-c77cb55ecdf9",
"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": "3749bdd1-cffc-432b-92a6-d1fbffaba2d4",
"Section": {
"FormTypeSectionId": "f8b55043-5965-4465-893b-54ce267da79f",
"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": "5ce5b641-1af3-45c9-bbb2-e5fa0dc0c762",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6c5f70da-dbc7-43ec-9f1d-f65bd65c4d13",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "556bbc06-9cd2-467b-9373-090925847887",
"CreateDate": "2026-11-16T18:56:33.9127826-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-16T18:56:33.9127826-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d55859ef-a31a-4d57-b47b-0c37ae02db6b",
"FieldId": "cc5e2623-c195-478a-a559-c77cb55ecdf9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d55859ef-a31a-4d57-b47b-0c37ae02db6b",
"FieldId": "cc5e2623-c195-478a-a559-c77cb55ecdf9",
"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": "bf08d8f7-cec2-4beb-b023-3b13b2552c60",
"CreateDate": "2026-11-16T18:56:33.9127826-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-16T18:56:33.9127826-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}