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": "6b6e0f07-2514-4d2e-93e7-689733ef4cc2",
"Asset": {
"AssetId": "165a2029-a574-43f6-a82b-d6c35aba3193",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d4d1e058-6983-4b59-8bb9-aba6fcb4bd84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9eb64e62-c7d3-47a0-b451-81366f534c60",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5f3d1f25-4adf-463c-9f22-8d150159f695",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-10T08:35:06.5831897-07:00",
"MeasurementValueNeededDate": "2026-06-10T08:35:06.5831897-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d53aad9f-b06a-46d2-9303-d3191eec5d9c",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-10T08:35:06.5831897-07:00",
"MeasurementValueNeededDate": "2026-06-10T08:35:06.5831897-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5eaa6c77-77f1-433d-9edf-51082aba5d11",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "b37697ee-bd16-4b2f-bf71-dd939e3da2d3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d4d1e058-6983-4b59-8bb9-aba6fcb4bd84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9eb64e62-c7d3-47a0-b451-81366f534c60",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-10T08:35:06.5831897-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "da643f02-cfe0-43ae-9a7a-b504466eb9b6",
"Section": {
"FormTypeSectionId": "f23c6ade-aafc-4b21-b7d8-5f0ef137351f",
"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": "1d8ca558-f8cf-4736-b48c-dcb38241cfeb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80b5232a-c006-48be-8d7a-cfbed14ad058",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6a0a7db9-d403-423a-ba82-a4a5d4e932f6",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"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": "da643f02-cfe0-43ae-9a7a-b504466eb9b6",
"Section": {
"FormTypeSectionId": "f23c6ade-aafc-4b21-b7d8-5f0ef137351f",
"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": "1d8ca558-f8cf-4736-b48c-dcb38241cfeb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80b5232a-c006-48be-8d7a-cfbed14ad058",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6a0a7db9-d403-423a-ba82-a4a5d4e932f6",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"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": "08f4f5dd-6d08-4814-9a3b-4651c4e0f75a",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-06-10T08:35:06.5831897-07:00",
"Location": "sample string 1",
"TaskId": "c553e3a7-ff00-46dc-a2e5-ea4184c498cb",
"Values": [
{
"FormFieldValueId": "05cba74f-e19d-4f78-be12-35f24fe5f7eb",
"FormId": "99b98784-0431-47b8-982c-a06b624ff2fc",
"FormTypeField": {
"FormTypeFieldId": "da643f02-cfe0-43ae-9a7a-b504466eb9b6",
"FormType": {
"FormTypeId": "b37697ee-bd16-4b2f-bf71-dd939e3da2d3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d4d1e058-6983-4b59-8bb9-aba6fcb4bd84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9eb64e62-c7d3-47a0-b451-81366f534c60",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-10T08:35:06.5831897-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "08f4f5dd-6d08-4814-9a3b-4651c4e0f75a",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "f23c6ade-aafc-4b21-b7d8-5f0ef137351f",
"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": "1d8ca558-f8cf-4736-b48c-dcb38241cfeb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80b5232a-c006-48be-8d7a-cfbed14ad058",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6a0a7db9-d403-423a-ba82-a4a5d4e932f6",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"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": "05cba74f-e19d-4f78-be12-35f24fe5f7eb",
"FormId": "99b98784-0431-47b8-982c-a06b624ff2fc",
"FormTypeField": {
"FormTypeFieldId": "da643f02-cfe0-43ae-9a7a-b504466eb9b6",
"FormType": {
"FormTypeId": "b37697ee-bd16-4b2f-bf71-dd939e3da2d3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d4d1e058-6983-4b59-8bb9-aba6fcb4bd84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9eb64e62-c7d3-47a0-b451-81366f534c60",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-10T08:35:06.5831897-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "08f4f5dd-6d08-4814-9a3b-4651c4e0f75a",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "f23c6ade-aafc-4b21-b7d8-5f0ef137351f",
"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": "1d8ca558-f8cf-4736-b48c-dcb38241cfeb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80b5232a-c006-48be-8d7a-cfbed14ad058",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6a0a7db9-d403-423a-ba82-a4a5d4e932f6",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "23465655-e3ad-47ac-9eb5-51e03ca567c9",
"FieldId": "34f8bb71-8e4a-4fdd-b86f-fbc5d41abde1",
"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": "97262f63-5f0f-43eb-b99b-5cc3a794db76",
"CreateDate": "2026-06-10T08:35:06.5831897-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-10T08:35:06.5831897-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}