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": "8ee0361d-8fb3-4b7c-87b6-dfd03d7f664c",
"Asset": {
"AssetId": "f68d223f-3236-40eb-8a76-de62945c95b6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ec0792e5-6bfc-458c-b18c-01cbce983b41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1557480b-5d81-4761-85c1-8640e9095e1c",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "8745e932-f8c1-4445-a2e1-fc08c3f588ce",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-21T00:25:26.6294861-07:00",
"MeasurementValueNeededDate": "2026-07-21T00:25:26.6294861-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f4547a4f-6a62-41cf-bfde-a30e9afeaef1",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-07-21T00:25:26.6294861-07:00",
"MeasurementValueNeededDate": "2026-07-21T00:25:26.6294861-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b5a8d5a4-d394-415f-871f-a2cdac037956",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "768ec039-4dcc-4989-8bde-2c8a22a2e06f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ec0792e5-6bfc-458c-b18c-01cbce983b41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1557480b-5d81-4761-85c1-8640e9095e1c",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-21T00:25:26.6294861-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "3ca7d56f-bff4-43b4-a4b9-1fd271a7b017",
"Section": {
"FormTypeSectionId": "d484fd31-d2cb-4254-93f3-575a1f03573a",
"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": "0ccc60ce-9327-43cd-a976-5faf8a626849",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "79febc71-3992-4288-a4a3-ae6e56a45505",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4d943e2-4a1a-4bfe-95e2-0b817ff6bef1",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"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": "3ca7d56f-bff4-43b4-a4b9-1fd271a7b017",
"Section": {
"FormTypeSectionId": "d484fd31-d2cb-4254-93f3-575a1f03573a",
"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": "0ccc60ce-9327-43cd-a976-5faf8a626849",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "79febc71-3992-4288-a4a3-ae6e56a45505",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4d943e2-4a1a-4bfe-95e2-0b817ff6bef1",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"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": "ad15f451-8271-4eb2-bbfb-85d41d7e5de5",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-07-21T00:25:26.6294861-07:00",
"Location": "sample string 1",
"TaskId": "5cef4b93-c972-42e2-8faa-d1e91315e40d",
"Values": [
{
"FormFieldValueId": "ef7c819a-6588-440a-8b9d-b413614ec053",
"FormId": "9cf12b83-818c-4a26-a979-8e8119364632",
"FormTypeField": {
"FormTypeFieldId": "3ca7d56f-bff4-43b4-a4b9-1fd271a7b017",
"FormType": {
"FormTypeId": "768ec039-4dcc-4989-8bde-2c8a22a2e06f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ec0792e5-6bfc-458c-b18c-01cbce983b41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1557480b-5d81-4761-85c1-8640e9095e1c",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-21T00:25:26.6294861-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "ad15f451-8271-4eb2-bbfb-85d41d7e5de5",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "d484fd31-d2cb-4254-93f3-575a1f03573a",
"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": "0ccc60ce-9327-43cd-a976-5faf8a626849",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "79febc71-3992-4288-a4a3-ae6e56a45505",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4d943e2-4a1a-4bfe-95e2-0b817ff6bef1",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"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": "ef7c819a-6588-440a-8b9d-b413614ec053",
"FormId": "9cf12b83-818c-4a26-a979-8e8119364632",
"FormTypeField": {
"FormTypeFieldId": "3ca7d56f-bff4-43b4-a4b9-1fd271a7b017",
"FormType": {
"FormTypeId": "768ec039-4dcc-4989-8bde-2c8a22a2e06f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ec0792e5-6bfc-458c-b18c-01cbce983b41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1557480b-5d81-4761-85c1-8640e9095e1c",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-21T00:25:26.6294861-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "ad15f451-8271-4eb2-bbfb-85d41d7e5de5",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "d484fd31-d2cb-4254-93f3-575a1f03573a",
"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": "0ccc60ce-9327-43cd-a976-5faf8a626849",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "79febc71-3992-4288-a4a3-ae6e56a45505",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4d943e2-4a1a-4bfe-95e2-0b817ff6bef1",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3ab4ec0a-f3f6-42f2-87a0-e856c43da14c",
"FieldId": "097bcc1a-279a-4bb9-aee8-bf747bd3c840",
"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": "b876a176-6761-46ce-b44d-63be14890cbc",
"CreateDate": "2026-07-21T00:25:26.6294861-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-21T00:25:26.6294861-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}