Invoke-CIPPRestApi is converting hastables to an array

[jonwbstr]

Description

When running the following code I was getting the error, "Invoke-RestMethod: Error - Could not add task: The property 'ScheduledTime' cannot be found on this object. Verify that the property exists and can be set."

# Get jobs
$BodyPayload = @{
    TenantFilter = "AllTenants"
    ShowHidden = $true
}
$AllJobs = Invoke-CIPPRestMethod -Endpoint "/api/ListScheduledItems" -method POST -Body $BodyPayload

$Job = $AllJobs[0]

$UpdatePayload = @{
        RowKey        = $Job.RowKey
        Name          = $Job.Name
        tenantFilter  = $Job.Tenant
        Hidden        = $Job.Hidden
        Command       = $Job.Command
        Parameters    = $Job.Parameters
        Recurrence    = $Job.Recurrence
        ScheduledTime = $NewScheduleTime
    }
Invoke-CippRestMethod -Endpoint '/api/AddScheduledItem' -Method 'POST' -Body $UpdatePayload|Out-Null

Upon inspection I found Invoke-CIPPRestMethod defines Body as a hashtable array:

[hashtable[]]$Body = @{},

After changing it to the following, the command completed successfully:

[hashtable]$Body = @{}

Environment data

Module Version Number: v10.5.5
CIPP Backend version number: v10.5.6

[jonwbstr]

I ended up adding a new parameter to Invoke-CIPPRestMethod as a short term solution named BodyNoArray

if($BodyNoArray) { [hashtable]$Body = $BodyNoArray }

I'm balancing jobs because Hudu was struggling to keep up with the jobs happening all at once. There is a bigger fix in the works with CIPP so hopefully this isn't a long term fix. Putting this here in case my future self or someone else finds it useful. 😄

Write-Host "Fetching system jobs from CIPP..." -ForegroundColor Cyan
$BodyPayload = @{
    TenantFilter = "AllTenants"
    ShowHidden = $true
}

$AllJobs = Invoke-CIPPRestMethod -Endpoint "/api/ListScheduledItems" -method POST -Body $BodyPayload
$HuduJobs = $alljobs|?{$_.parameters.extension -eq "Hudu"}

if ($HuduJobs.Count -eq 0) {
    Write-Error "No scheduled jobs matching 'Hudu' were found."
    exit
}

Write-Host "Found $($HuduJobs.Count) Hudu sync jobs to rearrange into batches of $JobsPerWindow." -ForegroundColor Green

# Rebalance existing jobs in batches. Starting at 2AM local time
$JobsPerWindow = 5
$JobCounter   = 0
$MinutesToAdd = 0
$StartTime = (Get-Date).Date.AddDays(1).AddHours(2)

foreach ($Job in $HuduJobs[1..500]) {
    # Calculate the current target block time (Unix timestamp, seconds)
    $NewScheduleTime = [int][double]::Parse((Get-Date -Date $StartTime.AddMinutes($MinutesToAdd) -UFormat %s))

    Write-Host "Batch Slot [$($StartTime.AddMinutes($MinutesToAdd))] -> Assigning job: $($Job.RowKey)" -ForegroundColor Yellow

    $UpdatePayload = @{
	    RowKey        = $Job.RowKey
        Name          = $Job.Name
        tenantFilter  = $Job.Tenant
		Hidden        = $Job.Hidden
        Command       = $Job.Command
        Parameters    = $Job.Parameters
        Recurrence    = $Job.Recurrence
        ScheduledTime = $NewScheduleTime
    }

    try
    {
        Invoke-CippRestMethod -Endpoint '/api/AddScheduledItem' -Method 'POST' -BodyNoArray $UpdatePayload|Out-Null
    } catch { Write-Host "  Uh oh!" -ForegroundColor Red}

    # Track items inside the current batch
    $JobCounter++

    # If 5 jobs have been assigned to this block, shift the target time forward 15 minutes
    if ($JobCounter -eq $JobsPerWindow) {
        $MinutesToAdd += 15
        $JobCounter    = 0
        Write-Host "  Moving to next time slot" -ForegroundColor Cyan
    }
}

Write-Host "All Hudu sync tasks have been re-balanced"

[kris6673]

@jonwbstr This happens cause of the change in #91, so you kinda did it to yourself :D
I'll see if I can figure something out. Thanks for the bug report!

[jonwbstr]

Hah! Well it didn't take long to find both types of requests are needed!

[kris6673]

Hah! Well it didn't take long to find both types of requests are needed!

True that ^^
Should be fixed in #101 as you can now send both types of body. You'll possibly need to update your scripts to explicitly send a hashtable array, if you dont do that already :)