그룹 정보 수정

싸인투게더의 고객 그룹의 정보를 수정합니다.

API 사용이 가능하더라도 기본적으로는 사용할 수 없으며, 싸인투게더 운영팀에 소통하신 후 권한을 부여 받으신 후에 사용 가능합니다.

API 계정 그룹의 권한에 따라 해당 그룹 및 하위 그룹의 정보만 수정 가능합니다.

그룹 정보수정

POST /rest/api/group

파라미터는 파라미터 셋을 배열로 받아 다중으로 요청이 가능합니다.

1개의 세트만 처리하고 싶은 경우 배열에 1개의 파라미터 셋만 세팅하여 전달해주면 됩니다.

Headers

Name	Type	Description
apiKey*	String	apiKey

Request Body

Name	Type	Description
groupId*	Number	변경할 그룹 Id
update	Object	갱신할 데이터 { "groupName":"변경할그룹명", "groupPartName":"부서명", "level":2, "parentGroupId":1 }
flag*	String	동작에 대한 구분자 수정 시 "U"

Request Example

요청 예시

[
  {
    "groupId":1,                     // 수정할 그룹 Id
    "update":{
      "groupName":"변경그룹명",        // 수정할 그룹명
      "groupPartName":"변경부서명",    // 수정할 그룹의 기본 부서명
      "level":1,                     // 수정할 그룹의 레벨(상위그룹/하위그룹 개념)
      "parentGroupId":null           // 상위그룹 Id
    },
    "flag":"U"                       // 수정 flag
  }
]

Response Example

200: OK 성공 또는 핸들링된 오류

Example

{
    "successCount": 1,
    "failCount": 0,
    "successList": [
        {
            "urlPath": "SGT_0000000001",
            "groupAdminId": 1,
            "modifyDate": "2024-09-01T09:00:00.000",
            "message": "",
            "phoneNumber": "",
            "update": {
                "groupName": "변경그룹명",
                "groupPartName": "변경부서명",
                "level": 1,
                "parentGroupId": null
            },
            "parentGroupId": 1,
            "level": 1,
            "adminUserId": 1,
            "used": true,
            "success": true,
            "groupId": 1,
            "groupName": "변경그룹명"
        }
    ],
    "failList": []
}

400: Bad Request 핸들링하지 못한 오류에 대한 처리

Example

{
  "timestamp": "2023-09-01T14:27:27.971+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "[|COM_002]Invalid_Parameter|파라미터 정보가 정상적이지 않습니다.",
  "path": "/rest/create-document"
}

401: Unauthorized keyauth 토큰(apikey)이 잘못된 경우

Example

{
    "message": "Bad token; invalid JSON"
}

401: Unauthorized Header에 apikey를 전달하지 않은 경우

Example

{
    "message": "Unauthorized"
}