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": "aa9375c2-c3ac-4f18-9bf2-e07cc0ab6c4d",
"Asset": {
"AssetId": "cfda84cf-6920-4b51-936c-bf6d17847b12",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0a2ae13f-3f0a-4066-9c93-adc08f5cbd5e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "71182982-9c91-4d88-a5d4-a35eebf20311",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "b2e8ad35-a5a4-45b7-b3b0-f7db7f571529",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-05T01:48:12.4413635-08:00",
"MeasurementValueNeededDate": "2025-11-05T01:48:12.4413635-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5da4ab3d-0de5-4e49-bf6e-71203269cc87",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-11-05T01:48:12.4413635-08:00",
"MeasurementValueNeededDate": "2025-11-05T01:48:12.4413635-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a978afa9-76bf-4c58-b264-1782487f5602",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "9cd9f1e6-f992-4f5d-9c3f-28dfd4964da9",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0a2ae13f-3f0a-4066-9c93-adc08f5cbd5e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "71182982-9c91-4d88-a5d4-a35eebf20311",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-11-05T01:48:12.4413635-08:00",
"Fields": [
{
"FormTypeFieldId": "36fbf409-2c77-4338-946f-c1d6f6f20752",
"Section": {
"FormTypeSectionId": "efed2cbf-9fdd-4522-8f60-5091d3c258ce",
"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": "0db90867-b431-4596-a818-9369db95867e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9863887a-de98-4e8b-9ea2-912c2fbce9a3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6183ecd8-cf94-4de7-b99d-4ab6689042d4",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08: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": "36fbf409-2c77-4338-946f-c1d6f6f20752",
"Section": {
"FormTypeSectionId": "efed2cbf-9fdd-4522-8f60-5091d3c258ce",
"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": "0db90867-b431-4596-a818-9369db95867e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9863887a-de98-4e8b-9ea2-912c2fbce9a3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6183ecd8-cf94-4de7-b99d-4ab6689042d4",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08: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": "b25748d6-9d6a-4158-ac47-2082e58a23a8",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-11-05T01:48:12.4413635-08:00",
"Location": "sample string 1",
"TaskId": "fc1257b7-4892-465b-b93a-f9dff3dab9b2",
"Values": [
{
"FormFieldValueId": "4f7af58f-db94-4946-96a2-ac733e6a8171",
"FormTypeField": {
"FormTypeFieldId": "36fbf409-2c77-4338-946f-c1d6f6f20752",
"Section": {
"FormTypeSectionId": "efed2cbf-9fdd-4522-8f60-5091d3c258ce",
"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": "0db90867-b431-4596-a818-9369db95867e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9863887a-de98-4e8b-9ea2-912c2fbce9a3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6183ecd8-cf94-4de7-b99d-4ab6689042d4",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08: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": "4f7af58f-db94-4946-96a2-ac733e6a8171",
"FormTypeField": {
"FormTypeFieldId": "36fbf409-2c77-4338-946f-c1d6f6f20752",
"Section": {
"FormTypeSectionId": "efed2cbf-9fdd-4522-8f60-5091d3c258ce",
"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": "0db90867-b431-4596-a818-9369db95867e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9863887a-de98-4e8b-9ea2-912c2fbce9a3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6183ecd8-cf94-4de7-b99d-4ab6689042d4",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08: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": "c053aa39-0df3-4eb2-987d-de9698fcc979",
"CreateDate": "2025-11-05T01:48:12.4413635-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-05T01:48:12.4413635-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}