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": "15893462-106f-4b66-880c-ac416086197c",
"Asset": {
"AssetId": "650641fe-06f2-4b11-9642-e5710cecb37e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "188ab4b6-7480-44fc-ac71-8503e5a1f6a0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c4b570b5-7f55-4b75-80d9-e5e6ce82af34",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9682ec26-4395-41cf-8924-64f288d3612a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-11T01:24:36.3215217-08:00",
"MeasurementValueNeededDate": "2026-02-11T01:24:36.3215217-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "983e7c1f-fef1-48c2-af27-88de6b941ee7",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-11T01:24:36.3215217-08:00",
"MeasurementValueNeededDate": "2026-02-11T01:24:36.3215217-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b5f650f3-3b6c-49c9-9f9e-cd8090f4e6b5",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "7e332d58-7abf-4e05-8d47-45ff22a833c9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "188ab4b6-7480-44fc-ac71-8503e5a1f6a0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c4b570b5-7f55-4b75-80d9-e5e6ce82af34",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-11T01:24:36.3215217-08:00",
"Fields": [
{
"FormTypeFieldId": "ce91f485-1b3e-4f1e-92d0-edb6c6e181e2",
"Section": {
"FormTypeSectionId": "04da4333-228b-4ef4-8848-f7366977090c",
"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": "e58acacd-6bb3-4c39-a5a4-d626a1e982b4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "00afbe5b-c480-4f1e-8657-32c431268d28",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ac852a61-dc52-46d4-8591-0c6e849aabab",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-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": "ce91f485-1b3e-4f1e-92d0-edb6c6e181e2",
"Section": {
"FormTypeSectionId": "04da4333-228b-4ef4-8848-f7366977090c",
"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": "e58acacd-6bb3-4c39-a5a4-d626a1e982b4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "00afbe5b-c480-4f1e-8657-32c431268d28",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ac852a61-dc52-46d4-8591-0c6e849aabab",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-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": "ec378473-aaee-40a9-b257-affcaf640f51",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-02-11T01:24:36.3215217-08:00",
"Location": "sample string 1",
"TaskId": "b5a781e3-dcac-443f-975b-0fe72674bd86",
"Values": [
{
"FormFieldValueId": "e0a677e5-c7d0-4bbf-a27a-1bbf882ff1a0",
"FormTypeField": {
"FormTypeFieldId": "ce91f485-1b3e-4f1e-92d0-edb6c6e181e2",
"Section": {
"FormTypeSectionId": "04da4333-228b-4ef4-8848-f7366977090c",
"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": "e58acacd-6bb3-4c39-a5a4-d626a1e982b4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "00afbe5b-c480-4f1e-8657-32c431268d28",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ac852a61-dc52-46d4-8591-0c6e849aabab",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-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": "e0a677e5-c7d0-4bbf-a27a-1bbf882ff1a0",
"FormTypeField": {
"FormTypeFieldId": "ce91f485-1b3e-4f1e-92d0-edb6c6e181e2",
"Section": {
"FormTypeSectionId": "04da4333-228b-4ef4-8848-f7366977090c",
"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": "e58acacd-6bb3-4c39-a5a4-d626a1e982b4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "00afbe5b-c480-4f1e-8657-32c431268d28",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ac852a61-dc52-46d4-8591-0c6e849aabab",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-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": "6dd9f455-c917-4d8f-b30b-a93d7c8554db",
"CreateDate": "2026-02-11T01:24:36.3215217-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-11T01:24:36.3215217-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}