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": "0c8e683f-cbea-4f2b-b01c-645d243e07ea",
"Asset": {
"AssetId": "6b336f72-e767-4c67-9300-9c4b672b1a3d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a1c40bb7-49d3-4be2-b0c7-9fcc388eb388",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ea30fa40-c9a7-45d4-ac3a-e40e0ce7e452",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "5cc20d44-f758-497a-a518-28f9f4dea795",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-10T05:01:34.4705424-08:00",
"MeasurementValueNeededDate": "2025-12-10T05:01:34.4705424-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "40bfebe1-7f5d-4e31-8ad8-3494516aecbc",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-10T05:01:34.4705424-08:00",
"MeasurementValueNeededDate": "2025-12-10T05:01:34.4705424-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9faa2e38-ec1c-4d5d-918e-5266e2200c12",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c7f2367f-c925-4c48-ae8b-42b0ec7ac1ea",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a1c40bb7-49d3-4be2-b0c7-9fcc388eb388",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ea30fa40-c9a7-45d4-ac3a-e40e0ce7e452",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-10T05:01:34.4705424-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "cdf2f562-8cb3-4a04-8e8d-e0c6b0f5f9f8",
"Section": {
"FormTypeSectionId": "49de1204-0a95-43f4-8ca2-ac92103463d5",
"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": "97d802e7-c9df-47eb-85b3-5becb93aefc9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5f37afb2-127d-4f3e-bc08-e5454a4a8697",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6f4cb724-f835-4bc5-9705-14c7dc8b2f57",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"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": "cdf2f562-8cb3-4a04-8e8d-e0c6b0f5f9f8",
"Section": {
"FormTypeSectionId": "49de1204-0a95-43f4-8ca2-ac92103463d5",
"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": "97d802e7-c9df-47eb-85b3-5becb93aefc9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5f37afb2-127d-4f3e-bc08-e5454a4a8697",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6f4cb724-f835-4bc5-9705-14c7dc8b2f57",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"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": "96350975-fd93-4080-9e37-69f709caa431",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2025-12-10T05:01:34.4705424-08:00",
"Location": "sample string 1",
"TaskId": "7ae0c1fd-ca80-4039-bfd4-d0ab754d3a07",
"Values": [
{
"FormFieldValueId": "2bc6ee83-450d-4750-91ab-c76a320d6dab",
"FormId": "8fdc04a3-84da-48d5-a57e-0f65533e6865",
"FormTypeField": {
"FormTypeFieldId": "cdf2f562-8cb3-4a04-8e8d-e0c6b0f5f9f8",
"FormType": {
"FormTypeId": "c7f2367f-c925-4c48-ae8b-42b0ec7ac1ea",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a1c40bb7-49d3-4be2-b0c7-9fcc388eb388",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ea30fa40-c9a7-45d4-ac3a-e40e0ce7e452",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-10T05:01:34.4705424-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "96350975-fd93-4080-9e37-69f709caa431",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "49de1204-0a95-43f4-8ca2-ac92103463d5",
"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": "97d802e7-c9df-47eb-85b3-5becb93aefc9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5f37afb2-127d-4f3e-bc08-e5454a4a8697",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6f4cb724-f835-4bc5-9705-14c7dc8b2f57",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"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": "2bc6ee83-450d-4750-91ab-c76a320d6dab",
"FormId": "8fdc04a3-84da-48d5-a57e-0f65533e6865",
"FormTypeField": {
"FormTypeFieldId": "cdf2f562-8cb3-4a04-8e8d-e0c6b0f5f9f8",
"FormType": {
"FormTypeId": "c7f2367f-c925-4c48-ae8b-42b0ec7ac1ea",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a1c40bb7-49d3-4be2-b0c7-9fcc388eb388",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ea30fa40-c9a7-45d4-ac3a-e40e0ce7e452",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-10T05:01:34.4705424-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "96350975-fd93-4080-9e37-69f709caa431",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "49de1204-0a95-43f4-8ca2-ac92103463d5",
"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": "97d802e7-c9df-47eb-85b3-5becb93aefc9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5f37afb2-127d-4f3e-bc08-e5454a4a8697",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6f4cb724-f835-4bc5-9705-14c7dc8b2f57",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a6c105d0-5cef-4593-8a41-e506ef60450b",
"FieldId": "63877cc2-2e7d-420d-87ed-8b49c8ffb7db",
"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": "ac8e00d8-1249-4b14-a34b-022b0c71cb4b",
"CreateDate": "2025-12-10T05:01:34.4705424-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-10T05:01:34.4705424-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}