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": "23a53248-0680-4340-a801-1aa8588072db",
"Asset": {
"AssetId": "9da56eec-4945-40b9-8003-5fb3d1fb36b9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9f4d1c79-95f6-4046-aa1b-7371c391130f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a47b3c47-b789-48d1-8239-02e514d749d7",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3cd804bf-98d0-489c-b0c6-b7f6f5848674",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-20T21:55:42.0706083-07:00",
"MeasurementValueNeededDate": "2026-05-20T21:55:42.0706083-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "850dbc4a-5469-4273-b294-258f578fc4a5",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-05-20T21:55:42.0706083-07:00",
"MeasurementValueNeededDate": "2026-05-20T21:55:42.0706083-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6f5cf532-a7cb-480a-9f9d-c5010ccdbced",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "70890776-fab7-437e-8d5c-f1761b1f52b8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9f4d1c79-95f6-4046-aa1b-7371c391130f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a47b3c47-b789-48d1-8239-02e514d749d7",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-20T21:55:42.0706083-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "3edae206-205f-410c-80f6-34421df2b4ff",
"Section": {
"FormTypeSectionId": "ec46c83f-7685-44f4-9bf6-c614fbab22b8",
"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": "07c6d635-25ea-4c28-b73e-00fab4da3b27",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "425dd566-3bf5-4348-8fae-81fa39d230f7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2426814e-9705-4fc7-9002-77f5539a7ded",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"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": "3edae206-205f-410c-80f6-34421df2b4ff",
"Section": {
"FormTypeSectionId": "ec46c83f-7685-44f4-9bf6-c614fbab22b8",
"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": "07c6d635-25ea-4c28-b73e-00fab4da3b27",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "425dd566-3bf5-4348-8fae-81fa39d230f7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2426814e-9705-4fc7-9002-77f5539a7ded",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"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": "9caccd5d-da84-4c18-be0b-c73469221d16",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-05-20T21:55:42.0706083-07:00",
"Location": "sample string 1",
"TaskId": "54c58407-bdc5-4ef1-adea-21f198cd4c85",
"Values": [
{
"FormFieldValueId": "27bc7b87-521b-40de-bc91-018532b9bcd3",
"FormId": "9b14bc8f-22fb-44e1-98a4-fd0f07ebd887",
"FormTypeField": {
"FormTypeFieldId": "3edae206-205f-410c-80f6-34421df2b4ff",
"FormType": {
"FormTypeId": "70890776-fab7-437e-8d5c-f1761b1f52b8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9f4d1c79-95f6-4046-aa1b-7371c391130f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a47b3c47-b789-48d1-8239-02e514d749d7",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-20T21:55:42.0706083-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "9caccd5d-da84-4c18-be0b-c73469221d16",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "ec46c83f-7685-44f4-9bf6-c614fbab22b8",
"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": "07c6d635-25ea-4c28-b73e-00fab4da3b27",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "425dd566-3bf5-4348-8fae-81fa39d230f7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2426814e-9705-4fc7-9002-77f5539a7ded",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"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": "27bc7b87-521b-40de-bc91-018532b9bcd3",
"FormId": "9b14bc8f-22fb-44e1-98a4-fd0f07ebd887",
"FormTypeField": {
"FormTypeFieldId": "3edae206-205f-410c-80f6-34421df2b4ff",
"FormType": {
"FormTypeId": "70890776-fab7-437e-8d5c-f1761b1f52b8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9f4d1c79-95f6-4046-aa1b-7371c391130f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a47b3c47-b789-48d1-8239-02e514d749d7",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-20T21:55:42.0706083-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "9caccd5d-da84-4c18-be0b-c73469221d16",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "ec46c83f-7685-44f4-9bf6-c614fbab22b8",
"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": "07c6d635-25ea-4c28-b73e-00fab4da3b27",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "425dd566-3bf5-4348-8fae-81fa39d230f7",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2426814e-9705-4fc7-9002-77f5539a7ded",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "73cc94e0-aba5-4e80-81da-32c04e4e14df",
"FieldId": "07028508-4ab0-40d2-875f-c35d4ecba588",
"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": "250ec39b-469b-4ff4-ad98-869240974ebf",
"CreateDate": "2026-05-20T21:55:42.0706083-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-20T21:55:42.0706083-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}