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": "4334676d-6d45-4247-87e5-e9367c56e0de",
"Asset": {
"AssetId": "61d05aa5-9824-416f-9f74-c8fc2cb2fecf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4e98d129-fda0-4978-bb43-e1b4c3a83cd3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f001c425-18ad-45a7-b8cd-efa80df40fac",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "841efa3d-9fa6-4a0d-9252-be5febe818c4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-09T10:06:03.2722975-08:00",
"MeasurementValueNeededDate": "2025-11-09T10:06:03.2722975-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c4313534-c9b6-47dc-810b-2036ce72372c",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-09T10:06:03.2722975-08:00",
"MeasurementValueNeededDate": "2025-11-09T10:06:03.2722975-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "17fc7426-53e3-45b0-9957-a2c998120066",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "8ac1f57b-f2ff-4ae2-82e2-0579c0ebdf01",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "4e98d129-fda0-4978-bb43-e1b4c3a83cd3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f001c425-18ad-45a7-b8cd-efa80df40fac",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-09T10:06:03.2722975-08:00",
"Fields": [
{
"FormTypeFieldId": "f12603fb-c8b7-45d2-ab2f-623a1bff44be",
"Section": {
"FormTypeSectionId": "9363d8af-b786-4aa3-97cb-a903ee2e9a3c",
"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": "53e0793a-911c-4047-bdea-2d2e07e0501e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4e1f4e81-0e10-4657-98b0-f954d59d0f62",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97ae68c7-2b31-4d36-9735-48a7c16a7320",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08: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": "f12603fb-c8b7-45d2-ab2f-623a1bff44be",
"Section": {
"FormTypeSectionId": "9363d8af-b786-4aa3-97cb-a903ee2e9a3c",
"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": "53e0793a-911c-4047-bdea-2d2e07e0501e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4e1f4e81-0e10-4657-98b0-f954d59d0f62",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97ae68c7-2b31-4d36-9735-48a7c16a7320",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08: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": "72faab8b-9c0f-4dcf-9ce2-2227287c07a1",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-11-09T10:06:03.2722975-08:00",
"Location": "sample string 1",
"TaskId": "13c6e851-79a5-4b3a-b4a6-f3864e459363",
"Values": [
{
"FormFieldValueId": "f54bbc8d-137a-4b09-9e7a-fed71a519238",
"FormTypeField": {
"FormTypeFieldId": "f12603fb-c8b7-45d2-ab2f-623a1bff44be",
"Section": {
"FormTypeSectionId": "9363d8af-b786-4aa3-97cb-a903ee2e9a3c",
"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": "53e0793a-911c-4047-bdea-2d2e07e0501e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4e1f4e81-0e10-4657-98b0-f954d59d0f62",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97ae68c7-2b31-4d36-9735-48a7c16a7320",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08: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": "f54bbc8d-137a-4b09-9e7a-fed71a519238",
"FormTypeField": {
"FormTypeFieldId": "f12603fb-c8b7-45d2-ab2f-623a1bff44be",
"Section": {
"FormTypeSectionId": "9363d8af-b786-4aa3-97cb-a903ee2e9a3c",
"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": "53e0793a-911c-4047-bdea-2d2e07e0501e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4e1f4e81-0e10-4657-98b0-f954d59d0f62",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97ae68c7-2b31-4d36-9735-48a7c16a7320",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08: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": "15fd8d78-bec3-451a-b7c0-6b1ec4a819ac",
"CreateDate": "2025-11-09T10:06:03.2722975-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-09T10:06:03.2722975-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}