Workspace
Create a workspace
워크스페이스 등록
POST /api/workspace
워크스페이스명과 썸네일을 지정하여 워크스페이스를 등록할 수 있습니다. 썸네일 등록은 선택사항으로 생략 가능합니다.
Request Body
multipartFile
MultipartFile
등록할 워크스페이스 썸네일
name*
String
등록할 워크스페이스
{
"message": "워크스페이스 등록 완료",
"id": "string"
}Update a workspace
워크스페이스 수정
PATCH /api/workspace
워크스페이스명과 썸네일을 수정할 수 있습니다. 썸네일 수정은 선택사항으로 생략 가능합니다.
Request Body
multipartFile
MultipartFile
수정할 워크스페이스 썸네일
id*
String
수정할 워크스페이스 ID
name*
String
수정할 워크스페이스명
{
"message": "워크스페이스 변경에 성공했습니다."
}Delete a workspace
워크스페이스 삭제
DELETE /api/workspace/{workspaceId}
해당 워크스페이스를 데이터베이스에서 소프트 삭제합니다.
Path Parameters
workspaceId*
String
삭제할 워크스페이스 ID
{
"message": "워크스페이스 삭제에 성공했습니다."
}Get a list of workspace for user
소속 워크스페이스 목록 조회
GET /api/workspace/list
로그인한 회원이 소속된 워크스페이스 목록을 조회합니다.
{
"message": "워크스페이스 목록 조회 완료",
"workspaceGetResponseDTOList": [
{
"id": "string",
"name": "string",
"thumbnailImage": "string"
}
]
}Get info for a workspace
워크스페이스 정보 조회
GET /api/workspace/info?workspaceId=
요청한 워크스페이스의 워크스페이스명과 썸네일을 조회합니다.
Query Parameters
workspaceId*
String
정보 조회할 워크스페이스 ID
{
"message": "워크스페이스명 조회 완료",
"name": "string",
"thumbnailImage": "string"
}Add users to workspace
워크스페이스 멤버 등록
POST /api/workspace/{workspaceId}/member
이메일을 이용하여 여러 명의 회원을 워크스페이스에 가입시킬 수 있습니다.
Path Parameters
workspaceId*
String
가입할 워크스페이스 ID
Request Body
emailList*
List<String>
워스페이스에 가입 이메일 리스트
{
"message": "워크스페이스 멤버 등록 완료"
}Remove user from workspace
워크스페이스 멤버 삭제
DELETE /api/workspace/{workspaceId}/member?email={email}
워크스페이스 멤버에서 요청한 이메일을 사용하는 회원을 삭제합니다.
Path Parameters
workspaceId*
String
회원을 삭제할 워크스페이스 ID
Query Parameters
email*
String
삭제할 회원 이메일
{
"message": "워크스페이스 멤버 삭제 완료"
}Search users for workspace member registration
워크스페이스 멤버 등록을 위한 회원목록 검색
GET /api/workspace/{workspaceId}/member/list?keyword={keyword}&seq={seq}
워크스페이스 멤버 등록을 위해 요청한 keyword, seq를 기반으로 회원목록을 검색합니다. 검색결과는 seq당 10개씩 반환합니다.
Path Parameters
workspaceId*
String
검색할 워크스페이스 ID
Query Parameters
keyword*
String
회원 이름을 검색하기 위한 검색어 키워드
seq*
int
검색결과 목록 순서
{
"message": "워크스페이스멤버 목록 조회 완료",
"workspaceMemberGetResponseDTOList": [
{
"email": "string",
"name": "string",
"statusCode": "string",
"nickname": "string",
"workspaceMemberCode": "string",
"profileImage": "string"
}
]
}Search workspace members
워크스페이스 멤버 검색
GET /api/workspace/{workspaceId}/member/search?keyword={keyword}&seq={seq}
워크스페이스에 소속된 멤버를 요청한 keyword, seq를 기반으로 검색합니다.
Path Parameters
workspaceId*
String
검색할 워크스페이스 ID
Query Parameters
keyword*
String
회원 이름을 검색하기 위한 검색어 키워드
seq*
int
검색결과 목록 순서
{
"message": "워크스페이스멤버 검색 완료",
"workspaceMemberGetResponseDTOList": [
{
"email": "string",
"name": "string",
"statusCode": "string",
"nickname": "string피",
"workspaceMemberCode": "string",
"profileImage": "string"
}
]
}Get a member code of user
워크스페이스 멤버 코드 조회
GET /api/workspace/{workspaceId}/member/code
요청한 워크스페이스의 멤버 권한을 조회한다.(WorkspaceMemberCode: WADMIN, WMEMBER )
Path Parameters
workspaceId*
String
조회할 워크스페이스 ID
{
"message": "워크스페이스 멤버 코드 조회 완료",
"workspaceMemberCode": "string"
}Last updated