Skip to content

Commit 57cbfa7

Browse files
lbadenhopmmitev-axway
lbadenhop
and
mmitev-axway
authored
Add Update Case method (#53)
* Add Update Case method * Add review edits * Change weith for toc order * Update update_case.md Changed the text from "Create Case Sample" to "Update Case Sample" --------- Co-authored-by: mmitev-axway <mmitev@74software.com>
1 parent c5bf98c commit 57cbfa7

4 files changed

Lines changed: 1155 additions & 375 deletions

File tree

‎content/en/docs/shared_services/supportapi/formats/update_case_req.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: UpdateCaseRequest
3+
linkTitle: UpdateCaseRequest
4+
weight: 43
5+
date: 2026-01-23
6+
---
7+
8+
Request format for the Update Case method.
9+
10+
### UpdateCase
11+
12+
| Property Name | Data Type | Optional | Description |
13+
| --------------|-----------|----------|-----------------------------|
14+
| 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). |
15+
| impact | string | yes | Impact level. Options: "1 - Critical", "2 - High", "3 - Medium", "4 - Low" |
16+
| urgency | string | yes | Urgency level. Options: "1 - High", "2 - Medium", "3 - Low" |
17+
| status | string | yes | Case status. Options: "In Support", "Customer Owns Next Step", "In Escalation", "Pending Closure" |

‎content/en/docs/shared_services/supportapi/formats/update_case_res.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: UpdateCaseResponse
3+
linkTitle: UpdateCaseResponse
4+
weight: 44
5+
date: 2026-01-23
6+
---
7+
8+
Response format for the Update Case method.
9+
10+
### Case
11+
12+
| Property Name | Data Type | Optional | Description |
13+
|---------------|-------------------------------|----------|-------------|
14+
| caseNumber | string | no | Business identifier assigned to this case. |
15+
| subject | string | no | Brief description of this case. |
16+
| severity | [Severity](/docs/shared_services/supportapi/formats/severity) | no | The severity level calculated for this case. |
17+
| status | string | no | The current status of this case. |
18+
| createdDate | string | no | Date and time of case creation. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |
19+
| modifiedDate | string | no | Date and time of the latest update. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |
20+
| targetDate | string | yes | Available when the case is a business service request. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-format-for-responses). |
21+
| contact | [Contact](#contact) | no | Current contact for this case. |
22+
| owner | [Contact](#contact) | yes | The current owner of this case. |
23+
| product | [Product](#product) | no | Product for which this case was created. |
24+
| environment | [Environment](/docs/shared_services/supportapi/formats/environment) | no | Environment for which this case is created. |
25+
| notes | [CaseNote](#casenote) (array) | yes | List of case notes automatically attached to this case on case creation. |
26+
| impact | [Impact](/docs/shared_services/supportapi/formats/impact) | no | Impact level. |
27+
| urgency | [Urgency](/docs/shared_services/supportapi/formats/urgency) | no | Urgency level. |
28+
| type | [CaseType](/docs/shared_services/supportapi/formats/case_type) | no | The type of this case. |
29+
| description | string | no | Detailed description of this case. |
30+
| ccEmails | string (array) | yes | E-mail addresses copied in communications regarding this case. |
31+
| attachments | [Attachment](#attachment) (array) | yes | Summary information about the files attached to this case. |
32+
| account | [Account](#account) | no | Details of the Axway customer account that case is registered with. |
33+
| closedDate | string | yes | Date and time of case closure. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |
34+
35+
### Contact
36+
37+
| Property Name | Data Type | Optional | Description |
38+
|---------------|-----------|----------|-------------|
39+
| email | string | no | The e-mail of this contact. |
40+
| name | string | no | The name of this contact. |
41+
42+
### Product
43+
44+
| Property Name | Data Type | Optional | Description |
45+
|---------------|-----------------------------------|----------|-------------|
46+
| id | string | no | Identifier of this product for the purposes of Axway Support case management. |
47+
| name | string | no | The name of the affected product. |
48+
| os | [ProductOs](#productos) | no | Operating system on which the product is run.. |
49+
| version | [ProductVersion](#productversion) | no | Version of the affected product. |
50+
| patch | string | yes | Service pack or patch in effect. Free form text. |
51+
52+
### ProductOs
53+
54+
| Property Name | Data Type | Optional | Description |
55+
|---------------|-----------|----------|-------------|
56+
| id | string | no | Identifier of this operating system for the purposes of Axway Support case management. |
57+
| name | string | no | Operating system name. |
58+
59+
### ProductVersion
60+
61+
| Property Name | Data Type | Optional | Description |
62+
|---------------|-----------|----------|-------------|
63+
| id | string | no | Identifier of this product version for the purposes of Axway Support case management. |
64+
| name | string | no | Product version name. |
65+
66+
### Attachment
67+
68+
| Property Name | Data Type | Optional | Description |
69+
|---------------|-----------|----------|-------------|
70+
| id | string | no | An identifier of this attachment. Attachment download requires this ID.|
71+
| name | string | no | The name under which this attachment was added. |
72+
| createdDate | string | no | Date and time of attachment creation. [Format](/docs/shared_services/supportapi/formats/miscellaneous/#common-date-and-time-format-for-responses). |
73+
74+
### Account
75+
76+
| Property Name | Data Type | Optional | Description |
77+
|---------------|-----------|----------|-------------|
78+
| name | string | yes | Name of the Axway customer account. |
79+
| sac | string | no | Support access code. |
80+
81+
### CaseNote
82+
83+
| Property Name | Data Type | Optional | Description |
84+
|---------------|-----------|----------|-------------|
85+
| subject | string | no | Title or subject of this note. |
86+
| description | string | no | Detailed information included in this note. |
87+
| createdBy | string | yes | Name of the creator of this note. |

‎content/en/docs/shared_services/supportapi/methods/update_case.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Update Case
3+
linkTitle: Update Case
4+
weight: 17
5+
date: 2026-01-22
6+
---
7+
8+
Update a support case or customer enhancement request.
9+
10+
## Request
11+
12+
**Endpoint**: `https://sphereapi.admin.axwaytest.net/sphere/api/v1/case/{caseID}`
13+
14+
**HTTP verb**: `PATCH`
15+
16+
### Update Case Sample
17+
18+
Send the case information directly as the HTTP entity-body.
19+
20+
**Consumes**: application/json
21+
22+
**Parameters**:
23+
24+
| Name | Type | Data Type | Required | Allow Multiple | Description |
25+
|------|------|--------------------------------------------|----------|----------------|-------------|
26+
| n/a | body | [UpdateCase](/docs/shared_services/supportapi/formats/update_case_req) | yes | no | Details of the case fields to be updated. |
27+
28+
**Example**:
29+
30+
```json
31+
{
32+
"contact": [
33+
"example@axway.com"
34+
],
35+
"impact": "4 - Low",
36+
"urgency": "3 - Low",
37+
"status": "In Support",
38+
}
39+
```
40+
41+
## Response
42+
43+
**HTTP status code**: 200
44+
45+
**Content**:
46+
47+
| Type | Data Type | Description |
48+
|------|--------------------------------------------|-------------|
49+
| body | [UpdateCase](/docs/shared_services/supportapi/formats/update_case_res) | Details of the update case. |
50+
51+
### Unsuccessful responses
52+
53+
**Content**:
54+
55+
| Type | Data Type | Description |
56+
|------|-----------------------------------------------|-------------|
57+
| body | [ErrorResponse](/docs/shared_services/supportapi/formats/error_response/) | Details of the error that occurred. |

0 commit comments

Comments
 (0)