Api/MetadataAdminApi.ps1
|
# # Cloud Governance Api # No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # Version: 1.0 # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Create metadata .DESCRIPTION No description available. .PARAMETER CustomMetadata No description available. .OUTPUTS UUID #> function Invoke-CreateMetadata { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${CustomMetadata} ) Process { 'Calling method: Invoke-CreateMetadata' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json-patch+json', 'application/json', 'text/json', 'application/*+json') $LocalVarUri = '/admin/metadata' $LocalVarBodyParameter = $CustomMetadata | ConvertTo-Json if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientId"]) { $LocalVarHeaderParameters['ClientId'] = $Configuration["ApiKey"]["ClientId"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientSecret"]) { $LocalVarHeaderParameters['ClientSecret'] = $Configuration["ApiKey"]["ClientSecret"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["UserPrincipalName"]) { $LocalVarHeaderParameters['UserPrincipalName'] = $Configuration["ApiKey"]["UserPrincipalName"] } $LocalVarResult = Invoke-ApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "UUID" return $LocalVarResult["Response"] } } <# .SYNOPSIS delete metadata .DESCRIPTION No description available. .PARAMETER Id No description available. .OUTPUTS None #> function Invoke-DeleteMetadata { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${Id} ) Process { 'Calling method: Invoke-DeleteMetadata' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter $Configuration = Get-Configuration $LocalVarUri = '/admin/metadata/{id}' if (!$Id) { throw "Error! The required parameter `Id` missing when calling deleteMetadata." } $LocalVarUri = $LocalVarUri.replace('{id}', $Id) if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientId"]) { $LocalVarHeaderParameters['ClientId'] = $Configuration["ApiKey"]["ClientId"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientSecret"]) { $LocalVarHeaderParameters['ClientSecret'] = $Configuration["ApiKey"]["ClientSecret"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["UserPrincipalName"]) { $LocalVarHeaderParameters['UserPrincipalName'] = $Configuration["ApiKey"]["UserPrincipalName"] } $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" return $LocalVarResult["Response"] } } <# .SYNOPSIS get all metadata .DESCRIPTION No description available. .PARAMETER Filter Use **eq**(equal) or **ne**(not equal) to filter the results (e.g. field1 eq 'value1' and field2 ne 'value2'), supported fields :<br/> createdBy, createdByDisplayName, id, name, description, fieldType, metadataValue, showInReportType, lastModifiedTime .PARAMETER Orderby Order by one field, supported fields:<br/> createdBy, createdByDisplayName, id, name, description, fieldType, metadataValue, showInReportType, lastModifiedTime .PARAMETER Search Search for name .PARAMETER Top Define the number of records you want to return, max value is 200, default value is 200 .PARAMETER Skip Define the number of records you want to skip, default value is 0 .PARAMETER Nexttoken Use the next token to get the next paging result .OUTPUTS MetadataListPageResult #> function Get-AllMetadata { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Filter}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Orderby}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Search}, [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Top}, [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Skip}, [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Nexttoken} ) Process { 'Calling method: Get-AllMetadata' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json') $LocalVarUri = '/admin/metadata' $LocalVarQueryParameters['filter'] = $Filter $LocalVarQueryParameters['orderby'] = $Orderby $LocalVarQueryParameters['search'] = $Search $LocalVarQueryParameters['top'] = $Top $LocalVarQueryParameters['skip'] = $Skip $LocalVarQueryParameters['nexttoken'] = $Nexttoken if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientId"]) { $LocalVarHeaderParameters['ClientId'] = $Configuration["ApiKey"]["ClientId"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientSecret"]) { $LocalVarHeaderParameters['ClientSecret'] = $Configuration["ApiKey"]["ClientSecret"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["UserPrincipalName"]) { $LocalVarHeaderParameters['UserPrincipalName'] = $Configuration["ApiKey"]["UserPrincipalName"] } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "MetadataListPageResult" return $LocalVarResult["Response"] } } <# .SYNOPSIS get metadata filters .DESCRIPTION No description available. .PARAMETER Filter Use **eq**(equal) or **ne**(not equal) to filter the results (e.g. field1 eq 'value1' and field2 ne 'value2'), supported fields :<br/> createdBy, createdByDisplayName, id, name, description, fieldType, metadataValue, showInReportType, lastModifiedTime .PARAMETER Distinct Get the unique values for one field, supported fields:<br/> createdBy, createdByDisplayName, id, name, description, fieldType, metadataValue, showInReportType, lastModifiedTime .PARAMETER Top Define the number of records you want to return, max value is 200, default value is 200 .PARAMETER Skip Define the number of records you want to skip, default value is 0 .PARAMETER Nexttoken Use the next token to get the next paging result .OUTPUTS DistinctPageResult #> function Get-MetadataFilters { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Filter}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Distinct}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Top}, [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Skip}, [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Nexttoken} ) Process { 'Calling method: Get-MetadataFilters' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json') $LocalVarUri = '/admin/metadata/filters' $LocalVarQueryParameters['filter'] = $Filter $LocalVarQueryParameters['distinct'] = $Distinct $LocalVarQueryParameters['top'] = $Top $LocalVarQueryParameters['skip'] = $Skip $LocalVarQueryParameters['nexttoken'] = $Nexttoken if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientId"]) { $LocalVarHeaderParameters['ClientId'] = $Configuration["ApiKey"]["ClientId"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientSecret"]) { $LocalVarHeaderParameters['ClientSecret'] = $Configuration["ApiKey"]["ClientSecret"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["UserPrincipalName"]) { $LocalVarHeaderParameters['UserPrincipalName'] = $Configuration["ApiKey"]["UserPrincipalName"] } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "DistinctPageResult" return $LocalVarResult["Response"] } } <# .SYNOPSIS Get metadata by id .DESCRIPTION No description available. .PARAMETER Id No description available. .OUTPUTS CustomMetadata #> function Get-SingleMetadataById { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${Id} ) Process { 'Calling method: Get-SingleMetadataById' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter $Configuration = Get-Configuration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json') $LocalVarUri = '/admin/metadata/{id}' if (!$Id) { throw "Error! The required parameter `Id` missing when calling getSingleMetadataById." } $LocalVarUri = $LocalVarUri.replace('{id}', $Id) if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientId"]) { $LocalVarHeaderParameters['ClientId'] = $Configuration["ApiKey"]["ClientId"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientSecret"]) { $LocalVarHeaderParameters['ClientSecret'] = $Configuration["ApiKey"]["ClientSecret"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["UserPrincipalName"]) { $LocalVarHeaderParameters['UserPrincipalName'] = $Configuration["ApiKey"]["UserPrincipalName"] } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "CustomMetadata" return $LocalVarResult["Response"] } } <# .SYNOPSIS Update metadata .DESCRIPTION No description available. .PARAMETER CustomMetadata No description available. .OUTPUTS None #> function Update-Metadata { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${CustomMetadata} ) Process { 'Calling method: Update-Metadata' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter $Configuration = Get-Configuration # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json-patch+json', 'application/json', 'text/json', 'application/*+json') $LocalVarUri = '/admin/metadata' $LocalVarBodyParameter = $CustomMetadata | ConvertTo-Json if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientId"]) { $LocalVarHeaderParameters['ClientId'] = $Configuration["ApiKey"]["ClientId"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["ClientSecret"]) { $LocalVarHeaderParameters['ClientSecret'] = $Configuration["ApiKey"]["ClientSecret"] } if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["UserPrincipalName"]) { $LocalVarHeaderParameters['UserPrincipalName'] = $Configuration["ApiKey"]["UserPrincipalName"] } $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" return $LocalVarResult["Response"] } } |