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": "3f8ada88-d01b-4a52-b8da-00acab9d2d97",
"Asset": {
"AssetId": "5747578b-14b7-4dc5-9f7d-1ec4613c9e57",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ddc0c985-b0ee-4f6c-aaa0-92dbb6b86130",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fa78e1fc-c526-41a2-a2df-65ddd77eabb5",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "44a788cc-64e4-4d3b-8550-083d628561a2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-30T17:48:55.9804621-08:00",
"MeasurementValueNeededDate": "2025-11-30T17:48:55.9804621-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fddc8193-4915-4b0e-b5ad-a548c5576d7c",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-30T17:48:55.9804621-08:00",
"MeasurementValueNeededDate": "2025-11-30T17:48:55.9804621-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3102f1e0-f59e-40ee-888f-18afc3d6940d",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "b380520a-a009-49e8-9835-ee8d456be8e7",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ddc0c985-b0ee-4f6c-aaa0-92dbb6b86130",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fa78e1fc-c526-41a2-a2df-65ddd77eabb5",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-30T17:48:55.9804621-08:00",
"Fields": [
{
"FormTypeFieldId": "80491be3-9e1b-40c1-bfcf-78899d1607f4",
"Section": {
"FormTypeSectionId": "5827ec54-8005-4214-a291-8fb18af19ef3",
"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": "479db539-8720-4d2e-b78a-f8409cb2923c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67f45bca-a27c-4ef3-aec2-0a10fb6d8861",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "76ae69ef-b83c-46a1-be89-c643e2b1ab09",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-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": "80491be3-9e1b-40c1-bfcf-78899d1607f4",
"Section": {
"FormTypeSectionId": "5827ec54-8005-4214-a291-8fb18af19ef3",
"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": "479db539-8720-4d2e-b78a-f8409cb2923c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67f45bca-a27c-4ef3-aec2-0a10fb6d8861",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "76ae69ef-b83c-46a1-be89-c643e2b1ab09",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-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": "d9b59a52-ffdc-496f-b1a6-85992e98c8a5",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-11-30T17:48:55.9804621-08:00",
"Location": "sample string 1",
"TaskId": "36f09575-1ca2-464d-a9af-74df4b851164",
"Values": [
{
"FormFieldValueId": "1bd73abc-6c46-47cd-86a3-c218e374ef21",
"FormTypeField": {
"FormTypeFieldId": "80491be3-9e1b-40c1-bfcf-78899d1607f4",
"Section": {
"FormTypeSectionId": "5827ec54-8005-4214-a291-8fb18af19ef3",
"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": "479db539-8720-4d2e-b78a-f8409cb2923c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67f45bca-a27c-4ef3-aec2-0a10fb6d8861",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "76ae69ef-b83c-46a1-be89-c643e2b1ab09",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-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": "1bd73abc-6c46-47cd-86a3-c218e374ef21",
"FormTypeField": {
"FormTypeFieldId": "80491be3-9e1b-40c1-bfcf-78899d1607f4",
"Section": {
"FormTypeSectionId": "5827ec54-8005-4214-a291-8fb18af19ef3",
"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": "479db539-8720-4d2e-b78a-f8409cb2923c",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "67f45bca-a27c-4ef3-aec2-0a10fb6d8861",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "76ae69ef-b83c-46a1-be89-c643e2b1ab09",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-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": "906be69e-0ad6-4728-bb9b-4e0935e8df24",
"CreateDate": "2025-11-30T17:48:55.9804621-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-30T17:48:55.9804621-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}