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": "83857944-b88c-47b4-a709-e9168f0802c8",
"Asset": {
"AssetId": "f3899fad-1c21-4938-bf52-a4fb71955252",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8b8e737a-26e5-4eb2-bd4a-9accfbe4c8d2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b8c6925b-f02c-4c84-a02a-f7f2ddb959a2",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "d4917f4c-b43d-4590-a695-87e7d30029ea",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T13:04:42.3248684-07:00",
"MeasurementValueNeededDate": "2026-10-04T13:04:42.3248684-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "36203bfd-a693-426e-86d1-c7dd510e717b",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-04T13:04:42.3248684-07:00",
"MeasurementValueNeededDate": "2026-10-04T13:04:42.3248684-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ad07b88c-da2c-43c8-aad2-3d5a2bb83bea",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "6962d1e3-8d0b-4ae8-a116-0071d7303172",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8b8e737a-26e5-4eb2-bd4a-9accfbe4c8d2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b8c6925b-f02c-4c84-a02a-f7f2ddb959a2",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-04T13:04:42.3248684-07:00",
"Fields": [
{
"FormTypeFieldId": "c3b11799-d610-4e9f-942c-5c2ce81ea13e",
"Section": {
"FormTypeSectionId": "9749dc31-bb1e-4c69-befa-82b27ef14ac9",
"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": "28155d21-0e18-4b49-bb3b-ae9bd24b5fb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f84f45e9-5fb4-4638-85a3-14008e8152cc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1877a05c-dcb5-4dc7-a0ae-a744ac38d2f9",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-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": "c3b11799-d610-4e9f-942c-5c2ce81ea13e",
"Section": {
"FormTypeSectionId": "9749dc31-bb1e-4c69-befa-82b27ef14ac9",
"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": "28155d21-0e18-4b49-bb3b-ae9bd24b5fb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f84f45e9-5fb4-4638-85a3-14008e8152cc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1877a05c-dcb5-4dc7-a0ae-a744ac38d2f9",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-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": "44718291-91c9-4791-a7d1-c21ba2f23658",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-10-04T13:04:42.3248684-07:00",
"Location": "sample string 1",
"TaskId": "33c02c4e-3443-4f04-9216-fc04e1d262ac",
"Values": [
{
"FormFieldValueId": "e9b96e97-ac00-4bc9-9d2f-771921768459",
"FormTypeField": {
"FormTypeFieldId": "c3b11799-d610-4e9f-942c-5c2ce81ea13e",
"Section": {
"FormTypeSectionId": "9749dc31-bb1e-4c69-befa-82b27ef14ac9",
"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": "28155d21-0e18-4b49-bb3b-ae9bd24b5fb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f84f45e9-5fb4-4638-85a3-14008e8152cc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1877a05c-dcb5-4dc7-a0ae-a744ac38d2f9",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-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": "e9b96e97-ac00-4bc9-9d2f-771921768459",
"FormTypeField": {
"FormTypeFieldId": "c3b11799-d610-4e9f-942c-5c2ce81ea13e",
"Section": {
"FormTypeSectionId": "9749dc31-bb1e-4c69-befa-82b27ef14ac9",
"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": "28155d21-0e18-4b49-bb3b-ae9bd24b5fb3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f84f45e9-5fb4-4638-85a3-14008e8152cc",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1877a05c-dcb5-4dc7-a0ae-a744ac38d2f9",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-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": "5b34bf8e-bdb7-4044-ac00-dcb974229935",
"CreateDate": "2026-10-04T13:04:42.3248684-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T13:04:42.3248684-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}