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": "fa2a2eb7-ed5d-4857-8809-320cf2049d74",
"Asset": {
"AssetId": "fd521382-cb50-4feb-b174-c047ec541cb6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c0fd1d33-8e96-4ac5-950e-8524caaa6993",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "44ada32e-1833-4ce4-b3cc-c0a56cd4246f",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6f0151ea-f072-4e0b-ab72-14e3d25ca629",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-30T08:53:11.9557806-08:00",
"MeasurementValueNeededDate": "2025-12-30T08:53:11.9557806-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "37cd513c-db63-4d91-9ceb-f9c09c86ac18",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-30T08:53:11.9557806-08:00",
"MeasurementValueNeededDate": "2025-12-30T08:53:11.9557806-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fbf4aabf-703a-4704-973a-12e059f52576",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "d302747f-d929-4da9-93f1-62e130c72dfb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c0fd1d33-8e96-4ac5-950e-8524caaa6993",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "44ada32e-1833-4ce4-b3cc-c0a56cd4246f",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-30T08:53:11.9557806-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8b14cac3-d606-45a2-8460-21171b652359",
"Section": {
"FormTypeSectionId": "292fd4dd-6acf-4e66-91f0-9df3b9c679b1",
"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": "e1dfd58d-1db9-4247-9a9a-726e8a9ce379",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "409693a3-8d38-4f3d-8e8f-062fe9ca338e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1e9b6efc-2b95-46eb-ba0e-16f0d7500052",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"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": "8b14cac3-d606-45a2-8460-21171b652359",
"Section": {
"FormTypeSectionId": "292fd4dd-6acf-4e66-91f0-9df3b9c679b1",
"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": "e1dfd58d-1db9-4247-9a9a-726e8a9ce379",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "409693a3-8d38-4f3d-8e8f-062fe9ca338e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1e9b6efc-2b95-46eb-ba0e-16f0d7500052",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"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": "63c8cf0e-cc7e-4969-9392-1b47275e229e",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2025-12-30T08:53:11.9557806-08:00",
"Location": "sample string 1",
"TaskId": "3fd0fac3-7d3e-45e9-ba7f-8350223d0e73",
"Values": [
{
"FormFieldValueId": "b26d736a-5e29-4071-929d-97c8fb460ac7",
"FormId": "2b3775f2-10e2-48c8-8f59-dd944344988a",
"FormTypeField": {
"FormTypeFieldId": "8b14cac3-d606-45a2-8460-21171b652359",
"FormType": {
"FormTypeId": "d302747f-d929-4da9-93f1-62e130c72dfb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c0fd1d33-8e96-4ac5-950e-8524caaa6993",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "44ada32e-1833-4ce4-b3cc-c0a56cd4246f",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-30T08:53:11.9557806-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "63c8cf0e-cc7e-4969-9392-1b47275e229e",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "292fd4dd-6acf-4e66-91f0-9df3b9c679b1",
"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": "e1dfd58d-1db9-4247-9a9a-726e8a9ce379",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "409693a3-8d38-4f3d-8e8f-062fe9ca338e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1e9b6efc-2b95-46eb-ba0e-16f0d7500052",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"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": "b26d736a-5e29-4071-929d-97c8fb460ac7",
"FormId": "2b3775f2-10e2-48c8-8f59-dd944344988a",
"FormTypeField": {
"FormTypeFieldId": "8b14cac3-d606-45a2-8460-21171b652359",
"FormType": {
"FormTypeId": "d302747f-d929-4da9-93f1-62e130c72dfb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c0fd1d33-8e96-4ac5-950e-8524caaa6993",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "44ada32e-1833-4ce4-b3cc-c0a56cd4246f",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-30T08:53:11.9557806-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "63c8cf0e-cc7e-4969-9392-1b47275e229e",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "292fd4dd-6acf-4e66-91f0-9df3b9c679b1",
"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": "e1dfd58d-1db9-4247-9a9a-726e8a9ce379",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "409693a3-8d38-4f3d-8e8f-062fe9ca338e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1e9b6efc-2b95-46eb-ba0e-16f0d7500052",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6a4251df-234a-4bc1-a048-6eb57846d7d0",
"FieldId": "65ef82ee-7719-4ab2-bff7-b92c7032fd1d",
"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": "ee634c28-6503-4390-b56b-19404fa2519b",
"CreateDate": "2025-12-30T08:53:11.9557806-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-30T08:53:11.9557806-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}