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": "b696ceef-1f9d-42d0-950d-7f7c3460c306",
"Asset": {
"AssetId": "65b6660e-fa55-4624-8c4d-618c1c5bd56a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "553ee66d-c4ee-4a52-be96-d989e8963c52",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98b93f14-ec82-45ec-9767-ecf82efc20ab",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "aa0cb6ee-b2ea-480e-aa0b-6264ae05e166",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-04T01:21:01.4986264-08:00",
"MeasurementValueNeededDate": "2026-03-04T01:21:01.4986264-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ca36735f-69a3-4234-afaa-1e8fcf17da47",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-04T01:21:01.4986264-08:00",
"MeasurementValueNeededDate": "2026-03-04T01:21:01.4986264-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9984159e-af44-4570-be95-94551c4ddd04",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "dcf67f94-5faf-47f7-ba81-4c2a954b0d9d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "553ee66d-c4ee-4a52-be96-d989e8963c52",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98b93f14-ec82-45ec-9767-ecf82efc20ab",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-04T01:21:01.4986264-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "c3cfa68e-3328-43f4-b005-8b3c8e4ecd46",
"Section": {
"FormTypeSectionId": "32b974a6-2196-40b2-a14f-ac4d791ad043",
"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": "e40b704c-33c9-47f4-9322-8ccd13933072",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "478fe036-5e1c-491f-9e2b-65e577a14b16",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f9daf927-43a7-4ca2-a33b-2fd9f6f3f475",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"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": "c3cfa68e-3328-43f4-b005-8b3c8e4ecd46",
"Section": {
"FormTypeSectionId": "32b974a6-2196-40b2-a14f-ac4d791ad043",
"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": "e40b704c-33c9-47f4-9322-8ccd13933072",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "478fe036-5e1c-491f-9e2b-65e577a14b16",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f9daf927-43a7-4ca2-a33b-2fd9f6f3f475",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"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": "3fceee6e-9c9b-459b-919a-1de463c023c0",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-03-04T01:21:01.4986264-08:00",
"Location": "sample string 1",
"TaskId": "4c9fed28-9cf2-4c3f-928d-4280cf11fd88",
"Values": [
{
"FormFieldValueId": "53feae5a-bf59-463b-8896-3185b96458fd",
"FormId": "e8b63035-c2dd-46c5-a19c-c02fbdbeefe1",
"FormTypeField": {
"FormTypeFieldId": "c3cfa68e-3328-43f4-b005-8b3c8e4ecd46",
"FormType": {
"FormTypeId": "dcf67f94-5faf-47f7-ba81-4c2a954b0d9d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "553ee66d-c4ee-4a52-be96-d989e8963c52",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98b93f14-ec82-45ec-9767-ecf82efc20ab",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-04T01:21:01.4986264-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "3fceee6e-9c9b-459b-919a-1de463c023c0",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "32b974a6-2196-40b2-a14f-ac4d791ad043",
"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": "e40b704c-33c9-47f4-9322-8ccd13933072",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "478fe036-5e1c-491f-9e2b-65e577a14b16",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f9daf927-43a7-4ca2-a33b-2fd9f6f3f475",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"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": "53feae5a-bf59-463b-8896-3185b96458fd",
"FormId": "e8b63035-c2dd-46c5-a19c-c02fbdbeefe1",
"FormTypeField": {
"FormTypeFieldId": "c3cfa68e-3328-43f4-b005-8b3c8e4ecd46",
"FormType": {
"FormTypeId": "dcf67f94-5faf-47f7-ba81-4c2a954b0d9d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "553ee66d-c4ee-4a52-be96-d989e8963c52",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98b93f14-ec82-45ec-9767-ecf82efc20ab",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-04T01:21:01.4986264-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "3fceee6e-9c9b-459b-919a-1de463c023c0",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "32b974a6-2196-40b2-a14f-ac4d791ad043",
"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": "e40b704c-33c9-47f4-9322-8ccd13933072",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "478fe036-5e1c-491f-9e2b-65e577a14b16",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f9daf927-43a7-4ca2-a33b-2fd9f6f3f475",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "39ac1998-5cd4-4631-8146-3c02ac773b93",
"FieldId": "6473917a-b7ee-4005-8879-f8acb9e52d3b",
"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": "62538850-18ec-47ee-8ad8-2088b4c32e55",
"CreateDate": "2026-03-04T01:21:01.4986264-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-04T01:21:01.4986264-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}