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": "53d7c54b-36b0-4871-b975-2f8f7f703803",
"Asset": {
"AssetId": "f46bf284-cbee-4e84-96e0-c148ce1dd928",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3ee10ae7-4de7-42d7-bdef-fac92bf58361",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d1f7fd57-7afa-49fd-bd73-3a2fc0392063",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "ed47e806-a484-4925-8ad8-20533f0ce98e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-28T18:03:46.2960207-07:00",
"MeasurementValueNeededDate": "2026-09-28T18:03:46.2960207-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "74e1ece0-d4de-488d-8c47-f461430cdfff",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-28T18:03:46.2960207-07:00",
"MeasurementValueNeededDate": "2026-09-28T18:03:46.2960207-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f2f4586f-0dd0-4219-a202-d23a3da8b8bb",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "4b7daa55-a730-4501-a6f2-caa405bdfee3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3ee10ae7-4de7-42d7-bdef-fac92bf58361",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d1f7fd57-7afa-49fd-bd73-3a2fc0392063",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-28T18:03:46.2960207-07:00",
"Fields": [
{
"FormTypeFieldId": "d3341668-33e0-4a1d-8b1a-f17efa3b2a15",
"Section": {
"FormTypeSectionId": "5f67c41e-da74-421f-9b53-8cb1a5da88f0",
"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": "9278f8c1-0343-49e1-9c41-bedddf3b0c12",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e373f7d5-81d1-491b-a36c-8a8a96bc027d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "998ca804-bc47-4d07-929e-f2dd004dd07f",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-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": "d3341668-33e0-4a1d-8b1a-f17efa3b2a15",
"Section": {
"FormTypeSectionId": "5f67c41e-da74-421f-9b53-8cb1a5da88f0",
"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": "9278f8c1-0343-49e1-9c41-bedddf3b0c12",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e373f7d5-81d1-491b-a36c-8a8a96bc027d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "998ca804-bc47-4d07-929e-f2dd004dd07f",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-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": "4a5f87ad-3e9c-4446-8aaf-f65fdcfd4566",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-09-28T18:03:46.2960207-07:00",
"Location": "sample string 1",
"TaskId": "ba992c48-74ec-464a-beda-0e895daf8aa8",
"Values": [
{
"FormFieldValueId": "ca09ab31-07ef-482b-b7d8-29760aeb8563",
"FormTypeField": {
"FormTypeFieldId": "d3341668-33e0-4a1d-8b1a-f17efa3b2a15",
"Section": {
"FormTypeSectionId": "5f67c41e-da74-421f-9b53-8cb1a5da88f0",
"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": "9278f8c1-0343-49e1-9c41-bedddf3b0c12",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e373f7d5-81d1-491b-a36c-8a8a96bc027d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "998ca804-bc47-4d07-929e-f2dd004dd07f",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-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": "ca09ab31-07ef-482b-b7d8-29760aeb8563",
"FormTypeField": {
"FormTypeFieldId": "d3341668-33e0-4a1d-8b1a-f17efa3b2a15",
"Section": {
"FormTypeSectionId": "5f67c41e-da74-421f-9b53-8cb1a5da88f0",
"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": "9278f8c1-0343-49e1-9c41-bedddf3b0c12",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e373f7d5-81d1-491b-a36c-8a8a96bc027d",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "998ca804-bc47-4d07-929e-f2dd004dd07f",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-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": "0713af99-f334-4fa1-808d-494f683102e4",
"CreateDate": "2026-09-28T18:03:46.2960207-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-28T18:03:46.2960207-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}