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": "48ccdceb-00b5-485d-823b-bbdbbb9d15bb",
"Asset": {
"AssetId": "d7cad3e6-518a-4c96-9608-d6add77aa89e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8e201fc5-f9a8-4d63-ae5c-4bf52d11b7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ffb82831-68d4-4484-9328-605665672321",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "92545c5b-e916-4be5-af15-d02f64b17f62",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-24T08:00:31.640876-07:00",
"MeasurementValueNeededDate": "2026-03-24T08:00:31.640876-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2bafb4b7-f868-4ec3-acc5-9873ca4056fe",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-03-24T08:00:31.640876-07:00",
"MeasurementValueNeededDate": "2026-03-24T08:00:31.640876-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "21767329-9432-485c-9b55-cb0850ebfa89",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "61b449c5-0dfe-4779-a026-3458506325e2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8e201fc5-f9a8-4d63-ae5c-4bf52d11b7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ffb82831-68d4-4484-9328-605665672321",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-24T08:00:31.640876-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "92a9b4af-0298-46e6-b836-d0c37a45829f",
"Section": {
"FormTypeSectionId": "47ad7979-5fb0-4f69-8830-53012e329e66",
"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": "dc18d161-a54b-4ae1-80af-c52d475fc472",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd76030-28d5-4857-a67a-4c5c5f419a75",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2da044f1-e7e3-46a1-8bc0-4d702de75111",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"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": "92a9b4af-0298-46e6-b836-d0c37a45829f",
"Section": {
"FormTypeSectionId": "47ad7979-5fb0-4f69-8830-53012e329e66",
"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": "dc18d161-a54b-4ae1-80af-c52d475fc472",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd76030-28d5-4857-a67a-4c5c5f419a75",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2da044f1-e7e3-46a1-8bc0-4d702de75111",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"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": "19262ea5-31de-4fcf-93b0-b5e3f4cca34f",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-03-24T08:00:31.640876-07:00",
"Location": "sample string 1",
"TaskId": "296ca158-a762-4397-ab66-df4e03a3a359",
"Values": [
{
"FormFieldValueId": "c52fc22e-429a-447c-b5e2-aeefe9fde568",
"FormId": "1f66fd32-7dab-465f-8e28-02e5b04e64d8",
"FormTypeField": {
"FormTypeFieldId": "92a9b4af-0298-46e6-b836-d0c37a45829f",
"FormType": {
"FormTypeId": "61b449c5-0dfe-4779-a026-3458506325e2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8e201fc5-f9a8-4d63-ae5c-4bf52d11b7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ffb82831-68d4-4484-9328-605665672321",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-24T08:00:31.640876-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "19262ea5-31de-4fcf-93b0-b5e3f4cca34f",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "47ad7979-5fb0-4f69-8830-53012e329e66",
"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": "dc18d161-a54b-4ae1-80af-c52d475fc472",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd76030-28d5-4857-a67a-4c5c5f419a75",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2da044f1-e7e3-46a1-8bc0-4d702de75111",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"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": "c52fc22e-429a-447c-b5e2-aeefe9fde568",
"FormId": "1f66fd32-7dab-465f-8e28-02e5b04e64d8",
"FormTypeField": {
"FormTypeFieldId": "92a9b4af-0298-46e6-b836-d0c37a45829f",
"FormType": {
"FormTypeId": "61b449c5-0dfe-4779-a026-3458506325e2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8e201fc5-f9a8-4d63-ae5c-4bf52d11b7ad",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ffb82831-68d4-4484-9328-605665672321",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-24T08:00:31.640876-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "19262ea5-31de-4fcf-93b0-b5e3f4cca34f",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "47ad7979-5fb0-4f69-8830-53012e329e66",
"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": "dc18d161-a54b-4ae1-80af-c52d475fc472",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd76030-28d5-4857-a67a-4c5c5f419a75",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2da044f1-e7e3-46a1-8bc0-4d702de75111",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "49301921-2e81-431b-b675-a549eee21eba",
"FieldId": "0873185f-ed01-47b6-8275-94bee380a510",
"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": "fcaaaa34-e5a4-49bd-9fda-a938e60d584d",
"CreateDate": "2026-03-24T08:00:31.640876-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-24T08:00:31.640876-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}