Get All Valid User Group
get
/api/1.0/usergroup
This endpoint is used to Get all valid User Group maintenance records.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
authStatus(optional): string
Authorization Status
-
defaultAssigneeFlg(optional): string
Default Assignee Flag
-
fetchExpiredGroupsFlg(optional): string
Fetch Expired Groups Flags
-
includecloseandunauth(optional): boolean
Include close and unauthorized need to be set to fetch summary record, default value is false.
-
limit(optional): integer
Limit is maximum number of records to be fetched.
-
offset(optional): integer
Offset is starting number of records to be fetched.
-
recordStatus(optional): string
Record Status
-
supervisoryGroupCd(optional): string
Supervisory Group Code
-
userGroupCd(optional): string
User Group Code
-
userGroupDescr(optional): string
User Group Description
Header Parameters
-
appId: string
The application ID of host service.
-
branchCode: string
The branch code of requesting branch.
-
contentType(optional): string
The content type of request or response body.
-
userId: string
The user ID of requesting user.
Response
Supported Media Types
- application/json
- application/xml
201 Response
Valid User groups retrieved successfully.
Headers
-
Location: string
URL details.
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : DmTmUserGroupDTO-allOf[1]
Type:
Show Source
object
-
defaultAssigneeFlg(optional):
boolean
Default Assignee Flag
-
DmTmUserGroupMembersDTO(optional):
array DmTmUserGroupMembersDTO
-
hirachyOrder(optional):
integer
Hierarchy order
-
supervisoryGroupCd(optional):
string
Supervisory Group code
-
userGroupCd(optional):
string
User Group code
-
userGroupDescr(optional):
string
User Group description
Nested Schema : DmTmUserGroupMembersDTO
Type:
Show Source
array
-
Array of:
object DmTmUserGroupMembersDTO
User group Members Details.
Nested Schema : DmTmUserGroupMembersDTO
Type:
object
User group Members Details.
Show Source
-
activeFlg(optional):
boolean
Active Flag
-
id(optional):
string
ID
-
userGroupMasterId(optional):
string
User group Master ID
-
userId(optional):
string
User ID
-
userName(optional):
string
User Name
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error