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": "62b63a63-2f2c-4b14-a1d6-d4e732ca7ca8",
"Asset": {
"AssetId": "b7c45324-ff04-480c-978e-96e1fbd5afcc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "72c0cb76-efaa-430e-b593-f8f084ffaaa3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98f4a3a9-7bba-41b0-9f2c-20a9934d9a8d",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fa96fd24-d393-4f60-a4b6-e059b6f32272",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-09T23:10:12.6189858-07:00",
"MeasurementValueNeededDate": "2026-05-09T23:10:12.6189858-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ab892f06-e33a-470b-acc7-03c735e59a8e",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-09T23:10:12.6189858-07:00",
"MeasurementValueNeededDate": "2026-05-09T23:10:12.6189858-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f48dc74d-77de-45d1-92a7-d2de8498a12a",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "ad5ee0fb-e62b-44e2-9578-dce84a97972e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "72c0cb76-efaa-430e-b593-f8f084ffaaa3",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98f4a3a9-7bba-41b0-9f2c-20a9934d9a8d",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-09T23:10:12.6189858-07:00",
"Fields": [
{
"FormTypeFieldId": "dd232e1f-ea48-4915-b01a-3817743ac4bc",
"Section": {
"FormTypeSectionId": "2cf7e60e-fc18-4d98-be5b-710ef2b29a91",
"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": "a9ea6ce1-0623-4983-886b-8df18b1b21a4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edb99267-8fcf-46d4-9a7f-5b3e4f50c903",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a864273d-0fc9-423a-8929-eac7fafa2c6c",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-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": "dd232e1f-ea48-4915-b01a-3817743ac4bc",
"Section": {
"FormTypeSectionId": "2cf7e60e-fc18-4d98-be5b-710ef2b29a91",
"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": "a9ea6ce1-0623-4983-886b-8df18b1b21a4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edb99267-8fcf-46d4-9a7f-5b3e4f50c903",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a864273d-0fc9-423a-8929-eac7fafa2c6c",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-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": "617188cc-ab9c-4c1c-b2cd-359200966964",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-09T23:10:12.6189858-07:00",
"Location": "sample string 1",
"TaskId": "a12ecc00-27fc-4920-b403-b40ecc27674c",
"Values": [
{
"FormFieldValueId": "acb53ee1-0f60-437d-bee6-006cfb7582a7",
"FormTypeField": {
"FormTypeFieldId": "dd232e1f-ea48-4915-b01a-3817743ac4bc",
"Section": {
"FormTypeSectionId": "2cf7e60e-fc18-4d98-be5b-710ef2b29a91",
"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": "a9ea6ce1-0623-4983-886b-8df18b1b21a4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edb99267-8fcf-46d4-9a7f-5b3e4f50c903",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a864273d-0fc9-423a-8929-eac7fafa2c6c",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-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": "acb53ee1-0f60-437d-bee6-006cfb7582a7",
"FormTypeField": {
"FormTypeFieldId": "dd232e1f-ea48-4915-b01a-3817743ac4bc",
"Section": {
"FormTypeSectionId": "2cf7e60e-fc18-4d98-be5b-710ef2b29a91",
"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": "a9ea6ce1-0623-4983-886b-8df18b1b21a4",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "edb99267-8fcf-46d4-9a7f-5b3e4f50c903",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a864273d-0fc9-423a-8929-eac7fafa2c6c",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-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": "95fa8396-45fc-450e-98ae-08b631ea3580",
"CreateDate": "2026-05-09T23:10:12.6189858-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-09T23:10:12.6189858-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}