Help Center/ Customer Engagement Center/ API Reference/ Case2.0 Interface Reference/ Interface of a Single UPS/ Modifying a Case
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Modifying a Case

Description

This interface is invoked to modify a case.

Method

POST

URI

https://Domain name/service/AICC__Case/1.0.0/openapi/case/modify (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Content-Type

String

Yes

Request body type, which is JSON

2

access-token

String

Yes

Token for a user to access a tenant space. For details, see 2.
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

caseInfo

Object

Yes

Case information. For details, see Table 3.
Table 3 caseInfo parameters

No.

Parameter

Type

Length (Bytes)

Mandatory or Not

Description

1

id

String

20

Yes

Case ID, which cannot be modified

2

title

String

128

Yes

Case title

3

description

String

20,000

Yes

Case description

4

ownerId

String

-

No

Case owner ID

5

priority

String

-

No

Priority, which can be Low, Medium, High, or Critical

6

dueDate

Datetime

-

No

Deadline, in YYYY-MM-DD HH:mm:ss format

7

contactId

String

20

No

Case contact

8

creatorId

String

20

True

Creator ID

9

contactPhone

String

20

No

Contact phone number

11

attachment

String

-

No

Case attachment

If the case type involved in the case modification is associated with a customized case template, extended fields in the case template can be added to the request body.

Response Description

  • Status code: 200

    None

Example

Scenario: Modify a case.

URL: https://Domain name/service/AICC__Case/1.0.0/openapi/case/modify

  • Request header
{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • Request body 
    {
    "caseInfo":{
        "id":"c6m800000142mS63Voa8",
        "title":"testOpenApi11",
        "description":"test111",
        "dueDate":"2023-06-20 00:00:00",
        "ownerId":"10gg0000012IpiXMqxzk",
        "contactId":"ciIy0000013w9aru7cDQ",
        "creatorId": "10gg0000013wljxK5XX6",
        "contactPhone": "15151515152"
    }
}
  • Response header
{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • Response parameters
{
"resCode": "0","resMsg": "Success"
}