GET Forms?formId={formId}
Retrieves a form by its Id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| formId |
Id of the form |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Form |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormId": "565ea67b-4482-47ce-80e5-b44dd3f295ae",
"Asset": {
"AssetId": "8bd825e3-3847-40b6-a64d-001aab0cc237",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3234c8b6-613c-41ed-b6a5-c5dc2a078205",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d06115e-6ad9-443f-9b1e-5ff56d868041",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4d4eaed1-32c4-4eb1-aa47-377e16000f25",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T15:58:42.7950585-07:00",
"MeasurementValueNeededDate": "2026-03-13T15:58:42.7950585-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9dd98f1a-8c33-4bff-993d-3dc3aa97826a",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-13T15:58:42.7950585-07:00",
"MeasurementValueNeededDate": "2026-03-13T15:58:42.7950585-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "803e3392-856a-4d51-9237-08427d88e0ee",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "1f9cd60e-57ae-40ca-a085-11399f3d45a5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3234c8b6-613c-41ed-b6a5-c5dc2a078205",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d06115e-6ad9-443f-9b1e-5ff56d868041",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-13T15:58:42.7950585-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "14160999-8a12-4216-8962-f4ae3508d448",
"Section": {
"FormTypeSectionId": "f2a35ea0-37e8-47a6-912a-93e71709cef9",
"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": "79d0d7dc-ccca-4808-95de-3393c4a0bc97",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ed56c5c9-10b7-4357-8385-232f0c790705",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0d06e1d-150a-474f-9ff5-ad693ad9dbe5",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"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": "14160999-8a12-4216-8962-f4ae3508d448",
"Section": {
"FormTypeSectionId": "f2a35ea0-37e8-47a6-912a-93e71709cef9",
"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": "79d0d7dc-ccca-4808-95de-3393c4a0bc97",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ed56c5c9-10b7-4357-8385-232f0c790705",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0d06e1d-150a-474f-9ff5-ad693ad9dbe5",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"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": "d5750c5a-2c73-4e88-b688-c0f4ea4f08a5",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-03-13T15:58:42.7950585-07:00",
"Location": "sample string 1",
"TaskId": "d7518208-719e-45e5-946f-cb2a57352f9e",
"Values": [
{
"FormFieldValueId": "95b1dc31-53bc-41f5-9182-451e34f39101",
"FormId": "b2a62a08-a65c-4abb-ab8d-f69d1f4da936",
"FormTypeField": {
"FormTypeFieldId": "14160999-8a12-4216-8962-f4ae3508d448",
"FormType": {
"FormTypeId": "1f9cd60e-57ae-40ca-a085-11399f3d45a5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3234c8b6-613c-41ed-b6a5-c5dc2a078205",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d06115e-6ad9-443f-9b1e-5ff56d868041",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-13T15:58:42.7950585-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "d5750c5a-2c73-4e88-b688-c0f4ea4f08a5",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "f2a35ea0-37e8-47a6-912a-93e71709cef9",
"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": "79d0d7dc-ccca-4808-95de-3393c4a0bc97",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ed56c5c9-10b7-4357-8385-232f0c790705",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0d06e1d-150a-474f-9ff5-ad693ad9dbe5",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"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"
},
"SectionIndex": 1,
"FieldIndex": 1,
"FileName": "sample string 1",
"FileType": "sample string 2",
"FileSize": 1,
"FileContent": "QEA=",
"ValueText": "sample string 3",
"IsValid": true,
"IsValidMessage": "sample string 5",
"SourceSystemId": "sample string 6"
},
{
"FormFieldValueId": "95b1dc31-53bc-41f5-9182-451e34f39101",
"FormId": "b2a62a08-a65c-4abb-ab8d-f69d1f4da936",
"FormTypeField": {
"FormTypeFieldId": "14160999-8a12-4216-8962-f4ae3508d448",
"FormType": {
"FormTypeId": "1f9cd60e-57ae-40ca-a085-11399f3d45a5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3234c8b6-613c-41ed-b6a5-c5dc2a078205",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d06115e-6ad9-443f-9b1e-5ff56d868041",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-13T15:58:42.7950585-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "d5750c5a-2c73-4e88-b688-c0f4ea4f08a5",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "f2a35ea0-37e8-47a6-912a-93e71709cef9",
"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": "79d0d7dc-ccca-4808-95de-3393c4a0bc97",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ed56c5c9-10b7-4357-8385-232f0c790705",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b0d06e1d-150a-474f-9ff5-ad693ad9dbe5",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "302f1e8e-d70b-4d8c-9c70-80d87082d851",
"FieldId": "1854bc0e-cb94-4b6f-9874-ce0f87418099",
"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"
},
"SectionIndex": 1,
"FieldIndex": 1,
"FileName": "sample string 1",
"FileType": "sample string 2",
"FileSize": 1,
"FileContent": "QEA=",
"ValueText": "sample string 3",
"IsValid": true,
"IsValidMessage": "sample string 5",
"SourceSystemId": "sample string 6"
}
],
"SourceSystemId": "sample string 2",
"CompanyId": "4fccb3d5-f007-4e43-a867-afc48c476b57",
"CreateDate": "2026-03-13T15:58:42.7950585-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-13T15:58:42.7950585-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}