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": "99f22426-3eb3-4758-96bf-9e6d2ecea1f1",
"Asset": {
"AssetId": "c52a70af-55b0-408b-8ae5-22824407b0ea",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e5de57f1-dae7-46fc-8d7d-e8bcde838c0a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e993894a-482f-407f-847a-715aeee0a5a5",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "4b1cfc18-ffa2-4374-85d3-911e2dde0ebd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-30T15:56:36.4826343-07:00",
"MeasurementValueNeededDate": "2026-04-30T15:56:36.4826343-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "46718a46-ade6-4b2a-b24a-c3be703725fa",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-30T15:56:36.4826343-07:00",
"MeasurementValueNeededDate": "2026-04-30T15:56:36.4826343-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "00fa58d3-9cba-49ee-b265-6745705924b9",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "e2f2a7a1-8b40-4576-8d56-ab052ed964cd",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e5de57f1-dae7-46fc-8d7d-e8bcde838c0a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e993894a-482f-407f-847a-715aeee0a5a5",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-30T15:56:36.4826343-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "e85f10a7-f60c-4ac0-835a-454d16fc35ba",
"Section": {
"FormTypeSectionId": "b7717a33-e9f1-4114-805a-e5b5e71cc92e",
"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": "0f6aff92-fbc6-4f1e-9d6f-2e36ba1f2101",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "677dbae2-fd9c-40a9-a5ea-724e8940432c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "08859eaf-9e55-4f38-92e8-cd03419eb86f",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"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": "e85f10a7-f60c-4ac0-835a-454d16fc35ba",
"Section": {
"FormTypeSectionId": "b7717a33-e9f1-4114-805a-e5b5e71cc92e",
"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": "0f6aff92-fbc6-4f1e-9d6f-2e36ba1f2101",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "677dbae2-fd9c-40a9-a5ea-724e8940432c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "08859eaf-9e55-4f38-92e8-cd03419eb86f",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"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": "de9892a8-7238-4656-9d8d-4d321120d780",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-04-30T15:56:36.4826343-07:00",
"Location": "sample string 1",
"TaskId": "a7897069-1f07-44c0-b0fb-32ab5f10c269",
"Values": [
{
"FormFieldValueId": "b5b7f85f-269e-4468-94ba-281fb6960449",
"FormId": "cac5d54f-8586-43c9-aa35-76dc45723169",
"FormTypeField": {
"FormTypeFieldId": "e85f10a7-f60c-4ac0-835a-454d16fc35ba",
"FormType": {
"FormTypeId": "e2f2a7a1-8b40-4576-8d56-ab052ed964cd",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e5de57f1-dae7-46fc-8d7d-e8bcde838c0a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e993894a-482f-407f-847a-715aeee0a5a5",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-30T15:56:36.4826343-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "de9892a8-7238-4656-9d8d-4d321120d780",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "b7717a33-e9f1-4114-805a-e5b5e71cc92e",
"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": "0f6aff92-fbc6-4f1e-9d6f-2e36ba1f2101",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "677dbae2-fd9c-40a9-a5ea-724e8940432c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "08859eaf-9e55-4f38-92e8-cd03419eb86f",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"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": "b5b7f85f-269e-4468-94ba-281fb6960449",
"FormId": "cac5d54f-8586-43c9-aa35-76dc45723169",
"FormTypeField": {
"FormTypeFieldId": "e85f10a7-f60c-4ac0-835a-454d16fc35ba",
"FormType": {
"FormTypeId": "e2f2a7a1-8b40-4576-8d56-ab052ed964cd",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e5de57f1-dae7-46fc-8d7d-e8bcde838c0a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e993894a-482f-407f-847a-715aeee0a5a5",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-30T15:56:36.4826343-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "de9892a8-7238-4656-9d8d-4d321120d780",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "b7717a33-e9f1-4114-805a-e5b5e71cc92e",
"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": "0f6aff92-fbc6-4f1e-9d6f-2e36ba1f2101",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "677dbae2-fd9c-40a9-a5ea-724e8940432c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "08859eaf-9e55-4f38-92e8-cd03419eb86f",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c7c4af13-fa0e-4523-9ce3-f9908111b6ff",
"FieldId": "e9e5cb03-af68-4b1d-b4a4-df22b11d6baa",
"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": "9a9a6114-6787-4139-a91b-7cddee652244",
"CreateDate": "2026-04-30T15:56:36.4826343-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T15:56:36.4826343-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}