Contents x
    Get-CustomObjects
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get-CustomObjects

    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Summary

    Retrieves a collection of custom object instances.

    Get-CustomObjects
    -CustomObjectId
    -Top
    -Skip
    -Filter
    -OrderBy

    Returns a collection object with the following properties:

    PropertyTypeNotes
    CollectionCollection of task comment objectsThe collection of entries retrieved after top, skip, filter, and order by parameters were applied.
    TopInt32The top parameter value that was used. Useful while paging data.
    SkipInt32The skip parameter value that was used. Useful while paging data.
    TotalCountInt32The total count of records available after any filtering was applied. Useful while paging data.

    Parameters

    ParameterTypeRequired?Notes
    CustomObjectIdInt32YesThe custom object id directs the command to which object collection of data to pull. The Id can be found within the UI on the objects grid or by using the Get-Objects command within a script.
    TopInt32No, Defaults to 40Total number of entries to retrieve. Max is 1000.
    SkipInt32No, Defaults to 0How many entries should be skipped within the collection. Used for paging the results.
    FilterStringNoAn OData 4 string that can be used for filtering the collection.
    OrderByStringNoAn OData 4 string that can be used for sorting the collection by specific fields.

    Examples

    Get a collection of custodians (a custom object created within the workspace)

    # Retrieve one record from the collection, since we're only interested in the total count.
$collectionWrapper = Get-CustomObjects -CustomObjectId 10 -Top 1

Write-Output "There are $($collectionWrapper.TotalCount) custodian(s) in the workspace"
    There are 780 custodian(s) in the workspace
    What's Next