프로시저 수정
지정한 프로시저를 수정합니다.
HTTP 요청
PUT /api/sonar/procedures/:guid
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
-d name="test" \
-d 'query=system tables | search table == $("table")' \
-d 'parameters=[{"type": "string", "name": "테이블", "key": "table"}]' \
-d granted_user_guids=b5bc3133-b53e-4b61-96b5-8857015ade0d \
-X PUT https://HOSTNAME/api/sonar/procedures/5ad13151-dbc1-41c0-92a7-dfeb5f534f4c
요청 매개변수
경로 매개변수
| 키 | 타입 | 설명 | 비고 |
|---|---|---|---|
| guid | 문자열 | 프로시저 식별자 | 36자 |
요청 본문 매개변수
| 키 | 필수 | 타입 | 설명 | 비고 |
|---|---|---|---|---|
| name | O | 문자열 | 프로시저 이름 | 최소 1자, 최대 255자 |
| description | X | 문자열 | 프로시저 설명 | 최대 2,000자 |
| query | O | 문자열 | 쿼리 문자열 | |
| parameters | X | 객체 배열 | 매개변수 목록 | 하단 참조 |
| company_public | X | 불리언 | 전체 공유 여부 | 기본값: false |
| granted_user_guids | X | 문자열 배열 | 공유 계정 목록 | 쉼표(,)를 구분자로 하는 계정 GUID 목록 |
| granted_group_guids | X | 문자열 배열 | 공유 계정 그룹 목록 | 쉼표(,)를 구분자로 하는 계정 그룹 GUID 목록 |
parameters 객체 속성
- type (문자열): 매개변수의 데이터 타입 (예:
string) - key (문자열): 매개변수의 고유 식별 키. 쿼리에서
$("key")형식으로 참조 - name (문자열): 매개변수의 표시 이름
- description (문자열): 매개변수 설명
정상 응답
{}
오류 응답
필수 매개변수가 누락된 경우
HTTP 상태 코드 400 응답
{
"error_code": "null-argument",
"error_msg": "name should be not null"
}
매개변수 값의 길이가 잘못된 경우
HTTP 상태 코드 400 응답
{
"error_code": "invalid-argument",
"error_msg": "'name' must be less than or equal to 255 characters."
}
계정 및 그룹 식별자가 GUID 형식이 아닌 경우
HTTP 상태 코드 400 응답
{
"error_code": "invalid-param-type",
"error_msg": "granted_user_guids should be guid type."
}