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": "cad947be-73cb-494e-98fb-809bb322f611",
"Asset": {
"AssetId": "ad2d2457-41b4-4a71-a720-91a445ca2ef3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c89f4f13-655b-45db-9754-238ea1c31f63",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1720e1ad-d41f-4a02-b87b-f3c5c7e76b02",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4c92208a-2851-401e-9a2b-031bbbbb0a3b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-16T07:36:05.1823659-07:00",
"MeasurementValueNeededDate": "2026-08-16T07:36:05.1823659-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f8182ca3-5c6b-4f23-9c29-96d25b13dbe3",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-16T07:36:05.1823659-07:00",
"MeasurementValueNeededDate": "2026-08-16T07:36:05.1823659-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2f396994-73c8-48f3-b59a-30e644da5916",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "0be52295-67e1-43dc-ad00-da38d0e0ad7c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c89f4f13-655b-45db-9754-238ea1c31f63",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1720e1ad-d41f-4a02-b87b-f3c5c7e76b02",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-16T07:36:05.1823659-07:00",
"Fields": [
{
"FormTypeFieldId": "0779b022-a262-4e5e-8b96-d31f91379c11",
"Section": {
"FormTypeSectionId": "c1ef40d2-8fcd-4c0a-b4fe-8a28da469348",
"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": "a1096d10-9016-4ef2-a572-285d3feebad5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "17ad659a-545a-403a-b1e0-23a374fc4316",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b260468d-88a8-42b6-957c-d63f120ed458",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-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": "0779b022-a262-4e5e-8b96-d31f91379c11",
"Section": {
"FormTypeSectionId": "c1ef40d2-8fcd-4c0a-b4fe-8a28da469348",
"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": "a1096d10-9016-4ef2-a572-285d3feebad5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "17ad659a-545a-403a-b1e0-23a374fc4316",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b260468d-88a8-42b6-957c-d63f120ed458",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-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": "7ba4a6af-2512-4ecd-a529-9c682993946f",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-08-16T07:36:05.1823659-07:00",
"Location": "sample string 1",
"TaskId": "916d64e1-f99e-44e9-9e1f-2d46897d6d7a",
"Values": [
{
"FormFieldValueId": "b98ca64a-32cf-48bd-ba99-3440d067e3e5",
"FormTypeField": {
"FormTypeFieldId": "0779b022-a262-4e5e-8b96-d31f91379c11",
"Section": {
"FormTypeSectionId": "c1ef40d2-8fcd-4c0a-b4fe-8a28da469348",
"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": "a1096d10-9016-4ef2-a572-285d3feebad5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "17ad659a-545a-403a-b1e0-23a374fc4316",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b260468d-88a8-42b6-957c-d63f120ed458",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-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": "b98ca64a-32cf-48bd-ba99-3440d067e3e5",
"FormTypeField": {
"FormTypeFieldId": "0779b022-a262-4e5e-8b96-d31f91379c11",
"Section": {
"FormTypeSectionId": "c1ef40d2-8fcd-4c0a-b4fe-8a28da469348",
"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": "a1096d10-9016-4ef2-a572-285d3feebad5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "17ad659a-545a-403a-b1e0-23a374fc4316",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b260468d-88a8-42b6-957c-d63f120ed458",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-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": "f2d7416e-f932-4b0c-99a3-e18c28ab8caa",
"CreateDate": "2026-08-16T07:36:05.1823659-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-16T07:36:05.1823659-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}