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": "cb4318f8-47af-472d-8189-be7281966ea2",
"Asset": {
"AssetId": "927bfca6-4da8-4393-acc6-bfe3d831f025",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fe6fb55d-3e98-4278-aef5-051739390d70",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f1db3c6f-4d93-42f2-bfde-7a7102d4630c",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "f1dd2b85-d084-472b-acdf-4b57c2e72b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-23T16:35:36.5144272-07:00",
"MeasurementValueNeededDate": "2026-05-23T16:35:36.5144272-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "75c77a42-96ed-455f-9b60-d81f62a32ce5",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-23T16:35:36.5144272-07:00",
"MeasurementValueNeededDate": "2026-05-23T16:35:36.5144272-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1a2c410a-b5da-4f90-9ffa-e5ce3750df4b",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "79b316a9-7180-45f9-86cb-53cd24aaaea0",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fe6fb55d-3e98-4278-aef5-051739390d70",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f1db3c6f-4d93-42f2-bfde-7a7102d4630c",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-23T16:35:36.5144272-07:00",
"Fields": [
{
"FormTypeFieldId": "c78e7553-9a6e-49e2-b1df-270408c3c22c",
"Section": {
"FormTypeSectionId": "d318996e-58ec-426b-adf8-260cdaf47fea",
"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": "ea63d2b7-49e7-4127-ac17-c5be53be7422",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1e4e783b-fe57-4fee-a7d2-5e567b591da8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b949da3-df63-4d08-847c-6d1fc372f2d6",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-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": "c78e7553-9a6e-49e2-b1df-270408c3c22c",
"Section": {
"FormTypeSectionId": "d318996e-58ec-426b-adf8-260cdaf47fea",
"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": "ea63d2b7-49e7-4127-ac17-c5be53be7422",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1e4e783b-fe57-4fee-a7d2-5e567b591da8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b949da3-df63-4d08-847c-6d1fc372f2d6",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-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": "f4bf2d41-b560-4753-b2c6-27841e36b63a",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-23T16:35:36.5144272-07:00",
"Location": "sample string 1",
"TaskId": "5a1b314a-c5e8-4122-9588-e632041bbdb3",
"Values": [
{
"FormFieldValueId": "fa6e3066-1e3a-4d8c-a209-7d847c7f9f2c",
"FormTypeField": {
"FormTypeFieldId": "c78e7553-9a6e-49e2-b1df-270408c3c22c",
"Section": {
"FormTypeSectionId": "d318996e-58ec-426b-adf8-260cdaf47fea",
"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": "ea63d2b7-49e7-4127-ac17-c5be53be7422",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1e4e783b-fe57-4fee-a7d2-5e567b591da8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b949da3-df63-4d08-847c-6d1fc372f2d6",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-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": "fa6e3066-1e3a-4d8c-a209-7d847c7f9f2c",
"FormTypeField": {
"FormTypeFieldId": "c78e7553-9a6e-49e2-b1df-270408c3c22c",
"Section": {
"FormTypeSectionId": "d318996e-58ec-426b-adf8-260cdaf47fea",
"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": "ea63d2b7-49e7-4127-ac17-c5be53be7422",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1e4e783b-fe57-4fee-a7d2-5e567b591da8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b949da3-df63-4d08-847c-6d1fc372f2d6",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-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": "292002a0-4e8a-463a-8d47-978404955fd6",
"CreateDate": "2026-05-23T16:35:36.5144272-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-23T16:35:36.5144272-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}