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": "ae37a29d-1022-4113-9902-672a7ee9f2e5",
"Asset": {
"AssetId": "b452c360-6eef-430b-92ad-359fa5ae56e5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "43f32472-3e96-4f58-a3ab-28a2091e182a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9920cd63-d198-4636-8822-160344648591",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a51df887-0dee-4470-b900-eb63a985ca2e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-03T08:09:45.3746854-08:00",
"MeasurementValueNeededDate": "2026-03-03T08:09:45.3746854-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "791e8d4a-c769-4d01-ae81-49662f61dc8b",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-03T08:09:45.3746854-08:00",
"MeasurementValueNeededDate": "2026-03-03T08:09:45.3746854-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "de917a4b-39aa-4160-a4fc-b06a1a547cad",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "bbdc0091-7c85-407e-a0ed-2f246021a61f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "43f32472-3e96-4f58-a3ab-28a2091e182a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9920cd63-d198-4636-8822-160344648591",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-03T08:09:45.3746854-08:00",
"Fields": [
{
"FormTypeFieldId": "51615e76-e57b-461c-ac42-a56e0712cf0e",
"Section": {
"FormTypeSectionId": "a69ab0c3-d3d2-4cc3-9dad-9988fc5bce96",
"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": "42e72d47-451c-4c42-85f5-7ed989acd5d2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b691c7dc-64ff-423d-a74e-6e54e1a1d4a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4b19f768-3f89-4ec1-ba7d-a4cba6ae0163",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-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": "51615e76-e57b-461c-ac42-a56e0712cf0e",
"Section": {
"FormTypeSectionId": "a69ab0c3-d3d2-4cc3-9dad-9988fc5bce96",
"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": "42e72d47-451c-4c42-85f5-7ed989acd5d2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b691c7dc-64ff-423d-a74e-6e54e1a1d4a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4b19f768-3f89-4ec1-ba7d-a4cba6ae0163",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-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": "276196ca-b8c2-4a58-91c1-2618dd2aaba6",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-03T08:09:45.3746854-08:00",
"Location": "sample string 1",
"TaskId": "45a7dff9-fe42-4b6f-a3b9-a7aa29eca543",
"Values": [
{
"FormFieldValueId": "894b4f1d-b6bd-4ec0-9f46-c2deafa40bd5",
"FormTypeField": {
"FormTypeFieldId": "51615e76-e57b-461c-ac42-a56e0712cf0e",
"Section": {
"FormTypeSectionId": "a69ab0c3-d3d2-4cc3-9dad-9988fc5bce96",
"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": "42e72d47-451c-4c42-85f5-7ed989acd5d2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b691c7dc-64ff-423d-a74e-6e54e1a1d4a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4b19f768-3f89-4ec1-ba7d-a4cba6ae0163",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-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": "894b4f1d-b6bd-4ec0-9f46-c2deafa40bd5",
"FormTypeField": {
"FormTypeFieldId": "51615e76-e57b-461c-ac42-a56e0712cf0e",
"Section": {
"FormTypeSectionId": "a69ab0c3-d3d2-4cc3-9dad-9988fc5bce96",
"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": "42e72d47-451c-4c42-85f5-7ed989acd5d2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b691c7dc-64ff-423d-a74e-6e54e1a1d4a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4b19f768-3f89-4ec1-ba7d-a4cba6ae0163",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-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": "d60075ef-d643-4fc0-9cc7-5a83ae4f38f9",
"CreateDate": "2026-03-03T08:09:45.3746854-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-03T08:09:45.3746854-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}