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": "f3fca03a-1ab6-4d38-962c-949b573442dc",
"Asset": {
"AssetId": "4a86d321-b5ad-4c6e-be95-665e505d6dd7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c9822916-b832-44c9-8f24-d04c96f2392e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7db3ac67-084b-4c35-b7f4-da9b3093a72a",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1eb1fc0e-acc6-4584-8c26-f9158c4e0ecb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-16T16:21:21.0989448-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:21:21.0989448-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dd05d45f-01e1-483e-aa33-f95ab85a954e",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-01-16T16:21:21.0989448-08:00",
"MeasurementValueNeededDate": "2026-01-16T16:21:21.0989448-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d9007e1b-61a6-4f46-972f-0ec123caa4d1",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "f9ba460b-2e3d-4620-8467-e13b89efefca",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c9822916-b832-44c9-8f24-d04c96f2392e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7db3ac67-084b-4c35-b7f4-da9b3093a72a",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-16T16:21:21.0989448-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "377e1763-b81c-4cd0-9e3a-33383df95a18",
"Section": {
"FormTypeSectionId": "ba87f0ce-0d4d-40b0-b97d-55de5cb135ca",
"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": "986ab108-cf3f-4b90-b2a0-ca5b5f73f4bd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "237d24af-88a2-497e-88d2-c949f713864b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25736f08-23d2-4d43-9c38-0d4066d086da",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"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": "377e1763-b81c-4cd0-9e3a-33383df95a18",
"Section": {
"FormTypeSectionId": "ba87f0ce-0d4d-40b0-b97d-55de5cb135ca",
"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": "986ab108-cf3f-4b90-b2a0-ca5b5f73f4bd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "237d24af-88a2-497e-88d2-c949f713864b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25736f08-23d2-4d43-9c38-0d4066d086da",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"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": "4e39d164-2c3f-4a16-902d-a2904197b144",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-01-16T16:21:21.0989448-08:00",
"Location": "sample string 1",
"TaskId": "c07bdc7b-0e42-488b-8f0e-dc035737f604",
"Values": [
{
"FormFieldValueId": "56417a66-f4a5-427b-821f-763f6248a0df",
"FormId": "12a84cc4-b75d-4804-9dda-a245cd57f228",
"FormTypeField": {
"FormTypeFieldId": "377e1763-b81c-4cd0-9e3a-33383df95a18",
"FormType": {
"FormTypeId": "f9ba460b-2e3d-4620-8467-e13b89efefca",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c9822916-b832-44c9-8f24-d04c96f2392e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7db3ac67-084b-4c35-b7f4-da9b3093a72a",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-16T16:21:21.0989448-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "4e39d164-2c3f-4a16-902d-a2904197b144",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "ba87f0ce-0d4d-40b0-b97d-55de5cb135ca",
"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": "986ab108-cf3f-4b90-b2a0-ca5b5f73f4bd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "237d24af-88a2-497e-88d2-c949f713864b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25736f08-23d2-4d43-9c38-0d4066d086da",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"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": "56417a66-f4a5-427b-821f-763f6248a0df",
"FormId": "12a84cc4-b75d-4804-9dda-a245cd57f228",
"FormTypeField": {
"FormTypeFieldId": "377e1763-b81c-4cd0-9e3a-33383df95a18",
"FormType": {
"FormTypeId": "f9ba460b-2e3d-4620-8467-e13b89efefca",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c9822916-b832-44c9-8f24-d04c96f2392e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7db3ac67-084b-4c35-b7f4-da9b3093a72a",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-16T16:21:21.0989448-08:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "4e39d164-2c3f-4a16-902d-a2904197b144",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "ba87f0ce-0d4d-40b0-b97d-55de5cb135ca",
"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": "986ab108-cf3f-4b90-b2a0-ca5b5f73f4bd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "237d24af-88a2-497e-88d2-c949f713864b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "25736f08-23d2-4d43-9c38-0d4066d086da",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0eb50cef-1890-440d-a9e9-f09442dba131",
"FieldId": "cce0269a-40a9-4ebc-b0e8-d9ac337bfba1",
"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": "77b1489a-e42c-49ea-9d85-6d9d94a96873",
"CreateDate": "2026-01-16T16:21:21.0989448-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-16T16:21:21.0989448-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}