Rest API Documentation

REST API Documentation for Group organization, application /webconsole Version: 4.2.1.3

Endpoints (DRAFT)

POST /rest/api/organizations/addChildOrganization

Organizations API Doc, Add child organization

Query Params:

• organizationId [{'type': 'string'}]:
• childOrganizationId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/addGroupToOrganization

Organizations API Doc, Remove group from organization

Query Params:

• groupId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'integer', 'format': 'int64'}]:
• endDate [{'type': 'integer', 'format': 'int64'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/addResourceToOrganization

Organizations API Doc, Add resource to organization

Query Params:

• resourceId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'integer', 'format': 'int64'}]:
• endDate [{'type': 'integer', 'format': 'int64'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/addRoleToOrganization

Organizations API Doc, Add role to organization

Query Params:

• roleId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'integer', 'format': 'int64'}]:
• endDate [{'type': 'integer', 'format': 'int64'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/organizations/find

Organizations API Doc, Search for Organizations

Query Params:

• name [{'type': 'string'}]:
• childId [{'type': 'string'}]:
• parentId[][{'type': 'array', 'items': {'type': 'string'}}]:
• validParentTypeId [{'type': 'string'}]:
• organizationTypeId[][{'type': 'array', 'items': {'type': 'string'}}]:
• isSelectable [{'type': 'boolean'}]:
• isUncoverParents [{'type': 'boolean'}]:
• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

POST /rest/api/organizations/getAllowedParentOrganizationTypes

Organizations API Doc

Query Params:

• orgTypeId [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/organizations/location/delete

Organizations API Doc

Query Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/location/save

Organizations API Doc, Save or remove organization location

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/organizations/location/(id)

Organizations API Doc, Remove organization location

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/organizations/organization-types

Organizations API Doc

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/organizations/organizationTypeChildAdd

Organizations API Doc, Add child organization type

Query Params:

• typeId [{'type': 'string'}]:
• memberTypeId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/organizationTypeChildDelete

Organizations API Doc

Query Params:

• typeId [{'type': 'string'}]:
• memberTypeId [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/organizations/organizationTypeChildDelete/(typeId)/(memberTypeId)

Organizations API Doc, Delete child organization type

Path Params:

• typeId [{'type': 'string'}]:
• memberTypeId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/removeChildOrganization

Organizations API Doc

Query Params:

• organizationId [{'type': 'string'}]:
• childOrganizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/organizations/removeChildOrganization/(organizationId)/(childOrganizationId)

Organizations API Doc, Remove child organization

Path Params:

• organizationId [{'type': 'string'}]:
• childOrganizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/removeGroupFromOrganization

Organizations API Doc

Query Params:

• groupId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/organizations/removeGroupFromOrganization/(groupId)/(organizationId)

Organizations API Doc, Remove group from organization

Path Params:

• groupId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/removeResourceFromOrganization

Organizations API Doc

Query Params:

• resourceId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/organizations/removeResourceFromOrganization/(resourceId)/(organizationId)

Organizations API Doc, Remove resource from organization

Path Params:

• resourceId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/removeRoleFromOrganization

Organizations API Doc

Query Params:

• roleId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/organizations/removeRoleFromOrganization/(roleId)/(organizationId)

Organizations API Doc, Remove role from organization

Path Params:

• roleId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

POST /rest/api/organizations/save

Organizations API Doc, Save Organization

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/organizations/search/treegrid

Organizations API Doc

Query Params:

• name [{'type': 'string'}]:
• organizationTypeId [{'type': 'string'}]:
• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• orderBy [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/TreeGridResponse

DELETE /rest/api/organizations/(id)

Organizations API Doc, Delete Organization by ID

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/organizations/(id)

Organizations API Doc

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/Organization

GET /rest/api/organizations/(organizationId)/identities

Organizations API Doc, Get organization identities

Path Params:

• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/organizations/(organizationId)/locations

Organizations API Doc, Get organization locations

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Path Params:

• organizationId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse## Definitions