-
Notifications
You must be signed in to change notification settings - Fork 0
Get FscmOdata
Query an OData entity from a Finance and Operations environment.
Get-FscmOdata -EnvironmentId <String> -Entity <String> [-ODataQuery <String>] [-CrossCompany] [-AsExcelOutput]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FscmOdata -EnvironmentId <String> -Entity <String> [-ODataQuery <String>] [-CrossCompany]
[-TraverseNextLink] [-ThrottleSeed <Int32>] [-AsExcelOutput] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Invokes a GET request against the Finance and Operations OData endpoint for the specified entity, handling authentication, optional query filters, cross-company access, and automatic pagination via nextLink traversal.
Includes built-in retry logic for 429 (Too Many Requests) responses.
Get-FscmOdata -EnvironmentId "ContosoEnv" -Entity "SysAADClients"
This command retrieves all records from the SysAADClients OData entity in the environment "ContosoEnv".
Get-FscmOdata -EnvironmentId "ContosoEnv" -Entity "SystemUsers" -ODataQuery "`$filter=IsActive eq true"
This command retrieves all active system users from the environment "ContosoEnv" using an OData filter.
Get-FscmOdata -EnvironmentId "ContosoEnv" -Entity "SystemUsers" -CrossCompany
This command retrieves system users across all legal entities in the environment "ContosoEnv".
Get-FscmOdata -EnvironmentId "ContosoEnv" -Entity "SysAADClients" -TraverseNextLink
This command retrieves all records from the SysAADClients entity, following pagination links until all pages are returned.
Get-FscmOdata -EnvironmentId "ContosoEnv" -Entity "SysAADClients" -TraverseNextLink -ThrottleSeed 3
This command retrieves all pages from the SysAADClients entity, pausing between 1 and 3 seconds between each page request to reduce the risk of throttling.
Get-FscmOdata -EnvironmentId "ContosoEnv" -Entity "SysAADClients" -AsExcelOutput
This command retrieves all records from the SysAADClients entity in the environment "ContosoEnv" and exports the results to an Excel file.
The ID of the environment to query.
Can be either the environment name, the environment GUID (PPAC) or the LCS environment ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe OData entity name to query, e.g. "SysAADClients" or "SystemUsers".
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAn optional OData query string to append to the request, e.g. "`$filter=IsActive eq true&`$select=UserId,Name".
Do not include the leading "?".
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseInstructs the cmdlet to append "cross-company=true" to the request, returning records across all legal entities.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseInstructs the cmdlet to follow "@odata.nextLink" pagination and accumulate all pages into the result.
Must be used together with the NextLink parameter set.
Type: SwitchParameter
Parameter Sets: NextLink
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseWhen specified, introduces a random delay between 1 and ThrottleSeed seconds after each page request to reduce throttling risk.
Only valid when TraverseNextLink is also specified.
Type: Int32
Parameter Sets: NextLink
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseInstructs the cmdlet to export the retrieved records to an Excel file.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Author: Mötz Jensen (@Splaxi)