Jump to

• Request
• Response

Retrieve User Group by ID

get

/api/1.0/usergroup/{id}

This endpoint is used to retrieve the User Group by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  ID of the user that needs to be fetched

Query Parameters

• version(required): string
  Version.

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the User Group based on given ID.

Body ()

Root Schema : DmTmUserGroupWrapperDTO

Type: object

Show Source

• data: object DmTmUserGroupDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/DmTmUserGroupDTO"
        }
    }
}

Nested Schema : DmTmUserGroupDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmUserGroupDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "userGroupCd":{
                    "description":"User Group code",
                    "type":"string"
                },
                "userGroupDescr":{
                    "description":"User Group description",
                    "type":"string"
                },
                "hirachyOrder":{
                    "description":"Hierarchy order",
                    "type":"integer"
                },
                "supervisoryGroupCd":{
                    "description":"Supervisory Group code",
                    "type":"string"
                },
                "defaultAssigneeFlg":{
                    "description":"Default Assignee Flag",
                    "type":"boolean"
                },
                "DmTmUserGroupMembersDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmUserGroupMembersDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmUserGroupDTO-allOf[1]

Type: object

Show Source

• defaultAssigneeFlg: boolean
  Default Assignee Flag
• DmTmUserGroupMembersDTO: array DmTmUserGroupMembersDTO
• hirachyOrder: integer
  Hierarchy order
• supervisoryGroupCd: string
  Supervisory Group code
• userGroupCd: string
  User Group code
• userGroupDescr: string
  User Group description

{
    "type":"object",
    "properties":{
        "userGroupCd":{
            "description":"User Group code",
            "type":"string"
        },
        "userGroupDescr":{
            "description":"User Group description",
            "type":"string"
        },
        "hirachyOrder":{
            "description":"Hierarchy order",
            "type":"integer"
        },
        "supervisoryGroupCd":{
            "description":"Supervisory Group code",
            "type":"string"
        },
        "defaultAssigneeFlg":{
            "description":"Default Assignee Flag",
            "type":"boolean"
        },
        "DmTmUserGroupMembersDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmUserGroupMembersDTO"
            }
        }
    }
}

Nested Schema : DmTmUserGroupMembersDTO

Type: array

Show Source

• Array of: object DmTmUserGroupMembersDTO
  User group Members Details.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmUserGroupMembersDTO"
    }
}

Nested Schema : DmTmUserGroupMembersDTO

Type: object

User group Members Details.

Show Source

• activeFlg: boolean
  Active Flag
• id: string
  ID
• userGroupMasterId: string
  User group Master ID
• userId: string
  User ID
• userName: string
  User Name

{
    "description":"User group Members Details.",
    "type":"object",
    "properties":{
        "userId":{
            "description":"User ID",
            "type":"string"
        },
        "userName":{
            "description":"User Name",
            "type":"string"
        },
        "activeFlg":{
            "description":"Active Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "userGroupMasterId":{
            "type":"string",
            "description":"User group Master ID"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top