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": "938f1eb0-3a57-40d2-83dc-8ab1293a07d4",
"Asset": {
"AssetId": "71e19b5b-0082-4ac7-8148-b7ab9707f6e7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d7943c04-e158-4450-af9f-51b54f008944",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d222fe60-9afb-4b96-969f-dd4a919adcd8",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "58cfb92a-90f1-480f-9f96-4126a9d86838",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-15T23:47:51.3803041-08:00",
"MeasurementValueNeededDate": "2025-12-15T23:47:51.3803041-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "64d391e4-e1bb-4fbc-b59a-c3d445f74a8f",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-15T23:47:51.3803041-08:00",
"MeasurementValueNeededDate": "2025-12-15T23:47:51.3803041-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9b355e1b-13e5-4aac-8f93-88ed1d74fe20",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "8f54d22b-2e16-441f-a890-8f392947e716",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d7943c04-e158-4450-af9f-51b54f008944",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d222fe60-9afb-4b96-969f-dd4a919adcd8",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-15T23:47:51.3803041-08:00",
"Fields": [
{
"FormTypeFieldId": "98ca2a09-546b-4e9f-a8f7-4140ba0bb99d",
"Section": {
"FormTypeSectionId": "1bb2531f-4abc-4432-99c2-1338823f354d",
"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": "a81636a4-ece2-4c80-a1a4-b2f99d5af872",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "92840d3e-8a51-4563-909c-5e8c0de33a12",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17797e07-3caf-4e97-95f4-691885f1216a",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "98ca2a09-546b-4e9f-a8f7-4140ba0bb99d",
"Section": {
"FormTypeSectionId": "1bb2531f-4abc-4432-99c2-1338823f354d",
"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": "a81636a4-ece2-4c80-a1a4-b2f99d5af872",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "92840d3e-8a51-4563-909c-5e8c0de33a12",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17797e07-3caf-4e97-95f4-691885f1216a",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "170fc4ad-d6d3-4f8d-a0a1-64f9eb6e352b",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-12-15T23:47:51.3803041-08:00",
"Location": "sample string 1",
"TaskId": "10e2e85a-c4f9-4de4-b31e-c8f9bbe9063b",
"Values": [
{
"FormFieldValueId": "485d8b1b-1f5d-40ac-aa21-9be5e70ffee4",
"FormTypeField": {
"FormTypeFieldId": "98ca2a09-546b-4e9f-a8f7-4140ba0bb99d",
"Section": {
"FormTypeSectionId": "1bb2531f-4abc-4432-99c2-1338823f354d",
"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": "a81636a4-ece2-4c80-a1a4-b2f99d5af872",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "92840d3e-8a51-4563-909c-5e8c0de33a12",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17797e07-3caf-4e97-95f4-691885f1216a",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "485d8b1b-1f5d-40ac-aa21-9be5e70ffee4",
"FormTypeField": {
"FormTypeFieldId": "98ca2a09-546b-4e9f-a8f7-4140ba0bb99d",
"Section": {
"FormTypeSectionId": "1bb2531f-4abc-4432-99c2-1338823f354d",
"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": "a81636a4-ece2-4c80-a1a4-b2f99d5af872",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "92840d3e-8a51-4563-909c-5e8c0de33a12",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17797e07-3caf-4e97-95f4-691885f1216a",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "9bfd3a6e-f82f-4a3d-a631-29fecf6303c4",
"CreateDate": "2025-12-15T23:47:51.3803041-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-15T23:47:51.3803041-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}