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": "aed3879b-189e-4cee-97cc-633347645d46",
"Asset": {
"AssetId": "1983a7f4-c4eb-467d-a28d-9e2c21834d8a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5c4572c0-f4ac-4d2f-b63d-67fd67d6a49d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d80ef79c-0948-448d-9682-d72cd82b941c",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "afcedd4d-e235-4f9e-8b07-fa437480ff8f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-30T11:50:32.2536437-07:00",
"MeasurementValueNeededDate": "2026-06-30T11:50:32.2536437-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cd0294f9-adf1-4f82-aff2-2f4ebe11a4d6",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-06-30T11:50:32.2536437-07:00",
"MeasurementValueNeededDate": "2026-06-30T11:50:32.2536437-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5ee987fd-13c3-4396-9615-f91ea83b8b3a",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "28b39790-c15d-4fd3-b618-f084ad4323ce",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5c4572c0-f4ac-4d2f-b63d-67fd67d6a49d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d80ef79c-0948-448d-9682-d72cd82b941c",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-30T11:50:32.2536437-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "94fc5c70-4f34-4f65-9960-ca42c614e621",
"Section": {
"FormTypeSectionId": "12ef5363-9b22-4fbd-9989-892a13e25572",
"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": "cfc5d0a8-9866-4453-8237-31dc38cd5b9d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d418ee54-bcaf-4de4-a4f1-e8c5450f5387",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8224af16-cedf-4153-8dc9-66ddfc80ea72",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"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": "94fc5c70-4f34-4f65-9960-ca42c614e621",
"Section": {
"FormTypeSectionId": "12ef5363-9b22-4fbd-9989-892a13e25572",
"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": "cfc5d0a8-9866-4453-8237-31dc38cd5b9d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d418ee54-bcaf-4de4-a4f1-e8c5450f5387",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8224af16-cedf-4153-8dc9-66ddfc80ea72",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"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": "c0ee73e8-41fc-44a1-a7ed-5800ef66a8bc",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-06-30T11:50:32.2536437-07:00",
"Location": "sample string 1",
"TaskId": "a4eec48a-16dc-4c00-a995-c4eeaed73eaf",
"Values": [
{
"FormFieldValueId": "53c773fd-692e-43d7-9db7-be34fc1e5088",
"FormId": "75b239a0-41ed-4f61-aba1-364d51a0ab1f",
"FormTypeField": {
"FormTypeFieldId": "94fc5c70-4f34-4f65-9960-ca42c614e621",
"FormType": {
"FormTypeId": "28b39790-c15d-4fd3-b618-f084ad4323ce",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5c4572c0-f4ac-4d2f-b63d-67fd67d6a49d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d80ef79c-0948-448d-9682-d72cd82b941c",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-30T11:50:32.2536437-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "c0ee73e8-41fc-44a1-a7ed-5800ef66a8bc",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "12ef5363-9b22-4fbd-9989-892a13e25572",
"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": "cfc5d0a8-9866-4453-8237-31dc38cd5b9d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d418ee54-bcaf-4de4-a4f1-e8c5450f5387",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8224af16-cedf-4153-8dc9-66ddfc80ea72",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"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": "53c773fd-692e-43d7-9db7-be34fc1e5088",
"FormId": "75b239a0-41ed-4f61-aba1-364d51a0ab1f",
"FormTypeField": {
"FormTypeFieldId": "94fc5c70-4f34-4f65-9960-ca42c614e621",
"FormType": {
"FormTypeId": "28b39790-c15d-4fd3-b618-f084ad4323ce",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5c4572c0-f4ac-4d2f-b63d-67fd67d6a49d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d80ef79c-0948-448d-9682-d72cd82b941c",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-30T11:50:32.2536437-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "c0ee73e8-41fc-44a1-a7ed-5800ef66a8bc",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "12ef5363-9b22-4fbd-9989-892a13e25572",
"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": "cfc5d0a8-9866-4453-8237-31dc38cd5b9d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d418ee54-bcaf-4de4-a4f1-e8c5450f5387",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8224af16-cedf-4153-8dc9-66ddfc80ea72",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "96a32ad2-f948-4e4a-96ed-eb65c4fab53e",
"FieldId": "a9d486f1-67f5-4fe2-880c-ecb139c9dea8",
"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": "1a9f1ffb-1491-4bdd-9e0e-30b3d2f051ae",
"CreateDate": "2026-06-30T11:50:32.2536437-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-30T11:50:32.2536437-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}