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": "61679514-1af4-4e65-96ae-73ea74612db0",
"Asset": {
"AssetId": "23ef8c26-b7b8-49a4-81a8-4d04846e53ee",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3b54c94f-2eab-4e12-a59c-0f0257504d6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "718b56b2-8565-4e33-8d46-bfd070d2c0bc",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "03bf060d-fa58-41d8-a928-ab52cc2b5942",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T19:05:05.8345131-08:00",
"MeasurementValueNeededDate": "2026-11-21T19:05:05.8345131-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4cc708cb-f79a-4400-a20b-0d4140cc618f",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-21T19:05:05.8345131-08:00",
"MeasurementValueNeededDate": "2026-11-21T19:05:05.8345131-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b46809e8-6e8d-40ea-a55f-793249951bc9",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "58b7380c-d408-475a-bd4f-4067803bc26a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3b54c94f-2eab-4e12-a59c-0f0257504d6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "718b56b2-8565-4e33-8d46-bfd070d2c0bc",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T19:05:05.8345131-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "705b844b-cecc-43b3-b1ba-0678b0935845",
"Section": {
"FormTypeSectionId": "3db5d5fc-4d4a-40b5-87d3-734aa9741705",
"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": "9015c783-1fe2-48ae-a958-d591d9d78f2a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8627d6e-f31d-454c-83fd-ed06f268728e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "74b8368d-9785-4e22-a356-0e4df2f57b36",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "705b844b-cecc-43b3-b1ba-0678b0935845",
"Section": {
"FormTypeSectionId": "3db5d5fc-4d4a-40b5-87d3-734aa9741705",
"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": "9015c783-1fe2-48ae-a958-d591d9d78f2a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8627d6e-f31d-454c-83fd-ed06f268728e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "74b8368d-9785-4e22-a356-0e4df2f57b36",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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 4",
"CompanyId": "2c351031-d25f-461c-ab8d-db0b52f4e43b",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-11-21T19:05:05.8345131-08:00",
"Location": "sample string 1",
"TaskId": "0f483605-c5f6-4cb6-a98e-617e59a8d9c1",
"Values": [
{
"FormFieldValueId": "02c51569-6a97-441c-b4f6-027240c098a4",
"FormId": "41c97814-7a14-47ae-a791-4e6fd5365b09",
"FormTypeField": {
"FormTypeFieldId": "705b844b-cecc-43b3-b1ba-0678b0935845",
"FormType": {
"FormTypeId": "58b7380c-d408-475a-bd4f-4067803bc26a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3b54c94f-2eab-4e12-a59c-0f0257504d6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "718b56b2-8565-4e33-8d46-bfd070d2c0bc",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T19:05:05.8345131-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "2c351031-d25f-461c-ab8d-db0b52f4e43b",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "3db5d5fc-4d4a-40b5-87d3-734aa9741705",
"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": "9015c783-1fe2-48ae-a958-d591d9d78f2a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8627d6e-f31d-454c-83fd-ed06f268728e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "74b8368d-9785-4e22-a356-0e4df2f57b36",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "02c51569-6a97-441c-b4f6-027240c098a4",
"FormId": "41c97814-7a14-47ae-a791-4e6fd5365b09",
"FormTypeField": {
"FormTypeFieldId": "705b844b-cecc-43b3-b1ba-0678b0935845",
"FormType": {
"FormTypeId": "58b7380c-d408-475a-bd4f-4067803bc26a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3b54c94f-2eab-4e12-a59c-0f0257504d6f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "718b56b2-8565-4e33-8d46-bfd070d2c0bc",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T19:05:05.8345131-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "2c351031-d25f-461c-ab8d-db0b52f4e43b",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "3db5d5fc-4d4a-40b5-87d3-734aa9741705",
"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": "9015c783-1fe2-48ae-a958-d591d9d78f2a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f8627d6e-f31d-454c-83fd-ed06f268728e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "74b8368d-9785-4e22-a356-0e4df2f57b36",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9317f7a-2dce-41ea-8ee2-3bc79a371c3f",
"FieldId": "ea283812-a3bc-4d02-bf35-6fdb4b35d072",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"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": "74dbc983-438e-44d5-a958-f084aca694bf",
"CreateDate": "2026-11-21T19:05:05.8345131-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T19:05:05.8345131-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}