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": "c1f073b2-0179-47ac-a36f-7794f92fa8a4",
"Asset": {
"AssetId": "e3bdd314-84d8-424f-997d-990c40c3be9f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "832c9a40-4536-4966-be5b-38b7081b4fed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b14f0319-1302-4d13-9a78-a9261cd6c48a",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "528be7e7-b00b-4602-9ad4-5e7313005636",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-05T17:00:57.5314441-08:00",
"MeasurementValueNeededDate": "2026-02-05T17:00:57.5314441-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "edc4dc72-0962-4249-b04a-94831cfe0ac8",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-05T17:00:57.5314441-08:00",
"MeasurementValueNeededDate": "2026-02-05T17:00:57.5314441-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b1e3bd12-6142-4454-9732-4fea1df11a5a",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "aad49241-9de6-4585-989e-70497d94f0da",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "832c9a40-4536-4966-be5b-38b7081b4fed",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b14f0319-1302-4d13-9a78-a9261cd6c48a",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-05T17:00:57.5314441-08:00",
"Fields": [
{
"FormTypeFieldId": "30998c2d-b0f5-40b7-a4ff-f092c70c0ea0",
"Section": {
"FormTypeSectionId": "04e92823-156d-474e-adfa-9e437f0c602c",
"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": "d9755e88-ec70-4f0a-9b99-39e07d30409a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "242e2c98-66f0-4b61-8832-39423ac063ac",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c1605ee8-b4f6-46d7-910c-b713ad4d456d",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-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": "30998c2d-b0f5-40b7-a4ff-f092c70c0ea0",
"Section": {
"FormTypeSectionId": "04e92823-156d-474e-adfa-9e437f0c602c",
"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": "d9755e88-ec70-4f0a-9b99-39e07d30409a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "242e2c98-66f0-4b61-8832-39423ac063ac",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c1605ee8-b4f6-46d7-910c-b713ad4d456d",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-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": "c22d0001-3b67-4eee-9c62-64a1536008bf",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-02-05T17:00:57.5314441-08:00",
"Location": "sample string 1",
"TaskId": "37a6568f-7e3d-483a-870f-60328835edb3",
"Values": [
{
"FormFieldValueId": "cbed48c7-9d98-43d8-bc80-fb97283951cf",
"FormTypeField": {
"FormTypeFieldId": "30998c2d-b0f5-40b7-a4ff-f092c70c0ea0",
"Section": {
"FormTypeSectionId": "04e92823-156d-474e-adfa-9e437f0c602c",
"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": "d9755e88-ec70-4f0a-9b99-39e07d30409a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "242e2c98-66f0-4b61-8832-39423ac063ac",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c1605ee8-b4f6-46d7-910c-b713ad4d456d",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-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": "cbed48c7-9d98-43d8-bc80-fb97283951cf",
"FormTypeField": {
"FormTypeFieldId": "30998c2d-b0f5-40b7-a4ff-f092c70c0ea0",
"Section": {
"FormTypeSectionId": "04e92823-156d-474e-adfa-9e437f0c602c",
"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": "d9755e88-ec70-4f0a-9b99-39e07d30409a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "242e2c98-66f0-4b61-8832-39423ac063ac",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c1605ee8-b4f6-46d7-910c-b713ad4d456d",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-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": "8945e5f7-1e6c-4c3f-bb11-5ca4f557a30a",
"CreateDate": "2026-02-05T17:00:57.5314441-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-05T17:00:57.5314441-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}