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": "c9844fae-44cf-4e0d-9da4-cf8fcfb3e62e",
"Asset": {
"AssetId": "d4ab7c46-6fc4-451a-bd93-0a6d50a73d8f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "59388e54-8603-48b4-80e3-1219a8f9eacd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "80916408-cef9-4e4a-9dda-a20d9eba988b",
"CreateDate": "2025-11-23T05:02:17.5741827-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-23T05:02:17.5741827-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "54868d78-5ee5-440d-be4b-4b02657e1926",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-23T05:02:17.5741827-08:00",
"MeasurementValueNeededDate": "2025-11-23T05:02:17.5741827-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ec4b137d-b53c-4b3e-8e57-d6b74387014e",
"CreateDate": "2025-11-23T05:02:17.5741827-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-23T05:02:17.5741827-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-23T05:02:17.5741827-08:00",
"MeasurementValueNeededDate": "2025-11-23T05:02:17.5741827-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ae5e3f08-fa9a-4010-ba0c-426ccba621d8",
"CreateDate": "2025-11-23T05:02:17.5741827-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-23T05:02:17.5741827-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "05b7d9f1-d1ab-434d-a87e-743b68b68e8f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "59388e54-8603-48b4-80e3-1219a8f9eacd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "80916408-cef9-4e4a-9dda-a20d9eba988b",
"CreateDate": "2025-11-23T05:02:17.5741827-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-23T05:02:17.5741827-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-23T05:02:17.5741827-08:00",
"Fields": [
{
"FormTypeFieldId": "79d99c81-4b4c-4848-9900-e953a4bfade8",
"Section": {
"FormTypeSectionId": "0e70ac81-0cce-408e-9d11-18f290bf1e35",
"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": "f383ad15-56a3-491d-b32d-28566ca16b0f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ef4dbcb3-896e-4523-9cbf-f5877f09390c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea75018b-8172-4658-b076-c6ee721c5d0b",
"CreateDate": "2025-11-23T05:02:17.5898062-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-23T05:02:17.5898062-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": "79d99c81-4b4c-4848-9900-e953a4bfade8",
"Section": {
"FormTypeSectionId": "0e70ac81-0cce-408e-9d11-18f290bf1e35",
"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": "f383ad15-56a3-491d-b32d-28566ca16b0f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ef4dbcb3-896e-4523-9cbf-f5877f09390c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea75018b-8172-4658-b076-c6ee721c5d0b",
"CreateDate": "2025-11-23T05:02:17.5898062-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-23T05:02:17.5898062-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": "9a060773-5625-4bc5-bfc0-93fa90ec612d",
"CreateDate": "2025-11-23T05:02:17.5898062-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-23T05:02:17.5898062-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-11-23T05:02:17.5898062-08:00",
"Location": "sample string 1",
"TaskId": "81ff1ed5-8a1d-4566-b07b-f0ed34aab33e",
"Values": [
{
"FormFieldValueId": "d8866af6-534d-4745-9f98-c31942359a60",
"FormTypeField": {
"FormTypeFieldId": "79d99c81-4b4c-4848-9900-e953a4bfade8",
"Section": {
"FormTypeSectionId": "0e70ac81-0cce-408e-9d11-18f290bf1e35",
"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": "f383ad15-56a3-491d-b32d-28566ca16b0f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ef4dbcb3-896e-4523-9cbf-f5877f09390c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea75018b-8172-4658-b076-c6ee721c5d0b",
"CreateDate": "2025-11-23T05:02:17.5898062-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-23T05:02:17.5898062-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": "d8866af6-534d-4745-9f98-c31942359a60",
"FormTypeField": {
"FormTypeFieldId": "79d99c81-4b4c-4848-9900-e953a4bfade8",
"Section": {
"FormTypeSectionId": "0e70ac81-0cce-408e-9d11-18f290bf1e35",
"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": "f383ad15-56a3-491d-b32d-28566ca16b0f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ef4dbcb3-896e-4523-9cbf-f5877f09390c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea75018b-8172-4658-b076-c6ee721c5d0b",
"CreateDate": "2025-11-23T05:02:17.5898062-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-23T05:02:17.5898062-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": "0179cce5-fdd6-491a-85d6-5bd807b5c529",
"CreateDate": "2025-11-23T05:02:17.5898062-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-23T05:02:17.5898062-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}