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": "6b6b88f5-2523-4b20-9e3a-478b40b7f4c7",
"Asset": {
"AssetId": "6e80b90c-e2e8-4d51-a514-4871fc65288c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "31b33d37-f855-4b9d-9414-f254385067ab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3697e164-1bf1-4b22-9400-cad5e462474d",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "54fb10ff-e9bb-4214-b669-624332761ac2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-12T01:18:15.5510832-08:00",
"MeasurementValueNeededDate": "2026-02-12T01:18:15.5510832-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "23440ce9-faf7-4043-a73c-a3af76b6316a",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-02-12T01:18:15.5510832-08:00",
"MeasurementValueNeededDate": "2026-02-12T01:18:15.5510832-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "76ca3447-e294-4b28-8325-d77e17afd7a3",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "6acca3cd-8761-4eb7-9c31-da51100d9e6b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "31b33d37-f855-4b9d-9414-f254385067ab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3697e164-1bf1-4b22-9400-cad5e462474d",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-12T01:18:15.5510832-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "9331b14f-ff97-424d-b89e-acd19ad389e4",
"Section": {
"FormTypeSectionId": "2aa91648-4e3b-464a-ade4-0466280d419f",
"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": "45421655-8152-4949-beeb-d799670cf5c2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d8064193-2c99-4b43-95c6-c94f85c66fa4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "badfb999-3a9d-4d0e-9bea-8626f4442fdc",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"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": "9331b14f-ff97-424d-b89e-acd19ad389e4",
"Section": {
"FormTypeSectionId": "2aa91648-4e3b-464a-ade4-0466280d419f",
"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": "45421655-8152-4949-beeb-d799670cf5c2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d8064193-2c99-4b43-95c6-c94f85c66fa4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "badfb999-3a9d-4d0e-9bea-8626f4442fdc",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"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": "abe6539f-690d-4fe1-9e62-16ff9b642fd6",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-02-12T01:18:15.5510832-08:00",
"Location": "sample string 1",
"TaskId": "c4e2e3ed-2566-4065-a342-d1dee5b94e60",
"Values": [
{
"FormFieldValueId": "a7ccec03-cedc-4a9d-8588-36731f598953",
"FormId": "5cc4c5f1-33e4-4375-80b0-3865c5fe14f6",
"FormTypeField": {
"FormTypeFieldId": "9331b14f-ff97-424d-b89e-acd19ad389e4",
"FormType": {
"FormTypeId": "6acca3cd-8761-4eb7-9c31-da51100d9e6b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "31b33d37-f855-4b9d-9414-f254385067ab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3697e164-1bf1-4b22-9400-cad5e462474d",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-12T01:18:15.5510832-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "abe6539f-690d-4fe1-9e62-16ff9b642fd6",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "2aa91648-4e3b-464a-ade4-0466280d419f",
"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": "45421655-8152-4949-beeb-d799670cf5c2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d8064193-2c99-4b43-95c6-c94f85c66fa4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "badfb999-3a9d-4d0e-9bea-8626f4442fdc",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"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": "a7ccec03-cedc-4a9d-8588-36731f598953",
"FormId": "5cc4c5f1-33e4-4375-80b0-3865c5fe14f6",
"FormTypeField": {
"FormTypeFieldId": "9331b14f-ff97-424d-b89e-acd19ad389e4",
"FormType": {
"FormTypeId": "6acca3cd-8761-4eb7-9c31-da51100d9e6b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "31b33d37-f855-4b9d-9414-f254385067ab",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3697e164-1bf1-4b22-9400-cad5e462474d",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-02-12T01:18:15.5510832-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "abe6539f-690d-4fe1-9e62-16ff9b642fd6",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "2aa91648-4e3b-464a-ade4-0466280d419f",
"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": "45421655-8152-4949-beeb-d799670cf5c2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d8064193-2c99-4b43-95c6-c94f85c66fa4",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "badfb999-3a9d-4d0e-9bea-8626f4442fdc",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ea590ef0-a554-44bd-8666-6bb784861723",
"FieldId": "dcc3e1d7-6427-4d61-9084-d2a51bbc63e6",
"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": "76c869e2-9878-460a-bd24-54b9fa1ec9e0",
"CreateDate": "2026-02-12T01:18:15.5510832-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-12T01:18:15.5510832-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}