Get-CustomObjects
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-CustomObjects
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Summary
Retrieves a collection of custom object instances.
Get-CustomObjects
-CustomObjectId
-Top
-Skip
-Filter
-OrderByReturns a collection object with the following properties:
Property | Type | Notes |
|---|---|---|
Collection | Collection of task comment objects | The collection of entries retrieved after top, skip, filter, and order by parameters were applied. |
Top | Int32 | The top parameter value that was used. Useful while paging data. |
Skip | Int32 | The skip parameter value that was used. Useful while paging data. |
TotalCount | Int32 | The total count of records available after any filtering was applied. Useful while paging data. |
Parameters
Parameter | Type | Required? | Notes |
|---|---|---|---|
CustomObjectId | Int32 | Yes | The 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. |
Top | Int32 | No, Defaults to 40 | Total number of entries to retrieve. Max is 1000. |
Skip | Int32 | No, Defaults to 0 | How many entries should be skipped within the collection. Used for paging the results. |
Filter | String | No | An OData 4 string that can be used for filtering the collection. |
OrderBy | String | No | An 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