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": "90df5e34-46d8-45a0-90cc-4a18cf3f9192",
"Asset": {
"AssetId": "b0043ebc-fc05-4926-9414-0b2c4b243f70",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ed80988e-d657-4cb0-8bf3-1f49d10f72c1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8e661575-1eb8-4637-a7c1-251aeddae4ce",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0c3e434f-76fd-4d21-9973-43e9549b448f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-27T23:46:35.876991-07:00",
"MeasurementValueNeededDate": "2026-10-27T23:46:35.876991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a67c2197-e65a-4a87-8e23-4d64f0f4856c",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-27T23:46:35.876991-07:00",
"MeasurementValueNeededDate": "2026-10-27T23:46:35.876991-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "41f23aff-77b5-49c4-b926-6aefc8249097",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "f0fcaacc-40ef-45da-888b-2fd7c2583828",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ed80988e-d657-4cb0-8bf3-1f49d10f72c1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8e661575-1eb8-4637-a7c1-251aeddae4ce",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-27T23:46:35.876991-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "52ac17a2-c280-45e4-a085-5cdfc514e352",
"Section": {
"FormTypeSectionId": "5119bc39-e618-4284-94bc-46678ab0d403",
"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": "615c6ae8-3531-4fff-96cf-0ddf17f66f90",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04fc0682-e69e-4bc9-83e9-60aea04c7f0e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc661844-dabd-4a8f-9375-f83405d3066b",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"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": "52ac17a2-c280-45e4-a085-5cdfc514e352",
"Section": {
"FormTypeSectionId": "5119bc39-e618-4284-94bc-46678ab0d403",
"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": "615c6ae8-3531-4fff-96cf-0ddf17f66f90",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04fc0682-e69e-4bc9-83e9-60aea04c7f0e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc661844-dabd-4a8f-9375-f83405d3066b",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"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": "ce317bbb-9131-45ef-adb2-5c59aa6bfa74",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-10-27T23:46:35.876991-07:00",
"Location": "sample string 1",
"TaskId": "78e9399b-aa9c-4f01-85d9-582214d1cc4c",
"Values": [
{
"FormFieldValueId": "77b6c51e-1aaf-4b0f-aa80-455b7388d416",
"FormId": "ebad3707-1bd0-4731-a9a0-399bb8813f17",
"FormTypeField": {
"FormTypeFieldId": "52ac17a2-c280-45e4-a085-5cdfc514e352",
"FormType": {
"FormTypeId": "f0fcaacc-40ef-45da-888b-2fd7c2583828",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ed80988e-d657-4cb0-8bf3-1f49d10f72c1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8e661575-1eb8-4637-a7c1-251aeddae4ce",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-27T23:46:35.876991-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "ce317bbb-9131-45ef-adb2-5c59aa6bfa74",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "5119bc39-e618-4284-94bc-46678ab0d403",
"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": "615c6ae8-3531-4fff-96cf-0ddf17f66f90",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04fc0682-e69e-4bc9-83e9-60aea04c7f0e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc661844-dabd-4a8f-9375-f83405d3066b",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"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": "77b6c51e-1aaf-4b0f-aa80-455b7388d416",
"FormId": "ebad3707-1bd0-4731-a9a0-399bb8813f17",
"FormTypeField": {
"FormTypeFieldId": "52ac17a2-c280-45e4-a085-5cdfc514e352",
"FormType": {
"FormTypeId": "f0fcaacc-40ef-45da-888b-2fd7c2583828",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ed80988e-d657-4cb0-8bf3-1f49d10f72c1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8e661575-1eb8-4637-a7c1-251aeddae4ce",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-27T23:46:35.876991-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "ce317bbb-9131-45ef-adb2-5c59aa6bfa74",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "5119bc39-e618-4284-94bc-46678ab0d403",
"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": "615c6ae8-3531-4fff-96cf-0ddf17f66f90",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "04fc0682-e69e-4bc9-83e9-60aea04c7f0e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dc661844-dabd-4a8f-9375-f83405d3066b",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "51de4cb1-7f6a-439b-8ca2-c835606d56be",
"FieldId": "4cdc2895-984c-4314-880d-edcd1e514a82",
"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": "09a9f13f-1259-4b88-ac4e-b55be0532a14",
"CreateDate": "2026-10-27T23:46:35.876991-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-27T23:46:35.876991-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}