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": "02204e2a-ec2d-4086-b962-7a7034be634e",
"Asset": {
"AssetId": "3f3494b9-a3c5-4673-aa9f-2ccbe84d3de5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "87598bd6-fb2e-4ef1-8023-90f11f921526",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e2dda7ac-079f-43ca-985c-a8f43ba9feaa",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "a983246e-99ea-49b7-9847-b4a237a13745",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-22T10:26:23.4569947-08:00",
"MeasurementValueNeededDate": "2026-01-22T10:26:23.4569947-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3f471a61-d60b-4dad-a34f-fbfc01b1a17c",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-22T10:26:23.4569947-08:00",
"MeasurementValueNeededDate": "2026-01-22T10:26:23.4569947-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d0301d6c-611e-463b-8007-ecd215990c8e",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "1ed66cdf-a042-448c-ad7c-6ab014dfc370",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "87598bd6-fb2e-4ef1-8023-90f11f921526",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e2dda7ac-079f-43ca-985c-a8f43ba9feaa",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-22T10:26:23.4569947-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "a820f11c-3260-4418-8e68-df6f7361712d",
"Section": {
"FormTypeSectionId": "38266677-4080-46ad-909b-d7bbc4323c1c",
"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": "799b783b-4e85-4aac-b3d3-a7c1c102a1e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ec799f5-e4e2-4208-bcb5-ec0e0f5e04de",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97758d37-a06c-4ebe-90c9-a2d6e8fa7832",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"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": "a820f11c-3260-4418-8e68-df6f7361712d",
"Section": {
"FormTypeSectionId": "38266677-4080-46ad-909b-d7bbc4323c1c",
"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": "799b783b-4e85-4aac-b3d3-a7c1c102a1e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ec799f5-e4e2-4208-bcb5-ec0e0f5e04de",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97758d37-a06c-4ebe-90c9-a2d6e8fa7832",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"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": "27288b76-1b3f-4f33-9c92-30ca82ba6ba4",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-01-22T10:26:23.4569947-08:00",
"Location": "sample string 1",
"TaskId": "88b518c4-8cd0-4964-b95e-aee23d029559",
"Values": [
{
"FormFieldValueId": "5c7d5969-af8a-4a25-a484-ce0fae4b4dc1",
"FormId": "54e56795-fd19-44da-8dcd-8fc896ec9eca",
"FormTypeField": {
"FormTypeFieldId": "a820f11c-3260-4418-8e68-df6f7361712d",
"FormType": {
"FormTypeId": "1ed66cdf-a042-448c-ad7c-6ab014dfc370",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "87598bd6-fb2e-4ef1-8023-90f11f921526",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e2dda7ac-079f-43ca-985c-a8f43ba9feaa",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-22T10:26:23.4569947-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "27288b76-1b3f-4f33-9c92-30ca82ba6ba4",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "38266677-4080-46ad-909b-d7bbc4323c1c",
"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": "799b783b-4e85-4aac-b3d3-a7c1c102a1e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ec799f5-e4e2-4208-bcb5-ec0e0f5e04de",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97758d37-a06c-4ebe-90c9-a2d6e8fa7832",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"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": "5c7d5969-af8a-4a25-a484-ce0fae4b4dc1",
"FormId": "54e56795-fd19-44da-8dcd-8fc896ec9eca",
"FormTypeField": {
"FormTypeFieldId": "a820f11c-3260-4418-8e68-df6f7361712d",
"FormType": {
"FormTypeId": "1ed66cdf-a042-448c-ad7c-6ab014dfc370",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "87598bd6-fb2e-4ef1-8023-90f11f921526",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e2dda7ac-079f-43ca-985c-a8f43ba9feaa",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-22T10:26:23.4569947-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "27288b76-1b3f-4f33-9c92-30ca82ba6ba4",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "38266677-4080-46ad-909b-d7bbc4323c1c",
"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": "799b783b-4e85-4aac-b3d3-a7c1c102a1e2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9ec799f5-e4e2-4208-bcb5-ec0e0f5e04de",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "97758d37-a06c-4ebe-90c9-a2d6e8fa7832",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "5d775739-2331-4f42-94f6-224d80d36d56",
"FieldId": "ef38d90d-1cf1-4e8c-84be-1a629629c775",
"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": "faaefc65-582a-45aa-8080-fc4a9f86ea94",
"CreateDate": "2026-01-22T10:26:23.4569947-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-22T10:26:23.4569947-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}