const recordGUID = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
const res = await vvClient.forms.getFormRelatedForms(recordGUID)Overview
getFormRelatedForms() is a method in the VisualVault Node.js vvClient wrapper that retrieves form records related to the specified form record provided as a parameter.
Use Cases
Basic Data Retrieval: Find all the records related to another specified record by providing its record GUID.
Method Signature
vvClient.forms.getFormRelatedForms(recordGUID)Parameters
Name | Type | Description |
|---|---|---|
| string, required | The GUID of the targeted form record. |
Response
A typical successful response includes:
Name | Type | Description |
|---|---|---|
| Object | Object containing |
| Array | An array of form record objects. If no records are found, data is an empty array. |
Response Examples
Records Found:
{
meta: {
status: 200,
statusMsg: "OK",
method: "GET",
href: "...",
},
data: [
{
href: "~/FormInstance/6131ab14-a8ee-41af-8f93-c7788ffbbc81/forms",
dataType: "FormInstance",
revisionId: "6131ab14-a8ee-41af-8f93-c7788ffbbc81",
instanceName: "TEST-000032",
},
],
}No Record Found:
{
meta: {
status: 200,
statusMsg: "OK",
method: "GET",
href: "...",
},
data: [],
}Invalid GUID value:
{"message": "The request is invalid."}Record Metadata Properties
Each returned record object always includes the following metadata:
Name | Type | Description |
|---|---|---|
| string | Relative URL of the record |
| string | The data type of the instance retrieved |
| string | Record ID |
| string | Record GUID |