Skip to content

Add Update Case method #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lbadenhop merged 4 commits into from
Jan 26, 2026
Merged

Add Update Case method #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da80ffe
Add Update Case method
lbadenhop Jan 22, 2026
87598bb
Add review edits
lbadenhop Jan 23, 2026
a70d330
Change weith for toc order
lbadenhop Jan 23, 2026
a8c02d2
Update update_case.md
mmitev-axway Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions content/en/docs/shared_services/supportapi/formats/update_case_req.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: UpdateCaseRequest
linkTitle: UpdateCaseRequest
weight: 43
date: 2026-01-23
---

Request format for the Update Case method.

### UpdateCase

| Property Name | Data Type | Optional | Description |
| --------------|-----------|----------|-----------------------------|
| contact | string | no | The e-mail of the contact. Required for requests that use the [OAuthApplication security scheme](https://sphereapi.admin.axway.com/sphere/api/v1). |
| impact | string | yes | Impact level. Options: "1 - Critical", "2 - High", "3 - Medium", "4 - Low" |
| urgency | string | yes | Urgency level. Options: "1 - High", "2 - Medium", "3 - Low" |
| status | string | yes | Case status. Options: "In Support", "Customer Owns Next Step", "In Escalation", "Pending Closure" |
87 changes: 87 additions & 0 deletions content/en/docs/shared_services/supportapi/formats/update_case_res.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: UpdateCaseResponse
linkTitle: UpdateCaseResponse
weight: 44
date: 2026-01-23
---

Response format for the Update Case method.

### Case

| Property Name | Data Type | Optional | Description |
|---------------|-------------------------------|----------|-------------|
| caseNumber | string | no | Business identifier assigned to this case. |
| subject | string | no | Brief description of this case. |
| severity | [Severity](/docs/shared_services/supportapi/formats/severity) | no | The severity level calculated for this case. |
| status | string | no | The current status of this case. |
| createdDate | string | no | Date and time of case creation. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |
| modifiedDate | string | no | Date and time of the latest update. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |
| targetDate | string | yes | Available when the case is a business service request. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-format-for-responses). |
| contact | [Contact](#contact) | no | Current contact for this case. |
| owner | [Contact](#contact) | yes | The current owner of this case. |
| product | [Product](#product) | no | Product for which this case was created. |
| environment | [Environment](/docs/shared_services/supportapi/formats/environment) | no | Environment for which this case is created. |
| notes | [CaseNote](#casenote) (array) | yes | List of case notes automatically attached to this case on case creation. |
| impact | [Impact](/docs/shared_services/supportapi/formats/impact) | no | Impact level. |
| urgency | [Urgency](/docs/shared_services/supportapi/formats/urgency) | no | Urgency level. |
| type | [CaseType](/docs/shared_services/supportapi/formats/case_type) | no | The type of this case. |
| description | string | no | Detailed description of this case. |
| ccEmails | string (array) | yes | E-mail addresses copied in communications regarding this case. |
| attachments | [Attachment](#attachment) (array) | yes | Summary information about the files attached to this case. |
| account | [Account](#account) | no | Details of the Axway customer account that case is registered with. |
| closedDate | string | yes | Date and time of case closure. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |

### Contact

| Property Name | Data Type | Optional | Description |
|---------------|-----------|----------|-------------|
| email | string | no | The e-mail of this contact. |
| name | string | no | The name of this contact. |

### Product

| Property Name | Data Type | Optional | Description |
|---------------|-----------------------------------|----------|-------------|
| id | string | no | Identifier of this product for the purposes of Axway Support case management. |
| name | string | no | The name of the affected product. |
| os | [ProductOs](#productos) | no | Operating system on which the product is run.. |
| version | [ProductVersion](#productversion) | no | Version of the affected product. |
| patch | string | yes | Service pack or patch in effect. Free form text. |

### ProductOs

| Property Name | Data Type | Optional | Description |
|---------------|-----------|----------|-------------|
| id | string | no | Identifier of this operating system for the purposes of Axway Support case management. |
| name | string | no | Operating system name. |

### ProductVersion

| Property Name | Data Type | Optional | Description |
|---------------|-----------|----------|-------------|
| id | string | no | Identifier of this product version for the purposes of Axway Support case management. |
| name | string | no | Product version name. |

### Attachment

| Property Name | Data Type | Optional | Description |
|---------------|-----------|----------|-------------|
| id | string | no | An identifier of this attachment. Attachment download requires this ID.|
| name | string | no | The name under which this attachment was added. |
| createdDate | string | no | Date and time of attachment creation. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |

### Account

| Property Name | Data Type | Optional | Description |
|---------------|-----------|----------|-------------|
| name | string | yes | Name of the Axway customer account. |
| sac | string | no | Support access code. |

### CaseNote

| Property Name | Data Type | Optional | Description |
|---------------|-----------|----------|-------------|
| subject | string | no | Title or subject of this note. |
| description | string | no | Detailed information included in this note. |
| createdBy | string | yes | Name of the creator of this note. |
57 changes: 57 additions & 0 deletions content/en/docs/shared_services/supportapi/methods/update_case.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Update Case
linkTitle: Update Case
weight: 17
date: 2026-01-22
---

Update a support case or customer enhancement request.

## Request

**Endpoint**: `https://sphereapi.admin.axwaytest.net/sphere/api/v1/case/{caseID}`

**HTTP verb**: `PATCH`

### Update Case Sample

Send the case information directly as the HTTP entity-body.

**Consumes**: application/json

**Parameters**:

| Name | Type | Data Type | Required | Allow Multiple | Description |
|------|------|--------------------------------------------|----------|----------------|-------------|
| n/a | body | [UpdateCase](/docs/shared_services/supportapi/formats/update_case_req) | yes | no | Details of the case fields to be updated. |

**Example**:

```json
{
"contact": [
"example@axway.com"
],
"impact": "4 - Low",
"urgency": "3 - Low",
"status": "In Support",
}
```

## Response

**HTTP status code**: 200

**Content**:

| Type | Data Type | Description |
|------|--------------------------------------------|-------------|
| body | [UpdateCase](/docs/shared_services/supportapi/formats/update_case_res) | Details of the update case. |

### Unsuccessful responses

**Content**:

| Type | Data Type | Description |
|------|-----------------------------------------------|-------------|
| body | [ErrorResponse](/docs/shared_services/supportapi/formats/error_response/) | Details of the error that occurred. |
Loading