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": "d9906fdb-2217-4904-a06f-442957bd2836",
"Asset": {
"AssetId": "d0339fdd-cc71-4249-b605-42e3cb0b1c09",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d10a4cd1-cfde-4b63-b57f-4f7a8a42e01e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6eb99881-7780-471f-be82-58679649d688",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3b3a95c5-7479-40fe-8725-3bbb12f48b85",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-02T00:33:42.7997845-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:33:42.7997845-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9c09d19c-cf4f-4d43-9aed-247e94a7e4f1",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-02T00:33:42.7997845-07:00",
"MeasurementValueNeededDate": "2026-09-02T00:33:42.7997845-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "83d199e3-d0ae-4cdf-8d70-e8172d53ea1e",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "387c0473-5da6-4ccc-a1f9-f66128657f14",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d10a4cd1-cfde-4b63-b57f-4f7a8a42e01e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6eb99881-7780-471f-be82-58679649d688",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-02T00:33:42.7997845-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "fac6ac82-c943-48f9-8cb1-beb93cb04340",
"Section": {
"FormTypeSectionId": "da5c5dba-fe57-4e8b-b301-440d51035657",
"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": "96975b63-29fc-4c18-b653-21c0d395d2db",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80c8b36b-c962-4eec-bc61-ee90444932ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7587f321-dc7f-409f-b0a7-46328071f437",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"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": "fac6ac82-c943-48f9-8cb1-beb93cb04340",
"Section": {
"FormTypeSectionId": "da5c5dba-fe57-4e8b-b301-440d51035657",
"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": "96975b63-29fc-4c18-b653-21c0d395d2db",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80c8b36b-c962-4eec-bc61-ee90444932ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7587f321-dc7f-409f-b0a7-46328071f437",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"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": "7b16936a-db7c-4c79-8dd2-47964a1975b9",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-09-02T00:33:42.7997845-07:00",
"Location": "sample string 1",
"TaskId": "05c97ebc-2732-4bbc-8bc9-9e638e0d1d5e",
"Values": [
{
"FormFieldValueId": "db2af047-0717-474b-93fe-71987d1a0a51",
"FormId": "3218bf76-6982-48a7-a422-16e1734a7251",
"FormTypeField": {
"FormTypeFieldId": "fac6ac82-c943-48f9-8cb1-beb93cb04340",
"FormType": {
"FormTypeId": "387c0473-5da6-4ccc-a1f9-f66128657f14",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d10a4cd1-cfde-4b63-b57f-4f7a8a42e01e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6eb99881-7780-471f-be82-58679649d688",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-02T00:33:42.7997845-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "7b16936a-db7c-4c79-8dd2-47964a1975b9",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "da5c5dba-fe57-4e8b-b301-440d51035657",
"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": "96975b63-29fc-4c18-b653-21c0d395d2db",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80c8b36b-c962-4eec-bc61-ee90444932ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7587f321-dc7f-409f-b0a7-46328071f437",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"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": "db2af047-0717-474b-93fe-71987d1a0a51",
"FormId": "3218bf76-6982-48a7-a422-16e1734a7251",
"FormTypeField": {
"FormTypeFieldId": "fac6ac82-c943-48f9-8cb1-beb93cb04340",
"FormType": {
"FormTypeId": "387c0473-5da6-4ccc-a1f9-f66128657f14",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d10a4cd1-cfde-4b63-b57f-4f7a8a42e01e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6eb99881-7780-471f-be82-58679649d688",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-02T00:33:42.7997845-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "7b16936a-db7c-4c79-8dd2-47964a1975b9",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "da5c5dba-fe57-4e8b-b301-440d51035657",
"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": "96975b63-29fc-4c18-b653-21c0d395d2db",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "80c8b36b-c962-4eec-bc61-ee90444932ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7587f321-dc7f-409f-b0a7-46328071f437",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6857800d-6c9a-4789-9f9c-1ab397470a57",
"FieldId": "d7a68c9b-482d-4999-881f-3ce1aed11320",
"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": "14357781-734c-47c2-92c3-ad349e46c76e",
"CreateDate": "2026-09-02T00:33:42.7997845-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-02T00:33:42.7997845-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}