Add Additional Namespace & Catalog Request Support #284
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "githubPullRequests.ignoredPullRequestBranches": [ | ||
| "master" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Collaborator
There was a problem hiding this comment. might be good to have a way to control when checkout occurs in case folks want to add multiple (different) items before submitting order
Contributor
Author
There was a problem hiding this comment. I added the CheckoutImmediately switch parameter as well as new function 'Submit-ServiceNowCatalogOrder' to support delayed checkout. I feel that most use cases will want to use CheckoutImmediately as the default. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| <# | ||
| .SYNOPSIS | ||
| Submit a catalog request using Service Catalog API | ||
|
|
||
| .DESCRIPTION | ||
| Create a new catalog item request using Service Catalog API. Reference: https://www.servicenow.com/community/itsm-articles/submit-catalog-request-using-service-catalog-api/ta-p/2305836 | ||
|
|
||
| .PARAMETER CatalogItem | ||
| Name or ID of the catalog item that will be created | ||
|
|
||
| .PARAMETER Variables | ||
| Key/value pairs of variable names and their values | ||
|
|
||
| .PARAMETER CheckoutImmediately | ||
| If provided, a second Post for cart checkout to submit_order API Endpoint will be sent | ||
|
|
||
| .PARAMETER PassThru | ||
| If provided, the new record will be returned | ||
|
|
||
| .PARAMETER Connection | ||
| Azure Automation Connection object containing username, password, and URL for the ServiceNow instance | ||
|
|
||
| .PARAMETER ServiceNowSession | ||
| ServiceNow session created by New-ServiceNowSession. Will default to script-level variable $ServiceNowSession. | ||
|
|
||
| .EXAMPLE | ||
| New-ServiceNowCatalogItem -CatalogItem "Standard Laptop" -Variables @{'acrobat' = 'true'; 'photoshop' = 'true'; ' Additional_software_requirements' = 'Testing Service catalog API' } | ||
|
|
||
| Raise a new catalog request using Item Name | ||
|
|
||
| .EXAMPLE | ||
| New-ServiceNowCatalogItem -CatalogItem "04b7e94b4f7b42000086eeed18110c7fd" -Variables @{'acrobat' = 'true'; 'photoshop' = 'true'; ' Additional_software_requirements' = 'Testing Service catalog API' } | ||
|
|
||
| Raise a new catalog request using Item ID | ||
|
|
||
| .INPUTS | ||
| InputData | ||
|
|
||
| .OUTPUTS | ||
| PSCustomObject if PassThru provided | ||
| #> | ||
| function New-ServiceNowCatalogItem { | ||
| [CmdletBinding(SupportsShouldProcess)] | ||
| param | ||
| ( | ||
| [Parameter(Mandatory)] | ||
| [string]$CatalogItem, | ||
| [Parameter(Mandatory)] | ||
| [Alias('Variables')] | ||
| [hashtable]$InputData, | ||
| [Parameter()][Hashtable]$Connection, | ||
| [Parameter()][hashtable]$ServiceNowSession = $script:ServiceNowSession, | ||
| [Parameter()][switch]$CheckoutImmediately, | ||
| [Parameter()][switch]$PassThru | ||
| ) | ||
|
|
||
| begin { | ||
| if (-not $PSBoundParameters.ContainsKey('CheckoutImmediately')) { | ||
| $CheckoutImmediately = $false | ||
| } | ||
| if ($CatalogItem -match '^[a-zA-Z0-9]{32}$') { | ||
| #Verify the sys_id of the Catalog Item | ||
| $CatalogItemID = Get-ServiceNowRecord -Table sc_cat_item -AsValue -ID $CatalogItem -Property sys_id | ||
| if ([string]::IsNullOrEmpty($CatalogItemID)) { throw "Unable to find catalog item by ID '$($CatalogItem)'" } else { Write-Verbose "Found $($catalogitemid) via lookup from '$($CatalogItem)'" } | ||
| } else { | ||
| #Lookup the sys_id of the Catalog Item | ||
| $CatalogItemID = Get-ServiceNowRecord -Table sc_cat_item -AsValue -Filter @('name', '-eq', $CatalogItem ) -Property sys_id | ||
| if ([string]::IsNullOrEmpty($CatalogItemID)) { throw "Unable to find catalog item by name '$($CatalogItem)'" } else { Write-Verbose "Found $($catalogitemid) via lookup from '$($CatalogItem)'" } | ||
| } | ||
| } | ||
| process { | ||
|
|
||
| $AddItemToCart = @{ | ||
| Method = 'Post' | ||
| UriLeaf = "/servicecatalog/items/{0}/add_to_cart" -f $CatalogItemID | ||
| Values = @{'sysparm_quantity' = 1; 'variables' = $InputData } | ||
|
Collaborator
There was a problem hiding this comment. we should make quantity a function parameter along with the other request body parameters, sysparm_also_request_for and sysparm_requested_for. https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_ServiceCatalogAPI.html#title_servicecat-POST-items-add_to_cart. add examples for these new parameters as well. |
||
| Namespace = 'sn_sc' | ||
| Connection = $Connection | ||
| ServiceNowSession = $ServiceNowSession | ||
| } | ||
|
|
||
| if ( $PSCmdlet.ShouldProcess($CatalogItemID, 'Create new catalog item request') ) { | ||
|
|
||
| $AddItemCartResponse = Invoke-ServiceNowRestMethod @AddItemToCart | ||
|
|
||
| if ($AddItemCartResponse.cart_id -and $CheckoutImmediately) { | ||
| $SubmitOrder = @{ | ||
| Method = 'Post' | ||
| UriLeaf = "/servicecatalog/cart/submit_order" | ||
| Namespace = 'sn_sc' | ||
| Connection = $Connection | ||
| ServiceNowSession = $ServiceNowSession | ||
| } | ||
|
|
||
| $SubmitOrderResponse = Invoke-ServiceNowRestMethod @SubmitOrder | ||
|
|
||
| if ($PassThru) { | ||
| $SubmitOrderResponse | Select-Object @{'n' = 'number'; 'e' = { $_.request_number } }, request_id | ||
| } | ||
| } | ||
| } else { | ||
| $AddItemToCart | Out-String | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm thinking we're better served by changing the baseuri to end with /api and just append the namespace. this will involve changes here and invoke-service nowrestmethod.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree and I tried to add the Namespace support functionality with as limited of breaking changes as I could. However, I didn't want to modify the New-ServiceNowSession function where BaseUri is originally declared into script scope variable $ServiceNowSession the due to a lack of familiarity with version specification and GraphQL use cases.