Get-GridState

Summary

Retrieves an existing grid state. Grid states contain the state information for grids that are saved. With scripting, grid state information can be applied for other users.

Get-GridState
    -Id

Returns a grid state object.

Parameters

Parameter	Type	Required?	Notes
Id	Int32	Yes	The grid state id.

Examples

Get an existing grid state

This example retrieves a specific grid state and outputs it as JSON.

# Retrieve a specific grid state by id
$gridState = Get-GridState -Id 1

Write-Output "Retrieved grid state $($gridState.GridStateId)"

# Convert the grid state to output as JSON
$jsonOutput = $gridState | ConvertTo-Json -Depth 10

# For debug purposes, convert the grid state to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $gridState | ConvertTo-Json -Depth 10

# Output the grid state
Write-Output $jsonOutput

JSON results:

{
  "GridStateId": 1,
  "UserId": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "GridId": "overviewProjectsGrid",
  "Name": "Default",
  "State": "{\"columns\":[{\"encoded\":true,\"field\":\"\",\"width\":35,\"attributes\":{\"style\":\"text-align: center\"},\"filterable\":false,\"_sortOrder\":0,\"headerAttributes\":{\"id\":\"c64f5b8d-4d67-4145-927f-63279c36f6d8\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"ProjectId\",\"title\":\"Id\",\"width\":130,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"attributes\":{\"style\":\"display:none;text-align: center\"},\"_sortOrder\":1,\"headerAttributes\":{\"id\":\"96abf8ae-e23e-4c76-9e05-5da70f61ab78\",\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"}},{\"encoded\":true,\"field\":\"Status\",\"width\":100,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\"}},\"_sortOrder\":2,\"headerAttributes\":{\"id\":\"eabceca7-a22c-4e8f-bfa7-aed46c4778fe\"}},{\"encoded\":true,\"field\":\"Description\",\"_minWidth\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"width\":291,\"_sortOrder\":3,\"headerAttributes\":{\"id\":\"171680eb-ee45-4235-b74c-510e63bbbf82\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"ClientName\",\"title\":\"Client\",\"width\":225,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"_sortOrder\":4,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"5079d6c5-278f-4e11-9519-2a1c2bc23eb0\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"ClientReference\",\"title\":\"Client Reference\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"_sortOrder\":5,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"eb3b51ff-4970-4e53-b74f-0aa6647ddaa0\",\"style\":\"display:none\"}},{\"encoded\":true,\"field\":\"MatterName\",\"title\":\"Matter\",\"width\":622,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"_sortOrder\":6,\"headerAttributes\":{\"id\":\"918ba9aa-7a08-4656-ac6d-16459ff568de\"}},{\"encoded\":true,\"hidden\":false,\"field\":\"MatterReference\",\"title\":\"Matter Reference\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"_sortOrder\":7,\"headerAttributes\":{\"id\":\"b9b88541-eae5-42f6-94b6-6303af7b4f01\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"ContactFullName\",\"title\":\"Requester\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"_sortOrder\":8,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"bad72eee-5e44-4b49-b2da-5b5b7c9df66c\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"OwnedByFullName\",\"title\":\"Owner\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"_sortOrder\":9,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"797f5971-4bc4-432f-8ebc-7992d33c2644\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":false,\"field\":\"NumberOfTasks\",\"title\":\"Total Tasks\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"_sortOrder\":10,\"template\":\"<span ng-bind='dataItem.NumberOfTasks'>#: data.NumberOfTasks#</span>\",\"headerAttributes\":{\"id\":\"ab735371-fc42-4e64-9c16-81c572c3014b\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"NumberOfMediaLogEntries\",\"title\":\"Total Media Log Entries\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"_sortOrder\":11,\"template\":\"<span ng-bind='dataItem.NumberOfMediaLogEntries'>#: data.NumberOfMediaLogEntries#</span>\",\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"9a61fb12-a61f-480b-832b-1d20a9b536a9\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":false,\"field\":\"Assignees\",\"width\":175,\"filterable\":false,\"sortable\":false,\"_sortOrder\":12,\"headerAttributes\":{\"id\":\"a32d7855-21e4-45d4-ac30-5f64ee908ab0\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"NumberOfVolumes\",\"title\":\"Total Volumes\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"_sortOrder\":13,\"template\":\"<span ng-bind='dataItem.NumberOfVolumes'>#: data.NumberOfVolumes#</span>\",\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"068cb911-d0c6-4364-aefe-7a7b12333032\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"NumberOfBillingEntries\",\"title\":\"Total Billing Entries\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"_sortOrder\":14,\"template\":\"<span ng-bind='dataItem.NumberOfBillingEntries'>#: data.NumberOfBillingEntries#</span>\",\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"55c8e67d-87bb-40ae-bd4a-4eff835dcbb1\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"DateReceived\",\"title\":\"Date Received\",\"width\":175,\"filterable\":{\"extra\":true,\"cell\":{\"enabled\":false}},\"template\":\"<span class=\\\"ab-no-wrap\\\" title=\\\"'#= DateReceived #'\\\">#= moment(DateReceived).format('M/D/YYYY [at] h:mm a') #</span>\",\"_sortOrder\":15,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"d5b4b6ea-6749-4816-a506-51bc3cc8d2e0\",\"style\":\"display:none\"}},{\"encoded\":true,\"field\":\"DateDue\",\"title\":\"Date Due\",\"width\":175,\"filterable\":{\"extra\":true,\"cell\":{\"enabled\":false}},\"_sortOrder\":16,\"headerAttributes\":{\"id\":\"3dec5a36-8201-46eb-8416-84726d09deff\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"IsLate\",\"title\":\"Is Late?\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"template\":\"#= IsLate ? \\\"Yes\\\" : \\\"No\\\" #\",\"_sortOrder\":17,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"8fbdd887-8dd2-4ebc-a01e-f89d68105133\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"IsApproved\",\"title\":\"Is Approved?\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"template\":\"#= IsApproved ? \\\"Yes\\\" : \\\"No\\\" #\",\"_sortOrder\":18,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"720f04da-9582-4022-adcf-656e2f7d9078\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"Priority\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\"}},\"_sortOrder\":19,\"template\":\"<span ng-bind='dataItem.Priority'>#: data.Priority#</span>\",\"headerAttributes\":{\"id\":\"4657e709-0f81-4bab-b826-dc7f18fe75ac\",\"style\":\"display:none\"},\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"DateInvoiced\",\"title\":\"Date Invoiced\",\"width\":175,\"filterable\":{\"extra\":true,\"cell\":{\"enabled\":false}},\"_sortOrder\":20,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"55d05c69-f645-4464-834d-952de180e628\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":false,\"field\":\"CreatedByFullName\",\"title\":\"Created By\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"contains\",\"dataSource\":{}}},\"template\":\"<span class=\\\"ab-no-wrap\\\">#= CreatedByFullName #</span>\",\"_sortOrder\":21,\"headerAttributes\":{\"id\":\"19ad563c-deff-4ab1-8ab8-afb2d0c40efb\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"CreatedOn\",\"title\":\"Created On\",\"filterable\":{\"extra\":true,\"cell\":{\"enabled\":false}},\"width\":175,\"template\":\"<span class=\\\"ab-no-wrap\\\" title=\\\"'#= CreatedOn #'\\\">#= moment(CreatedOn).format('M/D/YYYY [at] h:mm a') #</span>\",\"_sortOrder\":22,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"337c1a42-a0b5-4fe3-b174-a7c2181cb2bb\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"IsCompleted\",\"title\":\"Is Completed?\",\"width\":175,\"filterable\":{\"cell\":{\"showOperators\":false,\"operator\":\"eq\"}},\"template\":\"#= IsCompleted ? \\\"Yes\\\" : \\\"No\\\" #\",\"_sortOrder\":23,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"4bab2074-ba9a-4246-a2c2-9e22a44d8c28\",\"style\":\"display:none\"}},{\"encoded\":true,\"hidden\":true,\"field\":\"CompletedOn\",\"title\":\"Completed On\",\"width\":175,\"filterable\":{\"extra\":true,\"cell\":{\"enabled\":false}},\"_sortOrder\":24,\"attributes\":{\"style\":\"display:none\"},\"footerAttributes\":{\"style\":\"display:none\"},\"headerAttributes\":{\"id\":\"03246053-25f5-47b2-921f-42ca37ef8a54\",\"style\":\"display:none\"}}],\"sort\":[{\"field\":\"ProjectId\",\"dir\":\"asc\"}]}"
}