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": "2f107788-c0ce-4de5-9969-fc694d39105c",
"Asset": {
"AssetId": "6489edea-9005-47a5-8b81-9087749aa4bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fd97a8d7-4c52-43ec-b366-673404fa9f96",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "72cd7e08-22b2-4593-8801-a219854d4898",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "e476ee3e-8def-4b2d-bad0-ede83a3db629",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T15:26:42.2568152-08:00",
"MeasurementValueNeededDate": "2026-11-01T15:26:42.2568152-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "30d52d60-8543-4062-8513-29aa4a3e9d34",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-11-01T15:26:42.2568152-08:00",
"MeasurementValueNeededDate": "2026-11-01T15:26:42.2568152-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "40710bf2-6028-482c-959b-9ea173314979",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "508dc3f9-7f3f-46f4-b7d5-abee22aa1e7a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fd97a8d7-4c52-43ec-b366-673404fa9f96",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "72cd7e08-22b2-4593-8801-a219854d4898",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-01T15:26:42.2568152-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "60a2107f-e0af-4100-bc14-f161a1b974bc",
"Section": {
"FormTypeSectionId": "960d8b3a-d361-46b7-a05f-9b948aa2af41",
"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": "a6e64015-a90f-43ef-b96d-8a1baeaaedd8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c7779e91-e010-44e0-9e4c-cbed15be1bba",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "71ea2a95-028b-4290-b5a5-453cc3d398d5",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"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": "60a2107f-e0af-4100-bc14-f161a1b974bc",
"Section": {
"FormTypeSectionId": "960d8b3a-d361-46b7-a05f-9b948aa2af41",
"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": "a6e64015-a90f-43ef-b96d-8a1baeaaedd8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c7779e91-e010-44e0-9e4c-cbed15be1bba",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "71ea2a95-028b-4290-b5a5-453cc3d398d5",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"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": "477994ef-8136-43e9-8000-308481a9d0a4",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-11-01T15:26:42.2568152-08:00",
"Location": "sample string 1",
"TaskId": "799688c1-eeda-48fe-b9bf-b47f2932a78a",
"Values": [
{
"FormFieldValueId": "98cbefa7-9fc6-4ef0-b5e4-b7f949efbef4",
"FormId": "472e2e54-12e2-4df5-a1a7-6df2772c97a4",
"FormTypeField": {
"FormTypeFieldId": "60a2107f-e0af-4100-bc14-f161a1b974bc",
"FormType": {
"FormTypeId": "508dc3f9-7f3f-46f4-b7d5-abee22aa1e7a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fd97a8d7-4c52-43ec-b366-673404fa9f96",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "72cd7e08-22b2-4593-8801-a219854d4898",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-01T15:26:42.2568152-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "477994ef-8136-43e9-8000-308481a9d0a4",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "960d8b3a-d361-46b7-a05f-9b948aa2af41",
"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": "a6e64015-a90f-43ef-b96d-8a1baeaaedd8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c7779e91-e010-44e0-9e4c-cbed15be1bba",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "71ea2a95-028b-4290-b5a5-453cc3d398d5",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"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": "98cbefa7-9fc6-4ef0-b5e4-b7f949efbef4",
"FormId": "472e2e54-12e2-4df5-a1a7-6df2772c97a4",
"FormTypeField": {
"FormTypeFieldId": "60a2107f-e0af-4100-bc14-f161a1b974bc",
"FormType": {
"FormTypeId": "508dc3f9-7f3f-46f4-b7d5-abee22aa1e7a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fd97a8d7-4c52-43ec-b366-673404fa9f96",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "72cd7e08-22b2-4593-8801-a219854d4898",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-01T15:26:42.2568152-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "477994ef-8136-43e9-8000-308481a9d0a4",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "960d8b3a-d361-46b7-a05f-9b948aa2af41",
"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": "a6e64015-a90f-43ef-b96d-8a1baeaaedd8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c7779e91-e010-44e0-9e4c-cbed15be1bba",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "71ea2a95-028b-4290-b5a5-453cc3d398d5",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "11ed9192-d6c9-4459-8bd2-42fe2c7cedf1",
"FieldId": "e74d88a2-4bc5-4aa9-9e43-47094ff05990",
"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": "5b2afb54-886a-4b87-9314-bf94a5eac8e0",
"CreateDate": "2026-11-01T15:26:42.2568152-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-01T15:26:42.2568152-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}