Skip to content

Get-EasitGODatasource

SYNOPSIS

Get datasources from Easit GO.

SYNTAX

1
2
3
4
Get-EasitGODatasource [-Url] <String> [-Apikey] <String> [-ModuleId] <Int32> [[-ParentRawValue] <String>]
 [[-InvokeRestMethodParameters] <Hashtable>] [-ReturnAsSeparateObjects]
 [[-ConvertToJsonParameters] <Hashtable>] [-WriteBody] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

With Get-EasitGODatasource you can get datasources for a specific module from Easit GO. If no ParentRawValue is provided the function returns the modules root datasources.

EXAMPLES

EXAMPLE 1

1
2
3
4
5
6
$getDatasourceFromEasitGO = @{
    Url = 'https://url.to.EasitGO'
    Apikey = 'myApiKey'
    ModuleId = 1001
}
Get-EasitGODatasource @getDatasourceFromEasitGO

In this example we want to get all datasources in the root in the module with id 1001.

EXAMPLE 2

1
2
3
4
5
6
7
$getDatasourceFromEasitGO = @{
    Url = 'https://url.to.EasitGO'
    Apikey = 'myApiKey'
    ModuleId = 1001
    ParentRawValue = '5:1'
}
Get-EasitGODatasource @getDatasourceFromEasitGO

In this example we want to get all child datasources to the data source with databaseId (or rawValue) 5:1 in the module with id 1001.

EXAMPLE 3

1
2
3
4
5
6
7
8
$getDatasourceFromEasitGO = @{
    Url = 'https://url.to.EasitGO'
    Apikey = 'myApiKey'
    ModuleId = 1001
    ParentRawValue = '5:1'
    ReturnAsSeparateObjects = $true
}
Get-EasitGODatasource @getDatasourceFromEasitGO

In this example we want to get all child datasources to the data source with databaseId (or rawValue) 5:1 in the module with id 1001 and we want them returned as separate objects.

PARAMETERS

-Apikey

Apikey used for authenticating to Easit GO.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConvertToJsonParameters

Set of additional parameters for ConvertTo-Json. Base parameters sent to ConvertTo-Json is 'Depth = 4', 'EscapeHandling = 'EscapeNonAscii'', 'WarningAction = 'SilentlyContinue''.

1
2
3
4
5
6
7
8
9
Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InvokeRestMethodParameters

Set of additional parameters for Invoke-RestMethod. Base parameters sent to Invoke-RestMethod is 'Uri','ContentType', 'Method', 'Body', 'Authentication' and 'Credential'.

1
2
3
4
5
6
7
8
9
Type: Hashtable
Parameter Sets: (All)
Aliases: irmParams

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ModuleId

Specifies what module to get datasources from.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ParentRawValue

Specifies what datasource to get child datasources from. If not specified, root level datasources will be returned.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

The ProgressAction parameter takes one of the ActionPreference enumeration values: SilentlyContinue, Stop, Continue, Inquire, Ignore, Suspend, or Break.

1
2
3
4
5
6
7
8
9
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ReturnAsSeparateObjects

Specifies if Get-EasitGOItem should return each item in the view as its own PSCustomObject.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Url

URL to Easit GO.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WriteBody

If specified the function will try to write the request body to a file in the current directory.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None - You cannot pipe objects to this function

OUTPUTS

PSCustomObject

NOTES