Example Data

Cmdlets for generating sample identity data for testing and evaluation purposes. Example data sets and templates allow you to populate the metaverse with realistic test identities without requiring a live connected system.

---

Get-JIMExampleDataSet

Retrieves available example data sets. Each data set represents a collection of pre-generated identity objects that can be browsed or inspected.

Syntax

Get-JIMExampleDataSet [-Page <int>] [-PageSize <int>]

Parameters

Name	Type	Required	Default	Description
Page	int	No	1	Page number for paginated results.
PageSize	int	No	100	Number of results per page (maximum 1000).

Output

Returns one or more PSCustomObject instances representing example data sets.

Examples

List all example data sets

Get-JIMExampleDataSet

List data sets with pagination

Get-JIMExampleDataSet -Page 2 -PageSize 50

Select specific properties

Get-JIMExampleDataSet | Select-Object Name, Description, ObjectCount

---

Get-JIMExampleDataTemplate

Retrieves data generation templates that define how test data should be generated. Templates specify object types, attribute patterns, and generation rules used when creating sample identity data.

Syntax

# List (default)
Get-JIMExampleDataTemplate [-Page <int>] [-PageSize <int>]

# ById
Get-JIMExampleDataTemplate -Id <int>

# ByName
Get-JIMExampleDataTemplate -Name <string>

Parameters

Name	Type	Required	Default	Description
Id	int	Yes (ById set)		The ID of a specific template to retrieve. Accepts pipeline input.
Name	string	Yes (ByName set)		The name of a specific template to retrieve.
Page	int	No (List set)	1	Page number for paginated results.
PageSize	int	No (List set)	100	Number of results per page (maximum 1000).

Output

Returns one or more PSCustomObject instances representing data generation templates, each containing properties such as Id, Name, Description, and generation configuration details.

Examples

List all templates

Get-JIMExampleDataTemplate

Get a specific template by ID

Get-JIMExampleDataTemplate -Id 3

Get a template by name

Get-JIMExampleDataTemplate -Name "UK Organisation"

Page through templates

Get-JIMExampleDataTemplate -Page 1 -PageSize 10

---

Invoke-JIMExampleDataTemplate

Executes a data generation template to create identity objects in the metaverse. The operation runs asynchronously on the server; use the -Wait switch to block until generation completes.

Supports ShouldProcess, so you can use -WhatIf or -Confirm to preview or confirm execution before it begins.

Syntax

# ById (default)
Invoke-JIMExampleDataTemplate -Id <int> [-Wait] [-PassThru] [-WhatIf] [-Confirm]

# ByName
Invoke-JIMExampleDataTemplate -Name <string> [-Wait] [-PassThru] [-WhatIf] [-Confirm]

Parameters

Name	Type	Required	Default	Description
Id	int	Yes (ById set)		The ID of the template to execute. Accepts pipeline input.
Name	string	Yes (ByName set)		The name of the template to execute.
Wait	switch	No	false	Block until the data generation operation completes on the server.
PassThru	switch	No	false	Return execution information to the pipeline.
WhatIf	switch	No		Preview the operation without executing it.
Confirm	switch	No		Prompt for confirmation before executing.

Output

By default, this cmdlet produces no output. When -PassThru is specified, returns a PSCustomObject containing execution information such as the activity ID and status.

Examples

Execute a template by ID

Invoke-JIMExampleDataTemplate -Id 3

Execute a template by name and wait for completion

Invoke-JIMExampleDataTemplate -Name "UK Organisation" -Wait

Execute and capture execution information

$result = Invoke-JIMExampleDataTemplate -Id 3 -Wait -PassThru
$result

Pipeline from Get-JIMExampleDataTemplate

Get-JIMExampleDataTemplate -Name "UK Organisation" |
    Invoke-JIMExampleDataTemplate -Wait -PassThru

Preview without executing

Invoke-JIMExampleDataTemplate -Id 3 -WhatIf

---

See also

• Metaverse: cmdlets for managing the metaverse schema and querying identity objects
• Activities: cmdlets for reviewing activity history and execution results