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": "31c55e94-c1d9-4c6b-9ec0-bb620888bc2f",
"Asset": {
"AssetId": "9bdf2b88-099d-435d-8435-188a6b42fe36",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c0dd1b0-43de-4534-8f84-2d09301d0837",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d948bacb-0b07-4360-8606-5257e8cb38c3",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "226f1d9d-4562-4d8d-83b6-81d9e2399b24",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-12T10:18:41.6281074-07:00",
"MeasurementValueNeededDate": "2026-10-12T10:18:41.6281074-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7bff6fdd-fed0-4499-870c-5c765d51c697",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-10-12T10:18:41.6281074-07:00",
"MeasurementValueNeededDate": "2026-10-12T10:18:41.6281074-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ebcbfaef-7e36-4e7f-b4aa-e44763e648ee",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "7e698ff2-1d94-44ed-9e61-7fba997e8400",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1c0dd1b0-43de-4534-8f84-2d09301d0837",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d948bacb-0b07-4360-8606-5257e8cb38c3",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-12T10:18:41.6281074-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "294e61a8-b81b-4390-8aae-0215a255bf7a",
"Section": {
"FormTypeSectionId": "c04c8b7d-d959-4383-85aa-26be9e73e645",
"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": "0679779f-1669-49ef-9cc0-dd372dabdd76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a07b2c14-5fab-4918-8f5b-44054ba3d528",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "aab5d007-266f-47eb-b11a-b450e614d449",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"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": "294e61a8-b81b-4390-8aae-0215a255bf7a",
"Section": {
"FormTypeSectionId": "c04c8b7d-d959-4383-85aa-26be9e73e645",
"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": "0679779f-1669-49ef-9cc0-dd372dabdd76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a07b2c14-5fab-4918-8f5b-44054ba3d528",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "aab5d007-266f-47eb-b11a-b450e614d449",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"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": "bba1b622-53dd-461e-aa76-a4df08930026",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-10-12T10:18:41.6281074-07:00",
"Location": "sample string 1",
"TaskId": "cc234b8f-e0d1-4582-9eb2-56e4c19ddbe5",
"Values": [
{
"FormFieldValueId": "9297026b-6c0d-4e00-aaa9-c22110fe3f7d",
"FormId": "3d941ce8-eba3-4db8-aad2-494f85ae7ae9",
"FormTypeField": {
"FormTypeFieldId": "294e61a8-b81b-4390-8aae-0215a255bf7a",
"FormType": {
"FormTypeId": "7e698ff2-1d94-44ed-9e61-7fba997e8400",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1c0dd1b0-43de-4534-8f84-2d09301d0837",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d948bacb-0b07-4360-8606-5257e8cb38c3",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-12T10:18:41.6281074-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "bba1b622-53dd-461e-aa76-a4df08930026",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "c04c8b7d-d959-4383-85aa-26be9e73e645",
"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": "0679779f-1669-49ef-9cc0-dd372dabdd76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a07b2c14-5fab-4918-8f5b-44054ba3d528",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "aab5d007-266f-47eb-b11a-b450e614d449",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"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": "9297026b-6c0d-4e00-aaa9-c22110fe3f7d",
"FormId": "3d941ce8-eba3-4db8-aad2-494f85ae7ae9",
"FormTypeField": {
"FormTypeFieldId": "294e61a8-b81b-4390-8aae-0215a255bf7a",
"FormType": {
"FormTypeId": "7e698ff2-1d94-44ed-9e61-7fba997e8400",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "1c0dd1b0-43de-4534-8f84-2d09301d0837",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d948bacb-0b07-4360-8606-5257e8cb38c3",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-10-12T10:18:41.6281074-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "bba1b622-53dd-461e-aa76-a4df08930026",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "c04c8b7d-d959-4383-85aa-26be9e73e645",
"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": "0679779f-1669-49ef-9cc0-dd372dabdd76",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a07b2c14-5fab-4918-8f5b-44054ba3d528",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "aab5d007-266f-47eb-b11a-b450e614d449",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "32da66e1-3548-4b60-9ab5-76ea484b5f43",
"FieldId": "da0e5f59-ecf8-474e-a8d3-64f3e187dcf9",
"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": "36bbec0b-1314-4d05-b354-ccc5c37f6c63",
"CreateDate": "2026-10-12T10:18:41.6281074-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-12T10:18:41.6281074-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}