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": "ccc05baa-9875-4703-ade5-8f8d2ac32b49",
"Asset": {
"AssetId": "4b349b8c-f5c6-4501-a619-31b7e631b3bc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "dc28a071-35f6-476e-ae1d-941eb2a66649",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1f63931d-f7e2-4a4b-9461-4c8697d5fabf",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ad89ee20-8b88-468e-9b70-5a72ac29fd1d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T10:33:43.5607666-07:00",
"MeasurementValueNeededDate": "2026-06-28T10:33:43.5607666-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8330dde3-52c7-40cd-99cb-754e69a64004",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-28T10:33:43.5607666-07:00",
"MeasurementValueNeededDate": "2026-06-28T10:33:43.5607666-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a56dcfe3-ca61-4011-ae9d-8169a1654ee7",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "bee792f7-f85c-4778-8fa0-fdf3c8c73525",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "dc28a071-35f6-476e-ae1d-941eb2a66649",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1f63931d-f7e2-4a4b-9461-4c8697d5fabf",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-28T10:33:43.5607666-07:00",
"Fields": [
{
"FormTypeFieldId": "b62e4cc6-c7e0-4ed2-9bd1-21938b5a62c7",
"Section": {
"FormTypeSectionId": "36913ba9-8a16-467d-87b2-adf721badd31",
"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": "0817ef5b-3f46-4588-a5e5-10a67fbd1be9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5a7b22f2-548e-4c48-8e1c-3cf1768d1e1d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2003117b-61d9-401c-843c-a7890034e695",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-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": "b62e4cc6-c7e0-4ed2-9bd1-21938b5a62c7",
"Section": {
"FormTypeSectionId": "36913ba9-8a16-467d-87b2-adf721badd31",
"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": "0817ef5b-3f46-4588-a5e5-10a67fbd1be9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5a7b22f2-548e-4c48-8e1c-3cf1768d1e1d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2003117b-61d9-401c-843c-a7890034e695",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-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": "c7bf1bdf-93e6-42e4-b8be-e1ec899a07b2",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-28T10:33:43.5607666-07:00",
"Location": "sample string 1",
"TaskId": "7c271de4-d357-4671-ad4e-df718cbfdd56",
"Values": [
{
"FormFieldValueId": "c9209b99-4087-47e4-8b3b-e618114ecb7e",
"FormTypeField": {
"FormTypeFieldId": "b62e4cc6-c7e0-4ed2-9bd1-21938b5a62c7",
"Section": {
"FormTypeSectionId": "36913ba9-8a16-467d-87b2-adf721badd31",
"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": "0817ef5b-3f46-4588-a5e5-10a67fbd1be9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5a7b22f2-548e-4c48-8e1c-3cf1768d1e1d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2003117b-61d9-401c-843c-a7890034e695",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-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": "c9209b99-4087-47e4-8b3b-e618114ecb7e",
"FormTypeField": {
"FormTypeFieldId": "b62e4cc6-c7e0-4ed2-9bd1-21938b5a62c7",
"Section": {
"FormTypeSectionId": "36913ba9-8a16-467d-87b2-adf721badd31",
"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": "0817ef5b-3f46-4588-a5e5-10a67fbd1be9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5a7b22f2-548e-4c48-8e1c-3cf1768d1e1d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2003117b-61d9-401c-843c-a7890034e695",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-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": "77c60b04-7f0b-4566-a85a-4b08d400f3c7",
"CreateDate": "2026-06-28T10:33:43.5607666-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T10:33:43.5607666-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}