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": "db8bba9e-1738-421c-8ccd-d73027e89d21",
"Asset": {
"AssetId": "5b07d43e-40ca-4b18-970a-c5891556a181",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ee325583-b690-4582-956d-b45e9268855e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d93b22c-ac67-4d2b-bf31-05c329a7ca7f",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "21b53e5f-84f0-49a9-aefd-9807f2c57f78",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-14T09:16:33.0086676-07:00",
"MeasurementValueNeededDate": "2026-04-14T09:16:33.0086676-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3ddb7b97-9723-48d0-a0da-477eed805a77",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-14T09:16:33.0086676-07:00",
"MeasurementValueNeededDate": "2026-04-14T09:16:33.0086676-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "14a80858-caf4-4948-907a-df64d1b12fb8",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "3d9eb3fe-5d4c-4d40-b337-39a0cf50a628",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "ee325583-b690-4582-956d-b45e9268855e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2d93b22c-ac67-4d2b-bf31-05c329a7ca7f",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-14T09:16:33.0086676-07:00",
"Fields": [
{
"FormTypeFieldId": "807ddefb-bc04-4d93-9dda-61ea7a4df3fd",
"Section": {
"FormTypeSectionId": "c83ebd13-bce7-4c4d-ac55-bd01619b4b39",
"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": "87583af3-47a1-4729-a5ff-90ef3e5c2858",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98e1fd5e-21ad-4d60-a60a-00d60d260b94",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9a3cf263-1ee7-4efa-99f6-cbb1833f6d39",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "807ddefb-bc04-4d93-9dda-61ea7a4df3fd",
"Section": {
"FormTypeSectionId": "c83ebd13-bce7-4c4d-ac55-bd01619b4b39",
"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": "87583af3-47a1-4729-a5ff-90ef3e5c2858",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98e1fd5e-21ad-4d60-a60a-00d60d260b94",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9a3cf263-1ee7-4efa-99f6-cbb1833f6d39",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "cdae552c-9cd2-47dc-89fe-ecc53fe71c8d",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-14T09:16:33.0086676-07:00",
"Location": "sample string 1",
"TaskId": "883b1baf-1565-466e-822c-a4705c87f4dd",
"Values": [
{
"FormFieldValueId": "3fd40af2-1558-4a16-a719-850451644bfd",
"FormTypeField": {
"FormTypeFieldId": "807ddefb-bc04-4d93-9dda-61ea7a4df3fd",
"Section": {
"FormTypeSectionId": "c83ebd13-bce7-4c4d-ac55-bd01619b4b39",
"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": "87583af3-47a1-4729-a5ff-90ef3e5c2858",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98e1fd5e-21ad-4d60-a60a-00d60d260b94",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9a3cf263-1ee7-4efa-99f6-cbb1833f6d39",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "3fd40af2-1558-4a16-a719-850451644bfd",
"FormTypeField": {
"FormTypeFieldId": "807ddefb-bc04-4d93-9dda-61ea7a4df3fd",
"Section": {
"FormTypeSectionId": "c83ebd13-bce7-4c4d-ac55-bd01619b4b39",
"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": "87583af3-47a1-4729-a5ff-90ef3e5c2858",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98e1fd5e-21ad-4d60-a60a-00d60d260b94",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9a3cf263-1ee7-4efa-99f6-cbb1833f6d39",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "09e02619-22e5-4546-90c8-80a862acfa7b",
"CreateDate": "2026-04-14T09:16:33.0086676-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-14T09:16:33.0086676-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}