https://github.com/panoramicdata/cherwell.api

https://github.com/panoramicdata/cherwell.api

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/panoramicdata/cherwell.api
• Owner: panoramicdata
• License: mit
• Created: 2022-06-21T07:48:39.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T17:32:32.000Z (about 2 years ago)
• Last Synced: 2024-04-30T17:55:25.004Z (about 2 years ago)
• Language: C#
• Size: 1.99 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Cherwell.Api

[![Nuget](https://img.shields.io/nuget/v/Cherwell.Api)](https://www.nuget.org/packages/Cherwell.Api/)

[![Nuget](https://img.shields.io/nuget/dt/Cherwell.Api)](https://www.nuget.org/packages/Cherwell.Api/)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f9e0cac6cd5d4b988e077b0394358882)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=panoramicdata/Cherwell.Api&utm_campaign=Badge_Grade)

This project implements access to the v1 Cherwell API

See the [contribution guide](CONTRIBUTING.md) for more information regarding contributing to this project

To use the Cherwell API nuget package:

## Visual Studio

  1. Open your project in Visual Studio

  2. Right-click on the project and click "Manage Nuget packages"

  3. Find the package "Cherwell.Api" - install the latest version

## Example code (C# 10.0):

``` C#

using Cherwell.Api;

using System;

using System.Threading.Tasks;

namespace My.Project

{

	public static class Program

	{

		public static async Task Main()

		{

			using var cherwellClient = new CherwellClient(new CherwellClientOptions

			{

				BaseAddress = "xxxxxxx",

				Username = "0123456789abcdef0123456789abcdef01234567",

				Password = "0123456789abcdef0123456789abcdef01234567",

				ClientId = "0123456789abcdef0123456789abcdef01234567"

			});

			var views = await cherwellClient

				.Core

				.GetViewsAsync()

				;

		}

	}

}

````

## API Documentation

The Cherwell API documentation can be found here:

  - [Cherwell API Documentation v1](https://help.cherwell.com/bundle/cherwell_rest_api_10_help_only/page/content/system_administration/rest_api/csm_rest_api_landing_page.html)