# Arxus Care API

ITSM e-bonding API for Arxus partners and customers.

Version: v0

## Servers

Development ( Arxus internal use only )
```
https://api-dev.arxus.eu/care/v0/
```

Acceptance( Arxus internal use only )
```
https://api-acc.arxus.eu/care/v0/
```

Production
```
https://api.arxus.eu/care/v0/
```

## Security

### ArxusSSO

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Arxus Care API](https://arxus-dev.redocly.app/_bundle/apis/care/openapi.yaml)

## API Keys

### List API Keys

 - [GET /apikeys](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/apikey-list.md): Get a paginated list of API keys for the authenticated account's company.

### Create API Key

 - [POST /apikeys](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/apikey-create.md): Create a new company-scoped API key for the authenticated account.

### Get API Key

 - [GET /apikeys/{keyId}](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/apikey-get.md): Get an API key by ID.

### Update API Key

 - [PATCH /apikeys/{keyId}](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/apikey-update.md): Update an API key's label and/or expiry.

### Revoke API Key

 - [DELETE /apikeys/{keyId}](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/apikey-revoke.md): Revoke an API key (soft-delete by setting revoked timestamp).

### Sandbox - List API Keys

 - [GET /sandbox/apikeys](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/sandbox-apikey-list.md): Get a paginated list of API keys for the authenticated account's company.

### Sandbox - Create API Key

 - [POST /sandbox/apikeys](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/sandbox-apikey-create.md): Create a new company-scoped API key for the authenticated account.

### Sandbox - Get API Key

 - [GET /sandbox/apikeys/{keyId}](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/sandbox-apikey-get.md): Get an API key by ID.

### Sandbox - Update API Key

 - [PATCH /sandbox/apikeys/{keyId}](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/sandbox-apikey-update.md): Update an API key's label and/or expiry.

### Sandbox - Revoke API Key

 - [DELETE /sandbox/apikeys/{keyId}](https://arxus-dev.redocly.app/apis/care/openapi/api-keys/sandbox-apikey-revoke.md): Revoke an API key (soft-delete by setting revoked timestamp).

## Case Attachments

### List Case Attachments

 - [GET /cases/{caseId}/attachments](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/case-attachment-list.md): Get a list of case attachments.

### Upload Case Attachment

 - [POST /cases/{caseId}/attachments](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/case-attachment-upload.md): Upload a new attachment to a case.

### Get Case Attachment

 - [GET /cases/{caseId}/attachments/{attachmentId}](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/case-attachment-get.md): Get a case attachment by ID.

### Download Case Attachment

 - [GET /cases/{caseId}/attachments/{attachmentId}/download](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/case-attachment-download.md): Download an attachment by ID.

### Sandbox - List Case Attachments

 - [GET /sandbox/cases/{caseId}/attachments](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/sandbox-case-attachment-list.md): Get a list of case attachments.

### Sandbox - Upload Case Attachment

 - [POST /sandbox/cases/{caseId}/attachments](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/sandbox-case-attachment-upload.md): Upload a new attachment to a case.

### Sandbox - Get Case Attachment

 - [GET /sandbox/cases/{caseId}/attachments/{attachmentId}](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/sandbox-case-attachment-get.md): Get a case attachment by ID.

### Sandbox - Download Case Attachment

 - [GET /sandbox/cases/{caseId}/attachments/{attachmentId}/download](https://arxus-dev.redocly.app/apis/care/openapi/case-attachments/sandbox-case-attachment-download.md): Download an attachment by ID.

## Case Comments

### List Case Comments

 - [GET /cases/{caseId}/comments](https://arxus-dev.redocly.app/apis/care/openapi/case-comments/case-comment-list.md): Get a list of case comments.

### Create Case Comment

 - [POST /cases/{caseId}/comments](https://arxus-dev.redocly.app/apis/care/openapi/case-comments/case-comment-create.md): Create a new case comment.

### Get Case Comment

 - [GET /cases/{caseId}/comments/{commentId}](https://arxus-dev.redocly.app/apis/care/openapi/case-comments/case-comment-get.md): Get a case comment by ID.

### Sandbox - List Case Comments

 - [GET /sandbox/cases/{caseId}/comments](https://arxus-dev.redocly.app/apis/care/openapi/case-comments/sandbox-case-comment-list.md): Get a list of case comments.

### Sandbox - Create Case Comment

 - [POST /sandbox/cases/{caseId}/comments](https://arxus-dev.redocly.app/apis/care/openapi/case-comments/sandbox-case-comment-create.md): Create a new case comment.

### Sandbox - Get Case Comment

 - [GET /sandbox/cases/{caseId}/comments/{commentId}](https://arxus-dev.redocly.app/apis/care/openapi/case-comments/sandbox-case-comment-get.md): Get a case comment by ID.

## Cases

### List Cases

 - [GET /cases](https://arxus-dev.redocly.app/apis/care/openapi/cases/case-list.md): Get a list of cases.

### Create Case

 - [POST /cases](https://arxus-dev.redocly.app/apis/care/openapi/cases/case-create.md): Create a new case.

### Get Case

 - [GET /cases/{caseId}](https://arxus-dev.redocly.app/apis/care/openapi/cases/case-get.md): Get a case by ID.

### Update Case

 - [PATCH /cases/{caseId}](https://arxus-dev.redocly.app/apis/care/openapi/cases/case-update.md): Update a case by ID.

### Sandbox - List Cases

 - [GET /sandbox/cases](https://arxus-dev.redocly.app/apis/care/openapi/cases/sandbox-case-list.md): Get a list of cases.

### Sandbox - Create Case

 - [POST /sandbox/cases](https://arxus-dev.redocly.app/apis/care/openapi/cases/sandbox-case-create.md): Create a new case.

### Sandbox - Get Case

 - [GET /sandbox/cases/{caseId}](https://arxus-dev.redocly.app/apis/care/openapi/cases/sandbox-case-get.md): Get a case by ID.

### Sandbox - Update Case

 - [PATCH /sandbox/cases/{caseId}](https://arxus-dev.redocly.app/apis/care/openapi/cases/sandbox-case-update.md): Update a case by ID.

## Contracts

### List Contracts

 - [GET /contracts](https://arxus-dev.redocly.app/apis/care/openapi/contracts/contract-list.md): Get a list of contracts.

### Get Contract

 - [GET /contracts/{contractId}](https://arxus-dev.redocly.app/apis/care/openapi/contracts/contract-get.md): Get a contract by ID.

### Update Contract

 - [PATCH /contracts/{contractId}](https://arxus-dev.redocly.app/apis/care/openapi/contracts/contract-update.md): Update a contract by ID.

### Sandbox - List Contracts

 - [GET /sandbox/contracts](https://arxus-dev.redocly.app/apis/care/openapi/contracts/sandbox-contract-list.md): Get a list of contracts.

### Sandbox - Get Contract

 - [GET /sandbox/contracts/{contractId}](https://arxus-dev.redocly.app/apis/care/openapi/contracts/sandbox-contract-get.md): Get a contract by ID.

### Sandbox - Update Contract

 - [PATCH /sandbox/contracts/{contractId}](https://arxus-dev.redocly.app/apis/care/openapi/contracts/sandbox-contract-update.md): Update a contract by ID.

## Event Logs

### List Events

 - [GET /events](https://arxus-dev.redocly.app/apis/care/openapi/event-logs/event-list.md): Get a paginated list of event log entries.

### Get Event

 - [GET /events/{eventId}](https://arxus-dev.redocly.app/apis/care/openapi/event-logs/event-get.md): Get an event log entry by ID.

### Sandbox - List Events

 - [GET /sandbox/events](https://arxus-dev.redocly.app/apis/care/openapi/event-logs/sandbox-event-list.md): Get a paginated list of event log entries.

### Sandbox - Get Event

 - [GET /sandbox/events/{eventId}](https://arxus-dev.redocly.app/apis/care/openapi/event-logs/sandbox-event-get.md): Get an event log entry by ID.

## Webhooks

### List Webhooks

 - [GET /webhooks](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/webhook-list.md): Get a paginated list of webhook subscriptions.

### Create Webhook

 - [POST /webhooks](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/webhook-create.md): Create a new webhook subscription.

### Get Webhook

 - [GET /webhooks/{webhookId}](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/webhook-get.md): Get a webhook subscription by ID.

### Update Webhook

 - [PATCH /webhooks/{webhookId}](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/webhook-update.md): Update an existing webhook subscription.

### Delete Webhook

 - [DELETE /webhooks/{webhookId}](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/webhook-delete.md): Delete a webhook subscription by ID.

### Sandbox - List Webhooks

 - [GET /sandbox/webhooks](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/sandbox-webhook-list.md): Get a paginated list of webhook subscriptions.

### Sandbox - Create Webhook

 - [POST /sandbox/webhooks](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/sandbox-webhook-create.md): Create a new webhook subscription.

### Sandbox - Get Webhook

 - [GET /sandbox/webhooks/{webhookId}](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/sandbox-webhook-get.md): Get a webhook subscription by ID.

### Sandbox - Update Webhook

 - [PATCH /sandbox/webhooks/{webhookId}](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/sandbox-webhook-update.md): Update an existing webhook subscription.

### Sandbox - Delete Webhook

 - [DELETE /sandbox/webhooks/{webhookId}](https://arxus-dev.redocly.app/apis/care/openapi/webhooks/sandbox-webhook-delete.md): Delete a webhook subscription by ID.

## Event Triggers

### Sandbox - Trigger case.contract.assigned

 - [POST /sandbox/events/case.contract.assigned](https://arxus-dev.redocly.app/apis/care/openapi/event-triggers/sandbox-event-trigger-case-contract-assigned.md): Trigger a case.contract.assigned event for testing purposes.

### Sandbox - Trigger case.contract.unassigned

 - [POST /sandbox/events/case.contract.unassigned](https://arxus-dev.redocly.app/apis/care/openapi/event-triggers/sandbox-event-trigger-case-contract-unassigned.md): Trigger a case.contract.unassigned event for testing purposes.

### Sandbox - Trigger case.updated

 - [POST /sandbox/events/case.updated](https://arxus-dev.redocly.app/apis/care/openapi/event-triggers/sandbox-event-trigger-case-updated.md): Trigger a case.updated event for testing purposes.

### Sandbox - Trigger case.attachment.created

 - [POST /sandbox/events/case.attachment.created](https://arxus-dev.redocly.app/apis/care/openapi/event-triggers/sandbox-event-trigger-case-attachment-created.md): Trigger a case.attachment.created event for testing purposes.

### Sandbox - Trigger case.comment.created

 - [POST /sandbox/events/case.comment.created](https://arxus-dev.redocly.app/apis/care/openapi/event-triggers/sandbox-event-trigger-case-comment-created.md): Trigger a case.comment.created event for testing purposes.