{"id":20680287,"url":"https://github.com/markwragg/powershell-remedy","last_synced_at":"2025-04-19T23:54:36.159Z","repository":{"id":61704733,"uuid":"92411971","full_name":"markwragg/Powershell-Remedy","owner":"markwragg","description":"PowerShell module for interacting with the BMC Remedy ARS Rest API.","archived":false,"fork":false,"pushed_at":"2023-03-10T11:01:52.000Z","size":130,"stargazers_count":22,"open_issues_count":0,"forks_count":12,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-19T23:54:30.830Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markwragg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-25T14:32:45.000Z","updated_at":"2025-01-24T20:04:13.000Z","dependencies_parsed_at":"2022-10-20T14:00:49.414Z","dependency_job_id":null,"html_url":"https://github.com/markwragg/Powershell-Remedy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markwragg%2FPowershell-Remedy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markwragg%2FPowershell-Remedy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markwragg%2FPowershell-Remedy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markwragg%2FPowershell-Remedy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markwragg","download_url":"https://codeload.github.com/markwragg/Powershell-Remedy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249830852,"owners_count":21331357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T21:30:47.380Z","updated_at":"2025-04-19T23:54:36.143Z","avatar_url":"https://github.com/markwragg.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Powershell-Remedy\n\n[![Build Status](https://dev.azure.com/markwragg/GitHub/_apis/build/status/markwragg.Powershell-Remedy?branchName=master)](https://dev.azure.com/markwragg/GitHub/_build/latest?definitionId=6\u0026branchName=master) ![Test Coverage](https://img.shields.io/badge/coverage-82%25-yellow.svg?maxAge=60)\n\nThis project is a PowerShell module for interacting with the BMC Remedy ARS Rest API. It has been tested against a system that is running Remedy v9. Results with other versions/implementations of Remedy may vary.\n\n## Getting Started\n\nAfter installation, you will need to set your Remedy API URL and credentials. You do this by running:\n\n    Set-RemedyAPIConfig -APIURL https://yourremedy.url.whatever/arapi/yourmidtearserver -IncidentURL https://yourremedy.url.whatever/arsys/forms/cmdbapppd/HPD:Help%20Desk\n    \nWhich will then prompt you to enter credentials. These are saved as an encrypted string to your userprofile directory by default (you can redirect this by using `-File`).\n\n## Examples\n\n### Get-RemedyTicket\n\nYou can get a specific (incident) ticket by partial or full Incident Number as follows:\n\n    Get-RemedyTicket -ID 12345\n\nThis will return a small object with a default set of frequently needed properties available. To return an object with all of the properties available via the API add the `-Full` switch:\n\n    Get-RemedyTicket -ID 12345 -Full\n\nThere are many other parameters for filtering/retrieving resuts in other ways e.g by `-Team`, `-Submitter`, `-Customer` etc. Enter `Help Get-RemedyTicket -Full` for full details.\n\n### Get-RemedyChange\n\nYou can get a specific Remedy Change by full or partial Change ID Number as follows:\n\n    Get-RemedyChange -ID 12345\n    \nThis will return a small object with a default set of frequently needed properties available. To return an object with all of the properties available via the API, add the `-Full` siwtch:\n\n    Get-RemedyChange -ID 12345 -Full\n    \nThere are many other parameters for filtering/retrieving resuts in other ways e.g by `-Team`, `-Submitter`, `-Customer` etc. Enter `Help Get-RemedyChange -Full` for full details.\n\n### Get-RemedyProblem\n\nYou can get a specific Remedy Problem record by full or partial Problem ID Number as follows:\n\n    Get-RemedyProblem -ID 12345\n    \nThis will return a small object with a default set of frequently needed properties available. To return an object with all of the properties available via the API, add the `-Full` siwtch:\n\n    Get-RemedyProblem -ID 12345 -Full\n    \nThere are many other parameters for filtering/retrieving resuts in other ways e.g by `-Team`, `-Submitter`, `-Customer` etc. Enter `Help Get-RemedyProblem -Full` for full details.\n\n### Get-RemedySolution\n\nYou can get a specific Remedy Solution record by full or partial Solution ID Number as follows:\n\n    Get-RemedySolution -ID 12345\n    \nThis will return a small object with a default set of frequently needed properties available. To return an object with all of the properties available via the API, add the `-Full` siwtch:\n\n    Get-RemedySolution -ID 12345 -Full\n    \nThere are many other parameters for filtering/retrieving resuts in other ways e.g by `-Team`, `-Submitter`, `-Customer` etc. Enter `Help Get-RemedySolution -Full` for full details.\n\n### Get-RemedyKnownError\n\nYou can get a specific Remedy Known Error record by full or partial Known Error ID Number as follows:\n\n    Get-RemedyKnownError -ID 12345\n    \nThis will return a small object with a default set of frequently needed properties available. To return an object with all of the properties available via the API, add the `-Full` siwtch:\n\n    Get-RemedyKnownError -ID 12345 -Full\n    \nThere are many other parameters for filtering/retrieving resuts in other ways e.g by `-Team`, `-Submitter`, `-Customer` etc. Enter `Help Get-RemedyKnownError -Full` for full details.\n\n### Get-RemedyWorkLog\n\nYou can get the worklog entries associated with a ticket (Incident/Request) by doing the following:\n\n    Get-RemedyTicket -ID 12345 | Get-RemedyWorkLog\n\nYou can get the worklog entries associated with a Change by doing one of the following:\n\n    Get-RemedyChange -ID 12345 | Get-RemedyWorkLog\n    Get-RemedyWorkLog -ID 12345 -Type Change\n    \nYou can get the worklog entries associated with a Problem by doing one of the following:\n\n    Get-RemedyProblem -ID 12345 | Get-RemedyWorkLog\n    Get-RemedyWorkLog -ID 12345 -Type Problem\n\nYou can get the worklog entries associated with a Solution by doing one of the following:\n\n    Get-RemedySolution -ID 12345 | Get-RemedyWorkLog\n    Get-RemedyWorkLog -ID 12345 -Type Solution\n\nYou can get the worklog entries associated with a Known Error by doing one of the following:\n\n    Get-RemedyKnownError -ID 12345 | Get-RemedyWorkLog\n    Get-RemedyWorkLog -ID 12345 -Type KnownError\n    \nYou can filter for a specific type of worklog by specifying `-WorkLogType`. E.g:\n\n    Get-RemedyChange -ID 12345 | Get-RemedyWorkLog -WorkLogType 'Resolution'\n    \nThere are many other parameters for filtering the results of `Get-RemedyWorkLog`. Enter `Help Get-RemedyWorkLog -Full` to learn more.\n    \n### Get-RemedyTeam\n\nYou can get the members of a specified Remedy Support Team with this command.\n\n    Get-RemedyTeam -Name Windows\n    \nThis actually makes two calls to the API, it queries the `CTM:Support Group` schema to get the ID of the Support Group, then uses this to query the `CTM:Support Group Association` schema to get it's associated members.\n\n### Get-RemedyPerson\n\nThis returns the details of a person from Remedy. This can be a customer or a member of staff:\n\n    Get-RemedyPerson -Name 'Joe Bloggs'\n    \nThe cmdlet searches the 'Full Name' field and partial strings are accepted:\n\n    Get-RemedyPerson -Name 'John Sm'\n\nIf you wish to only return Staff members you can use the `-Staff` switch to filter the result to just these:\n\n    Get-RemedyPerson -Name 'Tony Stark' -Staff\n\n### Get-RemedyInterface\n\nYou can see a list of available Remedy interfaces/forms by running:\n\n    Get-RemedyInterfaces\n    \nThis command is just helpful if you want to explore the API, understand the schema/fields and potentially extend this module.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkwragg%2Fpowershell-remedy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkwragg%2Fpowershell-remedy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkwragg%2Fpowershell-remedy/lists"}