Page History

Panel

borderColor	green
borderWidth	1
titleBGColor	#ddffcc
borderStyle	solid
title	Definition

Group API can perform functions to interact or exchange data for Groups.

...

interact with Group and its users in the Joget built-in directory manager.

Image Added

Name

Description

1

Anchor

	Add group
	Add group

Add group

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Add a new group.

Name

Description

URL

/group

HTTP Method

POST

Body Parameters

Parameter

Description

id

Group ID.

name

Group name.

description

Description of group.

organization

Key	Description
id	ID of the organization that this group belongs to. This parameter is optional.

Sample Response

Code Block

language	js

{
  "id": "apiTestGroup",
  "name": "API Test Group",
  "description": "This is a group created by API.",
  "organization": {
    "id": "ORG-001"
  }
}

2

Anchor

	Assign user to group
	Assign user to group

Assign user to group

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Assign a Joget user to a group.

Name

Description

URL

/group/assignUser/{group}/{username}

HTTP Method

POST

Path Parameters

Parameter	Description
group	Group ID.
username	Username of Joget user.

Sample Response

Code Block

language	js

{
  "username": "cat",
  "groups": [
    {
		"id": "G-004",
		"name": "API Test Group",
		"description": "This is API generated group.",
		"organizationId": "ORG-001"
	}
  ]
}

3

Anchor

	Delete group
	Delete group

Delete group

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Delete a group via group ID.

Name

Description

URL

/group/{id}

HTTP Method

DELETE

Path Parameters

Parameter	Description
id	Group ID.

Sample Response

Code Block

language	js

{
  "date": "Wed Aug 28 16:13:00 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

4

Anchor

	Find group
	Find group

Find group

Gets

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get all groups by default.

Able to filter or sort the returned results via parameters.

Name

Description

URL

/group/find

HTTP Method

GET

Query String Parameters

Parameter	Description
nameFilter	Filters the response via group ID.
organizationId	Filter groups that belong to an organization, via organization ID.
sort	Group data column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "id": "G-001",
    "name": "Managers",
    "description": "",
	"organization": {
    	"id": "ORG-001"
  	}
  },
  {
    "id": "G-002",
    "name": "CxO",
    "description": "",
	"organization": null
  },
	.....
]

5

Anchor

	Find group by username
	Find group by username

Find group by username

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Find the group that belongs to the specified user via username.

Name

Description

URL

/group/findByUser/{username}

HTTP Method

GET

Path Parameters

Parameter	Description
username	Username of a Joget user.

Query String Parameters

Parameter	Description
nameFilter	Filters the response via group ID.
organizationId	Filter groups that belong to an organization, via organization ID.
inGroup	Search for group(s) that the user belongs or does not belong to. Expects a boolean value.
sort	Group data column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "id": "G-001",
    "name": "Managers",
    "description": "",
	"organization": {
    	"id": "ORG-001"
  	}
  }
]

6

Anchor

	Get group by ID
	Get group by ID

Get group by ID

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get details of a group via group ID.

Name

Description

URL

/group/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Group ID.

Sample Response

Code Block

language	js

{
  "id": "G-002",
  "name": "CxO",
  "description": "",
  "organization": {
    "id": "ORG-001"
  }
}

7

Anchor

	Unassign user from group
	Unassign user from group

Unassign user from group

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Unassign a Joget user from a group.

Name

Description

URL

/group/unassignUser/{group}/{username}

HTTP Method

DELETE

Path Parameters

Parameter	Description
group	Group ID.
username	Username of Joget user.

Sample Response

Code Block

language	js

{
  "date": "Thu Dec 05 03:29:56 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

8

Anchor

	Update group
	Update group

Update group

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Update the details of a group.

Name

Description

URL

/group

HTTP Method

PUT

Body Parameters

Parameter

Description

id

Group ID.

name

Group name.

description

Description of group.

organization

Key	Description
id	ID of the organization that this group belongs to.

Sample Response

Code Block

language	js

{
	"id": "apiTestGroup",
	"name": "API Test Group",
	"description": "This group is updated via API.",
	"organization": {
    	"id": "ORG-001"
  	}
}

Space shortcuts

Page tree

Versions Compared

Old Version 3

New Version Current

Key