Versions Compared

Old Version 11

changes.mady.by.user Justin

Saved on

compared with

New Version 12

changes.mady.by.user Justin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition

Organization API can perform functions to interact or exchange data with Organization and its users.


NameDescription
1

Anchor
Add organization
Add organization
Add organization

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Add a new organization.

Name

Description
URL/organization
HTTP MethodPOST
Body Parameters
ParameterDescription
idOrganization ID.
nameOrganization name.
descriptionDescription of organization.
Sample Response
Code Block
languagejs
{
  "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
borderColorblack
bgColor#fbfff5
borderStylesolid

Assign a Joget user to an organization.

Name

Description
URL/organization/assignUser/{organization}/{username}
HTTP MethodPOST
Path Parameters
ParameterDescription
organizationOrganization ID.
usernameUsername of Joget user.
Sample Response
Code Block
languagejs
{
  "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
borderColorblack
bgColor#fbfff5
borderStylesolid

Delete an organization via organization ID.

Name

Description
URL/organization/{id}
HTTP MethodDELETE
Path Parameters
ParameterDescription
idOrganization ID.
Sample Response
Code Block
languagejs
{
  "date": "Wed Aug 28 15:43:58 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
4

Anchor
Find organization
Find organization
Find organization

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Gets all organizations by default.

Able to filter or sort the returned results via parameters.

Name

Description
URL/organization/find
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterFilters 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "id": "ORG-001",
    "name": "Joget.Org",
    "description": ""
  }
]
5

Anchor
Get organization by ID
Get organization by ID
Get organization by ID

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get details of a organization via organization ID.

Name

Description
URL/organization/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
idOrganization ID.
Sample Response
Code Block
languagejs
[
  {
    "id": "ORG-001",
    "name": "Joget.Org",
    "description": ""
  }
]
6

Anchor
Unassign user from organization
Unassign user from organization
Unassign user from organization

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Unassign a Joget user from an organization.

Name

Description
URL/organization/unassignUser/{organization}/{username}
HTTP MethodDELETE
Path Parameters
ParameterDescription
organizationOrganization ID.
usernameUsername of Joget user.
Sample Response
Code Block
languagejs
{
  "date": "Thu Dec 05 03:29:56 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
7

Anchor
Update organization
Update organization
Update organization

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Update the details of a organization.

Name

Description
URL/organization
HTTP MethodPUT
Body Parameters
ParameterDescription
idOrganization ID.
nameOrganization name.
descriptionDescription of organization.
Sample Response
Code Block
languagejs
{
  "id": "apiTestOrg",
  "name": "API Test Org",
  "description": "This organization is updated via API."
}

...