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": "bae6eaff-8b8a-49b8-ab84-0a7887da924e",
"Asset": {
"AssetId": "573d8886-2361-40f7-a3ce-ccd16c79f264",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bc8047df-d793-407e-b0a9-f722dba52c47",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "21f224cf-04ad-40f2-9215-a32d93f20bc2",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "bbf1f5e4-5ad4-459c-8e6f-e4b573c199c8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-01T15:12:47.3114571-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:12:47.3114571-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d2be3200-3ac0-4bc5-887f-f73bdea22bfc",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-12-01T15:12:47.3114571-08:00",
"MeasurementValueNeededDate": "2025-12-01T15:12:47.3114571-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9a4ea3cf-3800-4619-a9b7-cea39b922a1e",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "a2e25557-92dc-48f0-ba54-753ad05cea60",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bc8047df-d793-407e-b0a9-f722dba52c47",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "21f224cf-04ad-40f2-9215-a32d93f20bc2",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-01T15:12:47.3114571-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "367d0d8d-da4d-446d-8202-477eaf09eec3",
"Section": {
"FormTypeSectionId": "6c46657a-db20-4ce6-8d04-32c503f91d42",
"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": "c3dcf41c-c741-4464-8537-389dbe02aaaa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6315515d-8ba0-48a0-a89c-c0ba227f491f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02df32db-eca3-4ec3-a384-a86e842b1963",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"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": "367d0d8d-da4d-446d-8202-477eaf09eec3",
"Section": {
"FormTypeSectionId": "6c46657a-db20-4ce6-8d04-32c503f91d42",
"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": "c3dcf41c-c741-4464-8537-389dbe02aaaa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6315515d-8ba0-48a0-a89c-c0ba227f491f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02df32db-eca3-4ec3-a384-a86e842b1963",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"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": "84dc3850-74fc-4281-b5c3-f838268f5da1",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2025-12-01T15:12:47.3114571-08:00",
"Location": "sample string 1",
"TaskId": "406bd5f3-9982-4df9-ae8b-b467404676f9",
"Values": [
{
"FormFieldValueId": "e4694c02-7335-46b1-bf36-359e92b8b6df",
"FormId": "16bc3587-c934-422f-a2bf-47e58b73cef6",
"FormTypeField": {
"FormTypeFieldId": "367d0d8d-da4d-446d-8202-477eaf09eec3",
"FormType": {
"FormTypeId": "a2e25557-92dc-48f0-ba54-753ad05cea60",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bc8047df-d793-407e-b0a9-f722dba52c47",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "21f224cf-04ad-40f2-9215-a32d93f20bc2",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-01T15:12:47.3114571-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "84dc3850-74fc-4281-b5c3-f838268f5da1",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "6c46657a-db20-4ce6-8d04-32c503f91d42",
"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": "c3dcf41c-c741-4464-8537-389dbe02aaaa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6315515d-8ba0-48a0-a89c-c0ba227f491f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02df32db-eca3-4ec3-a384-a86e842b1963",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"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": "e4694c02-7335-46b1-bf36-359e92b8b6df",
"FormId": "16bc3587-c934-422f-a2bf-47e58b73cef6",
"FormTypeField": {
"FormTypeFieldId": "367d0d8d-da4d-446d-8202-477eaf09eec3",
"FormType": {
"FormTypeId": "a2e25557-92dc-48f0-ba54-753ad05cea60",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "bc8047df-d793-407e-b0a9-f722dba52c47",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "21f224cf-04ad-40f2-9215-a32d93f20bc2",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-12-01T15:12:47.3114571-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "84dc3850-74fc-4281-b5c3-f838268f5da1",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "6c46657a-db20-4ce6-8d04-32c503f91d42",
"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": "c3dcf41c-c741-4464-8537-389dbe02aaaa",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6315515d-8ba0-48a0-a89c-c0ba227f491f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02df32db-eca3-4ec3-a384-a86e842b1963",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5a6411d9-ebbb-481a-a37f-99516ad27e4b",
"FieldId": "729f9b13-fb85-4606-b5a3-70727a4cea73",
"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": "0a85296b-3f09-45ef-8dd0-77cf615da225",
"CreateDate": "2025-12-01T15:12:47.3114571-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-01T15:12:47.3114571-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}