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": "f6836924-e5c8-4b9d-8ec1-87ae81447170",
"Asset": {
"AssetId": "e4f39191-a22b-492a-a84a-8a9e5e75a97a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d3529583-3a07-4a2e-9b22-10383e47168a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f7ae0fce-03fb-47b8-a787-67570150f64b",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "d23920d6-75ff-4ea9-a084-443b6183d77d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-09T23:43:41.6537157-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:43:41.6537157-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3da55fc3-074f-4716-91cb-bcd80210371e",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-08-09T23:43:41.6537157-07:00",
"MeasurementValueNeededDate": "2026-08-09T23:43:41.6537157-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "de975ce9-0a6d-4c2f-bab1-f5b9f2820f13",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "6871307b-90c1-487e-aaab-a4efc0439555",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d3529583-3a07-4a2e-9b22-10383e47168a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f7ae0fce-03fb-47b8-a787-67570150f64b",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-09T23:43:41.6537157-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "6fa9ba7d-8b3a-42ee-9243-368afd385b78",
"Section": {
"FormTypeSectionId": "6710307b-ccf2-4c73-99d0-1c1795e7030d",
"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": "65d85475-76e1-4924-8f4b-f414f184a9ce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32a626f1-b542-481b-9333-e106c1a7e765",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "596e48d5-9b67-4af4-93b7-e867bb494e4d",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"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": "6fa9ba7d-8b3a-42ee-9243-368afd385b78",
"Section": {
"FormTypeSectionId": "6710307b-ccf2-4c73-99d0-1c1795e7030d",
"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": "65d85475-76e1-4924-8f4b-f414f184a9ce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32a626f1-b542-481b-9333-e106c1a7e765",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "596e48d5-9b67-4af4-93b7-e867bb494e4d",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"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": "2a1f363d-d264-4b0f-8346-cb728b4dd2da",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-08-09T23:43:41.6537157-07:00",
"Location": "sample string 1",
"TaskId": "ede34840-4d95-49fc-941f-6e8df8675419",
"Values": [
{
"FormFieldValueId": "d4742f1a-b6e0-4c2f-b0d5-052990a02d2a",
"FormId": "641cfd87-1872-4b88-9e55-83f31b0847cd",
"FormTypeField": {
"FormTypeFieldId": "6fa9ba7d-8b3a-42ee-9243-368afd385b78",
"FormType": {
"FormTypeId": "6871307b-90c1-487e-aaab-a4efc0439555",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d3529583-3a07-4a2e-9b22-10383e47168a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f7ae0fce-03fb-47b8-a787-67570150f64b",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-09T23:43:41.6537157-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "2a1f363d-d264-4b0f-8346-cb728b4dd2da",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "6710307b-ccf2-4c73-99d0-1c1795e7030d",
"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": "65d85475-76e1-4924-8f4b-f414f184a9ce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32a626f1-b542-481b-9333-e106c1a7e765",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "596e48d5-9b67-4af4-93b7-e867bb494e4d",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"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": "d4742f1a-b6e0-4c2f-b0d5-052990a02d2a",
"FormId": "641cfd87-1872-4b88-9e55-83f31b0847cd",
"FormTypeField": {
"FormTypeFieldId": "6fa9ba7d-8b3a-42ee-9243-368afd385b78",
"FormType": {
"FormTypeId": "6871307b-90c1-487e-aaab-a4efc0439555",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d3529583-3a07-4a2e-9b22-10383e47168a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f7ae0fce-03fb-47b8-a787-67570150f64b",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-09T23:43:41.6537157-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "2a1f363d-d264-4b0f-8346-cb728b4dd2da",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "6710307b-ccf2-4c73-99d0-1c1795e7030d",
"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": "65d85475-76e1-4924-8f4b-f414f184a9ce",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "32a626f1-b542-481b-9333-e106c1a7e765",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "596e48d5-9b67-4af4-93b7-e867bb494e4d",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9c193a5-40a5-4d9c-a263-631f30e84145",
"FieldId": "971ba2b9-67a3-4f73-b614-05a039a0ae31",
"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": "69fd8b50-49a1-4c1d-bd4a-6404c008f859",
"CreateDate": "2026-08-09T23:43:41.6537157-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-09T23:43:41.6537157-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}