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": "942955a0-b6e9-46fc-8831-5f7a7bcdeab6",
"Asset": {
"AssetId": "92aab9ab-16e9-42e8-9b68-ace29db43642",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2a318d54-c13e-4bde-aff9-9e9548262744",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bc82f6f8-782b-4dc4-8e2d-a0af9683ea29",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4871a886-caac-4f1e-b23d-81728e4f51f1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T09:42:53.6475291-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:42:53.6475291-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f8e7b7cd-fc4f-485f-b402-f56aaf408199",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-28T09:42:53.6475291-07:00",
"MeasurementValueNeededDate": "2026-06-28T09:42:53.6475291-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d30bbc11-5f32-45b8-8293-334d24239d75",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "51c52675-63b8-4499-9b3a-dc8b1996fbfc",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2a318d54-c13e-4bde-aff9-9e9548262744",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bc82f6f8-782b-4dc4-8e2d-a0af9683ea29",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-28T09:42:53.6475291-07:00",
"Fields": [
{
"FormTypeFieldId": "266b0618-587c-402e-bea6-d50edadfc8d2",
"Section": {
"FormTypeSectionId": "56a89789-fd10-4ef9-937d-06c9fa54315c",
"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": "84ff810e-83ec-412c-96d7-e1d45fcaf1cc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dffe6235-acf8-45ae-a8b7-132f68ecd6e5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e282f69-4393-493a-8509-d3ce2fe7b3d4",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-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": "266b0618-587c-402e-bea6-d50edadfc8d2",
"Section": {
"FormTypeSectionId": "56a89789-fd10-4ef9-937d-06c9fa54315c",
"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": "84ff810e-83ec-412c-96d7-e1d45fcaf1cc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dffe6235-acf8-45ae-a8b7-132f68ecd6e5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e282f69-4393-493a-8509-d3ce2fe7b3d4",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-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": "02b0b19e-0330-4d3c-9ad4-c21919f7aa79",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-28T09:42:53.6475291-07:00",
"Location": "sample string 1",
"TaskId": "f785b04f-5355-4aab-9205-e26ad02a750b",
"Values": [
{
"FormFieldValueId": "d29ca7e9-0108-4cff-aab0-27fc75f0e4ec",
"FormTypeField": {
"FormTypeFieldId": "266b0618-587c-402e-bea6-d50edadfc8d2",
"Section": {
"FormTypeSectionId": "56a89789-fd10-4ef9-937d-06c9fa54315c",
"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": "84ff810e-83ec-412c-96d7-e1d45fcaf1cc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dffe6235-acf8-45ae-a8b7-132f68ecd6e5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e282f69-4393-493a-8509-d3ce2fe7b3d4",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-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": "d29ca7e9-0108-4cff-aab0-27fc75f0e4ec",
"FormTypeField": {
"FormTypeFieldId": "266b0618-587c-402e-bea6-d50edadfc8d2",
"Section": {
"FormTypeSectionId": "56a89789-fd10-4ef9-937d-06c9fa54315c",
"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": "84ff810e-83ec-412c-96d7-e1d45fcaf1cc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dffe6235-acf8-45ae-a8b7-132f68ecd6e5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e282f69-4393-493a-8509-d3ce2fe7b3d4",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-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": "e3b1fbdc-e728-4919-875e-f2ccae796cf5",
"CreateDate": "2026-06-28T09:42:53.6475291-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-28T09:42:53.6475291-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}