Page History

Panel

borderColor	green
borderWidth	1
titleBGColor	#ddffcc
borderStyle	solid
title	Definition

Organization API can perform functions to interact or exchange data for Organization.

Image Removed

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

Image Added

Name

Description

1

Anchor

	Add organization
	Add organization

Add organization

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Add a new organization.

Name

Description

URL

/organization

HTTP Method

POST

Body Parameters

Parameter	Description
id	Organization ID.
name	Organization name.
description	Description of organization.

Sample Response

Code Block

language	js

{
  "id": "apiTestOrg",
  "name": "API Test Org",
  "description": "This is an organization created by API."
}

2

Anchor

	Assign user to organization
	Assign user to organization

Assign user to organization

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Assign a Joget user to an organization.

Name

Description

URL

/organization/assignUser/{organization}/{username}

HTTP Method

POST

Path Parameters

Parameter	Description
organization	Organization ID.
username	Username of Joget user.

Sample Response

Code Block

language	js

{
  "userId": "david",
  "startDate": null,
  "endDate": null,
  "employeeCode": null,
  "gradeId": "G-002",
  "departmentId": "D-007",
  "organizationId": "ORG-001"
}

3

Anchor

	Delete organization
	Delete organization

Delete organization

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Delete

a

an organization via organization ID.

Name

Description

URL

/organization/{id}

HTTP Method

DELETE

Path Parameters

Parameter	Description
id	Organization ID.

Sample Response

Code Block

language	js

{
  "date": "Wed Aug 28 15:43:58 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

43

Anchor

	Find organization
	Find organization

Find organization

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Gets all organizations by default.

Able to filter or sort the returned results via parameters.

Name

Description

URL

/organization/find

HTTP Method

GET

Query String Parameters

Parameter	Description
nameFilter	Filters the response via organization ID.
sort	Organization 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": "ORG-001",
    "name": "Joget.Org",
    "description": ""
  }
]

54

Anchor

	Get organization by ID
	Get organization by ID

Get organization by ID

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get details of a organization via organization ID.

Name

Description

URL

/organization/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Organization ID.

Sample Response

Code Block

language	js

[
  {
    "id": "ORG-001",
    "name": "Joget.Org",
    "description": ""
  }
]

6

Anchor

	Unassign user from organization
	Unassign user from organization

Unassign user from organization

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Unassign a Joget user from an organization.

Name

Description

URL

/organization/unassignUser/{organization}/{username}

HTTP Method

DELETE

Path Parameters

Parameter	Description
organization	Organization 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"
}

75

Anchor

	Update organization
	Update organization

Update organization

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Update the details of a organization.

Name

Description

URL

/organization

HTTP Method

PUT

Body Parameters

Parameter	Description
id	Organization ID.
name	Organization name.
description	Description of organization.

Sample Response

Code Block

language	js

{
  "id": "apiTestOrg",
  "name": "API Test Org",
  "description": "This organization is updated via API."
}

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key