Rest API Documentation

REST API Documentation for Group resource, application /webconsole Version: 4.2.1.2

Endpoints (DRAFT)

PUT /rest/api/resources/add-resource-to-organization

Resource management API doc, Add resource to organization

Query Params:

• resourceId [{'type': 'string'}]:
• organizationId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• update [{'type': 'boolean', 'default': False}]:

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/resources/addChildResource

Resource management API doc, Add Child resource for given resource

Query Params:

• resourceId [{'type': 'string'}]:
• memberResourceId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• update [{'type': 'boolean', 'default': False}]:

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/resources/addGroupToResource

Resource management API doc, Add group to Resource

Query Params:

• resourceId [{'type': 'string'}]:
• groupId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• update [{'type': 'boolean', 'default': False}]:

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/resources/addRoleToResource

Resource management API doc, Add Role with given Id to given resource with provided Id

Query Params:

• resourceId [{'type': 'string'}]:
• roleId [{'type': 'string'}]:
• rights[][{'type': 'array', 'items': {'type': 'string'}}]:
• startDate [{'type': 'string'}]:
• endDate [{'type': 'string'}]:
• update [{'type': 'boolean', 'default': False}]:

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/resources/delete-resource-from-organization/(resourceId)/(organizationId)

Resource management API doc, Delete 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/resources/deleteGroupFromResource

Resource management API doc

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/resources/deleteGroupFromResource/(resourceId)/(groupId)

Resource management API doc, Delete resource from Group

Path Params:

• resourceId [{'type': 'string'}]:
• groupId [{'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/resources/deprovisionResourceByGroup

Resource management API doc, Deprovision Users from resource by group

Query Params:

• resourceId [{'type': 'string'}]:
• groupId [{'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/resources/deprovisionResourceByRole

Resource management API doc, Deprovision Users from resource by role

Query Params:

• resourceId [{'type': 'string'}]:
• roleId [{'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/resources/provisionResourceByGroup

Resource management API doc, Provision Users to resource by group

Query Params:

• resourceId [{'type': 'string'}]:
• groupId [{'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/resources/provisionResourceByRole

Resource management API doc, Provision Users to resource by role

Query Params:

• resourceId [{'type': 'string'}]:
• roleId [{'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/resources/removeChildResource

Resource management API doc

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/resources/removeChildResource/(resourceId)/(memberResourceId)

Resource management API doc, Delete Child resource from given resource

Path Params:

• resourceId [{'type': 'string'}]:
• memberResourceId [{'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/resources/removeRoleFromResource

Resource management API doc

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/resources/removeRoleFromResource/(resourceId)/(roleId)

Resource management API doc, Remove Role with given Id from resource with provided Id

Path Params:

• resourceId [{'type': 'string'}]:
• roleId [{'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/resources/save

Resource management API doc, Save Resource

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/resources/search

Resource management API doc, Search Resources by filter

Query Params:

• name [{'type': 'string'}]:
• resourceTypeId [{'type': 'array', 'items': {'type': 'string'}}]:
• userId [{'type': 'string'}]:
• ownerId [{'type': 'string'}]:
• risk [{'type': 'string'}]:
• returnRootsOnMenuRequest [{'type': 'string'}]:
• attributeName [{'type': 'string'}]:
• attributeValue [{'type': 'string'}]:
• excludeResourceType [{'type': 'string'}]:
• parentId [{'type': 'string'}]:
• referenceId [{'type': 'string'}]:
• 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

DELETE /rest/api/resources/(id)

Resource management API doc, Delete Resource 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/resources/(id)

Resource management API doc, Get Resource by Id

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/ResourceBean

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/ResourceBean

GET /rest/api/resources/(id)/children

Resource management API doc, Get children resources

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• deepFlag [{'type': 'boolean', 'default': False}]:
• includeAccessRights [{'type': 'boolean', 'default': False}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Path Params:

• id [{'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/resources/(id)/groups

Resource management API doc, Get groups entitled with given resource

Query Params:

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

Path Params:

• id [{'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/resources/(id)/organizations

Resource management API doc, Get organizations linked with given resource

Query Params:

• size [{'type': 'integer', 'format': 'int32'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• deepFlag [{'type': 'boolean', 'default': False}]:
• includeAccessRights [{'type': 'boolean', 'default': False}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Path Params:

• id [{'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/resources/(id)/parents

Resource management API doc, Get parent resources

Query Params:

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

Path Params:

• id [{'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/resources/(id)/roles

Resource management API doc, Get role entitled with given resource

Query Params:

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

Path Params:

• id [{'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/resources/(id)/users

Resource management API doc, Get Users entitled with given resource

Query Params:

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

Path Params:

• id [{'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## Definitions