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": "e9eecf26-758f-4ef9-8a0a-21351f4f19fa",
"Asset": {
"AssetId": "3ae810d8-da22-4d2a-bc76-70b01db837ff",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "cacd47bf-7355-468f-b51f-2f2f30b8d3e4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "006f5be6-9337-4e81-8369-f3f2b5e69515",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "46b21288-9443-446d-b5d9-e8397768ac8b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-23T08:29:25.4667712-07:00",
"MeasurementValueNeededDate": "2026-08-23T08:29:25.4667712-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "203d5b73-ad14-4b46-80bf-f685ebd3b23f",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-23T08:29:25.4667712-07:00",
"MeasurementValueNeededDate": "2026-08-23T08:29:25.4667712-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fee6ea78-8cb2-4f6b-8842-448525fd6ad1",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "6f866a62-0870-41be-b966-bc38cbea4a8e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cacd47bf-7355-468f-b51f-2f2f30b8d3e4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "006f5be6-9337-4e81-8369-f3f2b5e69515",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-23T08:29:25.4667712-07:00",
"Fields": [
{
"FormTypeFieldId": "6dbf2769-34ec-439e-9a8e-2a331a416046",
"Section": {
"FormTypeSectionId": "1aabe8ae-7891-4fcf-bc12-898e8b7f1127",
"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": "2e5f0d8e-5c04-425b-8ea1-e53e01342524",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04dc50b5-c0c7-4793-bdeb-144024bb54c4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "52fa177d-c1ff-4fde-a33b-b71efd302cab",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07: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": "6dbf2769-34ec-439e-9a8e-2a331a416046",
"Section": {
"FormTypeSectionId": "1aabe8ae-7891-4fcf-bc12-898e8b7f1127",
"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": "2e5f0d8e-5c04-425b-8ea1-e53e01342524",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04dc50b5-c0c7-4793-bdeb-144024bb54c4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "52fa177d-c1ff-4fde-a33b-b71efd302cab",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07: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": "ac927193-55ae-4ba8-a42a-c2b1fbd2f9a4",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-08-23T08:29:25.4667712-07:00",
"Location": "sample string 1",
"TaskId": "8ed93484-b268-4c44-9158-6255749ee102",
"Values": [
{
"FormFieldValueId": "cac4ab8e-0d03-436b-8b1e-183e5ba1e393",
"FormTypeField": {
"FormTypeFieldId": "6dbf2769-34ec-439e-9a8e-2a331a416046",
"Section": {
"FormTypeSectionId": "1aabe8ae-7891-4fcf-bc12-898e8b7f1127",
"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": "2e5f0d8e-5c04-425b-8ea1-e53e01342524",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04dc50b5-c0c7-4793-bdeb-144024bb54c4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "52fa177d-c1ff-4fde-a33b-b71efd302cab",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07: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": "cac4ab8e-0d03-436b-8b1e-183e5ba1e393",
"FormTypeField": {
"FormTypeFieldId": "6dbf2769-34ec-439e-9a8e-2a331a416046",
"Section": {
"FormTypeSectionId": "1aabe8ae-7891-4fcf-bc12-898e8b7f1127",
"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": "2e5f0d8e-5c04-425b-8ea1-e53e01342524",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04dc50b5-c0c7-4793-bdeb-144024bb54c4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "52fa177d-c1ff-4fde-a33b-b71efd302cab",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07: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": "ec74c611-e515-48fe-af53-6fa93c1d5161",
"CreateDate": "2026-08-23T08:29:25.4667712-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-23T08:29:25.4667712-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}