콘텐츠로 이동

수정


POST /api/v1/issue/{issue_uuid}/modify

개요

라우팅 파라미터

파라미터명 유형 필수 설명
issue_uuid string Y issueUUID

Body 요청 파라미터

파라미터명 유형 필수 설명
name string 제목
예시: name
빈 값 허용: False
$maxCustomLength: 256
level string 등급, 해당 등급 구성 uuid
예시: level
빈 값 허용: False
빈 문자열 허용: True
description string 설명
예시: description
빈 값 허용: False
statusType integer 인시던트 상태
예시: statusType
빈 값 허용: False
선택 가능 값: [10, 15, 20, 25, 30]
extend json Y 추가 확장 정보, 내용이 없으면 기본값 {}
예시: {}
빈 값 허용: True
attachmentUuids array 첨부 파일 업로드 목록 uuid
예시: []
빈 값 허용: True

파라미터 추가 설명

기본 파라미터 설명

파라미터명 파라미터 유형 필수 여부 파라미터 설명
name string N 인시던트 제목
level string N 인시던트 등급, 해당 구성 등급 uuid
statusType integer N 인시던트 상태, 10: Open, 15: Working, 20: Resolved, 25: Closed, 30: Pending
decription string N 인시던트 설명
attachmentUuids array N 첨부 파일 업로드 목록 uuid, 먼저 /api/v1/attachment/upload API를 통해 업로드 필요
extend json N 확장 필드, 기본값 {}

level 등급 필드 설명 level은 시스템 등급/사용자 정의 등급으로 구분됩니다(구성 관리에서 설정 가능)

level value 파라미터 설명
P0 system_level_0 level 파라미터: system_level_0, 시스템 등급 P0을 의미
P1 system_level_1 level 파라미터: system_level_1, 시스템 등급 P1을 의미
P2 system_level_2 level 파라미터: system_level_2, 시스템 등급 P2을 의미
P3 system_level_3 level 파라미터: system_level_3, 시스템 등급 P3을 의미
xxx issl_yyyyy level 파라미터: issl_yyyyy, 사용자 정의 등급 xxx을 의미

확장 필드 extend 설명

파라미터명 파라미터 유형 필수 여부 파라미터 설명
channels array N 설명 내용의 # : 인시던트를 전달할 리소스 목록,
linkList array N 인시던트 링크 추가
members array N 설명 내용의 @ : 인시던트 알림을 받을 알림 대상 멤버
manager array N 담당자 정보(사용자 계정 uuid, 이메일, 팀 uuid)
extra json N 인시던트 업데이트자/담당자 이메일과 이름 등 정보, 프론트엔드 표시용

extend 필드 예시: 

{
    "members": [
        {
            "type": "@",
            "uuid": "acnt_xxxx32",
            "exists": true
        }
    ],
    "channels": [
        {
            "type": "#",
            "uuid": "chan_xxxx32",
            "exists": true
        }
    ],
    "manager": [
        "acnt_xxxxx",
        "xxx@guance.com",
        "group_xxx",
        "xxx@guance.com"
    ],
    "linkList": [
        {
            "name": "해결",
            "link": "https://sd.com",
        }
    ],
    "extra":{
              "updator": {
                  "name": "xxx",
                  "email": "xxx@guance.com",
              },
              "managerInfos": {
                  "xxx@guance.com": {"name": "111"},
                  "xxx@guance.com": {"name": "222"}
              }
            }
}

요청 예시

curl 'https://openapi.guance.com/api/v1/issue/issue_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"statusType":20}'\
--compressed

응답

{
    "code": 200,
    "content": {
        "createAt": 1686398344,
        "creator": "acnt_xxxx32",
        "creatorInfo": {
            "acntWsNickname": "",
            "email": "xxx@guance.com",
            "iconUrl": "",
            "name": "wanglei-testing",
            "username": "xxx@guance.com"
        },
        "deleteAt": -1,
        "description": "",
        "extend": {
            "channels": [
                {
                    "exists": true,
                    "type": "#",
                    "uuid": "chan_xxxx32"
                }
            ],
            "view_isuue_url": ""
        },
        "id": 47402,
        "level": "system_level_2",
        "name": "dcacscsc",
        "resource": "",
        "resourceType": "",
        "resourceUUID": "",
        "status": 0,
        "statusType": 20,
        "subIdentify": "",
        "updateAt": 1686400483,
        "updator": "acnt_xxxx32",
        "updatorInfo": {
            "acntWsNickname": "",
            "email": "xxx@guance.com",
            "iconUrl": "",
            "name": "wanglei-testing",
            "username": "xxx@guance.com"
        },
        "uuid": "issue_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "1744405827768254151"
}

문서 평가

이 페이지가 도움이 되었나요?