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": "6d028d3f-c36e-4578-8594-968b5b4010c4",
"Asset": {
"AssetId": "023482b0-96b4-45e0-b9a4-a6ed6b9ddde2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "73a68916-1b3c-48d7-98fe-351d9d581400",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ad6c3c57-22a9-445f-b87a-d808d79e2700",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "544b3706-ac8f-4178-bc49-a7e6c93bfb91",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-16T04:56:11.4150642-07:00",
"MeasurementValueNeededDate": "2026-03-16T04:56:11.4150642-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f0af3b95-40a8-4d9f-bf90-4f892bd61ab8",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-16T04:56:11.4150642-07:00",
"MeasurementValueNeededDate": "2026-03-16T04:56:11.4150642-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9193fc0d-a455-479d-b721-53d4c7b0559f",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "f423cbd2-bfca-4adf-a21c-b4964afeab24",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "73a68916-1b3c-48d7-98fe-351d9d581400",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ad6c3c57-22a9-445f-b87a-d808d79e2700",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-16T04:56:11.4150642-07:00",
"Fields": [
{
"FormTypeFieldId": "19afdcdd-434d-40fb-9e8a-16e93a7bb2ed",
"Section": {
"FormTypeSectionId": "2b11c0a3-0b12-49c6-bd68-3a4e6e6e3684",
"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": "50454d5b-7736-4053-bafa-249d4b2ea0e3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d097a471-0654-4669-aa1b-fb29727a78a2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17a6abd2-8fd8-4022-b7de-7e56e24bc20c",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-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": "19afdcdd-434d-40fb-9e8a-16e93a7bb2ed",
"Section": {
"FormTypeSectionId": "2b11c0a3-0b12-49c6-bd68-3a4e6e6e3684",
"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": "50454d5b-7736-4053-bafa-249d4b2ea0e3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d097a471-0654-4669-aa1b-fb29727a78a2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17a6abd2-8fd8-4022-b7de-7e56e24bc20c",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-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": "ad951068-ed77-4b3c-8484-2ade12d48353",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-16T04:56:11.4150642-07:00",
"Location": "sample string 1",
"TaskId": "9ab6d96e-59e7-4de4-9fc7-89b03437524c",
"Values": [
{
"FormFieldValueId": "3a2ee816-39b6-4ff8-9247-bd71615c4a6a",
"FormTypeField": {
"FormTypeFieldId": "19afdcdd-434d-40fb-9e8a-16e93a7bb2ed",
"Section": {
"FormTypeSectionId": "2b11c0a3-0b12-49c6-bd68-3a4e6e6e3684",
"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": "50454d5b-7736-4053-bafa-249d4b2ea0e3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d097a471-0654-4669-aa1b-fb29727a78a2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17a6abd2-8fd8-4022-b7de-7e56e24bc20c",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-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": "3a2ee816-39b6-4ff8-9247-bd71615c4a6a",
"FormTypeField": {
"FormTypeFieldId": "19afdcdd-434d-40fb-9e8a-16e93a7bb2ed",
"Section": {
"FormTypeSectionId": "2b11c0a3-0b12-49c6-bd68-3a4e6e6e3684",
"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": "50454d5b-7736-4053-bafa-249d4b2ea0e3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d097a471-0654-4669-aa1b-fb29727a78a2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "17a6abd2-8fd8-4022-b7de-7e56e24bc20c",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-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": "e66020a9-3a83-4e3f-ad43-b1a7607e75e8",
"CreateDate": "2026-03-16T04:56:11.4150642-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-16T04:56:11.4150642-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}