登录
当前位置： 首页 > 工具软件 > Bonita > 使用案例 >

bonita BPM-----portal API

卫子平
2023-12-01


portal API


Page

Description

Use the page resource to access custom pages.

Identifier

Simple, the ID of the object (a long value)

Representation

{
    "id":"_page_id_",
    "creationDate":"_date and time_",
    "createdBy":"_created_by_user_id_",
    "isProvided":"_true|false_",
    "description":"_description_",
    "contentName":"_custom_page_name_",
    "displayName":"_custom_page_display_name_",
    "updatedBy":"_updatedBy_user_id_",
    "lastUpdateDate":"_date_and_time_",
    "urlToken":"_custom_page_urlToken_"
} page对象的结构定义；

Methods

The methods used for this resource are:

  • POST - Add a new custom page
  • GET - Read or search a custom page
  • PUT - Update a custom page
  • DELETE - Remove a custom page

Retrieve a Custom Page

Use a GET method to retrieve information about a custom page.

  • URL
    /API/portal/page/:pageId
  • Method
    GET
  • Success Response
    • Code: 200
    • Payload: 
      {
  "id":"1",
  "creationDate":"2014-12-02 15:54:45.249",
  "createdBy":"",
  "isProvided":"true",
  "description":"HTML and Javascript example of custom page source structure (in English).",
  "contentName":"bonita-html-page-example.zip",
  "displayName":"HTML example page",
  "updatedBy":"-1",
  "lastUpdateDate":"2014-12-02 15:54:45.249",
  "urlToken":"custompage_htmlexample"
}

发送命令：


GET http://localhost:15177/bonita/API/portal/page/9 HTTP/1.1
Host: localhost:15177
Connection: keep-alive
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
Content-Type: application/json
Accept: */*
DNT: 1
Referer: http://localhost:15177/bonita/portal/homepage
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=0DF92E18A268AF7E5680AAE5DCFD8980; X-Bonita-API-Token=ccd95f19-bfee-4f2c-b8c4-c885a1124020; bonita.tenant=1; BOS_Locale=en

响应命令： 


HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Pragma: No-cache
Cache-Control: no-cache,no-store,no-transform,max-age=0
Expires: 19    2016 06:34:53 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 20 Oct 2016 06:34:53 GMT

1f0
{"id":"9","creationDate":"2016-10-20 08:06:10.067","createdBy":"","isProvided":"true","description":"REST API extension example archive for Bonita BPM Portal. Included examples: Get/Post, how to use a logger, customize response, call SOAP web service.","contentType":"apiExtension","contentName":"api-extension-example.zip","displayName":"REST API extension example","processDefinitionId":"","updatedBy":"-1","lastUpdateDate":"2016-10-20 08:06:10.067","urlToken":"custompage_apiExtensionExample"}
0


Add a new custom page

Use the POST method to create a new custom page. To add a new custom page, there are two steps:

  1. Upload the page content using the pageUpload servlet. This returns a temporary file name.
  2. Call this API with the temporary file name, as in the example below.
  • URL
    /API/portal/page Example: Add the custom page that was given the temporary name tmp_2181700538398444744.zip. The original name was bonita-angular-dashboard.zip.
  • Method
    POST
  • Request Payload 
    {
  "pageZip":"tmp_113096560980259488.zip:bonita-angular-dashboard.zip"
}
  • Success Response
    • Code: 200
    • Payload: 
      {
  "id":"103",
  "creationDate":"2014-12-04 14:54:06.967",
  "createdBy":"1",
  "isProvided":"false",
  "description":"AngularJS dashboard using ngBonita",
  "contentName":"bonita-angular-dashboard.zip",
  "displayName":"AngularJS dashboard",
  "updatedBy":"1",
  "lastUpdateDate":"2014-12-04 14:54:06.967",
  "urlToken":"custompage_angulardashboard"
}


Update a custom page

Use the PUT method to update an existing custom page. To update a custom page, upload the new page content using the pageUpload servlet, which returns a temporary file name, and then call this API with the temporary file name.

  • URL
    /API/portal/page/:pageId
    Example: Update the custom page with id = 103. The new uploaded file was given the temporary name tmp_4338264789005487499.zip. The original name was new-bonita-angular-dashboard.zip.
  • Method
    PUT
  • Request Payload 
    {
  "pageZip":"tmp_4338264789005487499.zip:new-bonita-angular-dashboard.zip"
}
  • Success Response
    • Code: 200
想通过如下的PUT 命令实现对page属相的修改，结果失败，这个命令可能只能实现page的整体更新。 
PUT http://localhost:15177/bonita/API/portal/page/9 HTTP/1.1
Host: localhost:15177
Connection: keep-alive
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
Content-Type: application/json
Accept: */*
DNT: 1
Referer: http://localhost:15177/bonita/portal/homepage
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=0DF92E18A268AF7E5680AAE5DCFD8980; X-Bonita-API-Token=ccd95f19-bfee-4f2c-b8c4-c885a1124020; bonita.tenant=1; BOS_Locale=en


{
"createdBy":"wl"
}


Search custom pages

Use a GET method with filters and search terms to search for custom pages.

  • URL
    /API/portal/page?p={page}&c={count}&o={orders}&f={filters}&s={search}&d={deploy}

  • Method
    GET

  • Data Params
    Standard search parameters are available.
    You can filter on:

    • createdBy={user\_id}: retrieve only the pages created by the specified user ID. For example, to retrieve the custom pages created by the user with id 1: http://localhost:8080/bonita/API/portal/page?p=0&c=10&f=createdBy%3d1.
    • contentType={contentType}: retrieve only the resources of requested type. This filter is available since v7.0. For example, to retrieve the theme resources: http://localhost:8080/bonita/API/portal/page?p=0&c=10&f=contentType%3Dtheme.

    You can search on:

    • displayName or description: search for custom pages with a displayName or description that starts with the specified string. For example, to find the pages with displayName starting with New: http://localhost:8080/bonita/API/portal/page?p=0&c=10&s=New

  • Success Response
    An array of custom page objects

    • Code: 200

发送命令：


GET http://localhost:15177/bonita/API/portal/page?p=0&c=10&s=REST HTTP/1.1
Host: localhost:15177
Connection: keep-alive
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
Content-Type: application/json
Accept: */*
DNT: 1
Referer: http://localhost:15177/bonita/portal/homepage
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=0DF92E18A268AF7E5680AAE5DCFD8980; X-Bonita-API-Token=ccd95f19-bfee-4f2c-b8c4-c885a1124020; bonita.tenant=1; BOS_Locale=en

响应命令： 

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Pragma: No-cache
Cache-Control: no-cache,no-store,no-transform,max-age=0
Expires: 19    2016 06:59:15 GMT
Content-Range: 0-10/1
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 20 Oct 2016 06:59:15 GMT

1f2
[{"id":"9","creationDate":"2016-10-20 08:06:10.067","createdBy":"","isProvided":"true","description":"REST API extension example archive for Bonita BPM Portal. Included examples: Get/Post, how to use a logger, customize response, call SOAP web service.","contentType":"apiExtension","contentName":"api-extension-example.zip","displayName":"REST API extension example","processDefinitionId":"","updatedBy":"-1","lastUpdateDate":"2016-10-20 08:06:10.067","urlToken":"custompage_apiExtensionExample"}]
0

Delete a custom page

Use the DELETE method to delete an existing custom page

  • URL
    /API/portal/page/:pageId
  • Method
    DELETE
  • Success Response
    • Code: 200

Profile

Description

Use the profile resource to access profiles.  用来表示登录用户的基本信息。

Identifier

Simple, the ID of the object (a long value)

Representation

    {
    "id":"_profile id_",
    "creationDate":"_date and time of profile creation_",
    "icon":"_icon used in the portal to represent the profile_",
    "createdBy":"_id of the uer who created the profile_",
    "description":"_a description of the profile_",
    "name":"_profile name_",
    "is_default":"_true | false _",
    "lastUpdateDate":"_date and time of the last update to the profile_",
    "updatedBy":"_the id of the user who last updated the profile_"
    }

Methods

The methods used for this resource are:

  • POST - Add a new profile
  • GET - Read or search a profile
  • PUT - Update a profile
  • DELETE - Remove a profile

Retrieve a Profile

Use a GET method to retrieve information about a profile.

  • URL
    /API/portal/profile/:profileId
  • Method
    GET
  • Success Response
    • Code: 200
    • Payload: 
      {
  "id":"1",
  "creationDate":"2014-12-02 15:54:44.395",
  "icon":"/profiles/profileUser.png",
  "createdBy":"-1",
  "description":"The user can view and perform tasks and can start a new case of a process.",
  "name":"User",
  "is_default":"true",
  "lastUpdateDate":"2014-12-04 11:05:14.490",
  "updatedBy":"1"
}

发送命令：

GET http://localhost:15177/bonita/API/portal/profile/2 HTTP/1.1
Host: localhost:15177
Connection: keep-alive
Accept: application/json, text/plain, */*
X-Bonita-API-Token: 7443d370-b6cd-4a41-94d4-29b176a517a2
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
DNT: 1
Referer: http://localhost:15177/bonita/portal.js/
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=0ED013D8072C1225D1370E66210FFD98; bonita.tenant=1; X-Bonita-API-Token=7443d370-b6cd-4a41-94d4-29b176a517a2; BOS_Locale=en

响应命令：

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Pragma: No-cache
Cache-Control: no-cache,no-store,no-transform,max-age=0
Expires: 19    2016 07:52:40 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 20 Oct 2016 07:52:40 GMT

161
{"id":"2","creationDate":"2016-10-20 08:06:08.266","icon":"icons/profiles/profileAdmin.png","createdBy":"-1","description":"The administrator can install a process, manage the organization, and handle some errors (for example, by replaying a task).","name":"Administrator","is_default":"true","lastUpdateDate":"2016-10-20 08:06:25.531","updatedBy":"-1"}
0

Add a new profile

Use the POST method to create a new profile.

  • URL
    /API/portal/profile
  • Method
    POST
  • Request Payload 
      {
    "name":"MyCustomProfile",
    "description":"This is my custom profile"
  }
  • Success Response
    • Code: 200
    • Payload: 
      {
  "id":"101",
  "creationDate":"2014-12-04 16:29:23.434",
  "icon":"/profiles/profileDefault.png",
  "createdBy":"1",
  "description":"This is my custom profile",
  "name":"MyCustomProfile",
  "is_default":"false",
  "lastUpdateDate":"2014-12-04 16:29:23.434",
  "updatedBy":"1"
}

发送命令：

POST http://localhost:15177/bonita/API/portal/profile HTTP/1.1
Host: localhost:15177
Connection: keep-alive
Accept: application/json, text/plain, */*
X-Bonita-API-Token: 7443d370-b6cd-4a41-94d4-29b176a517a2
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
DNT: 1
Referer: http://localhost:15177/bonita/portal.js/
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=0ED013D8072C1225D1370E66210FFD98; bonita.tenant=1; X-Bonita-API-Token=7443d370-b6cd-4a41-94d4-29b176a517a2; BOS_Locale=en

{
    "name":"MyCustomProfile",
    "description":"This is my custom profile"
}

响应命令： 

HTTP/1.1 405 Method Not Allowed
Server: Apache-Coyote/1.1
Pragma: No-cache
Cache-Control: no-cache,no-store,no-transform,max-age=0
Expires: 19    2016 07:58:03 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 20 Oct 2016 07:58:03 GMT

13ce
{"exception":"class org.bonitasoft.web.toolkit.client.common.exception.api.APIMethodNotAllowedException","message":"HTTP method ADD METHOD NOT ALLOWED. not allowed for API portal#profile","stacktrace":"[org.bonitasoft.web.rest.server.datastore.ComposedDatastore.add(ComposedDatastore.java:76), org.bonitasoft.web.rest.server.framework.API.add(API.java:161), org.bonitasoft.web.rest.server.framework.API.runAdd(API.java:150), org.bonitasoft.web.rest.server.framework.APIServletCall.doPost(APIServletCall.java:213), org.bonitasoft.web.toolkit.server.servlet.ToolkitHttpServlet.doPost(ToolkitHttpServlet.java:188), javax.servlet.http.HttpServlet.service(HttpServlet.java:650), org.bonitasoft.web.toolkit.server.servlet.ToolkitHttpServlet.service(ToolkitHttpServlet.java:75), javax.servlet.http.HttpServlet.service(HttpServlet.java:731), org.bonitasoft.web.toolkit.server.servlet.ToolkitHttpServlet.service(ToolkitHttpServlet.java:226), org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:303), org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208), org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52), org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241), org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208), org.tuckey.web.filters.urlrewrite.RuleChain.handleRewrite(RuleChain.java:176), org.tuckey.web.filters.urlrewrite.RuleChain.doRules(RuleChain.java:145), org.tuckey.web.filters.urlrewrite.UrlRewriter.processRequest(UrlRewriter.java:92), org.tuckey.web.filters.urlrewrite.UrlRewriteFilter.doFilter(UrlRewriteFilter.java:394), org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241), org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208), org.bonitasoft.console.common.server.login.filter.AbstractAuthorizationFilter.doFilter(AbstractAuthorizationFilter.java:60), org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241), org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208), org.apache.catalina.core.ApplicationDispatcher.invoke(ApplicationDispatcher.java:747), org.apache.catalina.core.ApplicationDispatcher.processRequest(ApplicationDispatcher.java:485), org.apache.catalina.core.ApplicationDispatcher.doForward(ApplicationDispatcher.java:410), org.apache.catalina.core.ApplicationDispatcher.forward(ApplicationDispatcher.java:337), org.tuckey.web.filters.urlrewrite.NormalRewrittenUrl.doRewrite(NormalRewrittenUrl.java:213), org.tuckey.web.filters.urlrewrite.RuleChain.handleRewrite(RuleChain.java:171), org.tuckey.web.filters.urlrewrite.RuleChain.doRules(RuleChain.java:145), org.tuckey.web.filters.urlrewrite.UrlRewriter.processRequest(UrlRewriter.java:92), org.tuckey.web.filters.urlrewrite.UrlRewriteFilter.doFilter(UrlRewriteFilter.java:394), org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241), org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208), org.bonitasoft.console.common.server.login.filter.AbstractAuthorizationFilter.doFilter(AbstractAuthorizationFilter.java:60), org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241), org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208), org.bonitasoft.console.common.server.login.filter.AbstractAuthorizationFilter.doFilter(AbstractAuthorizationFilter.java:60), org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241), org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208), org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:220), org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:122), org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:505), org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:169), org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:103), org.bonitasoft.console.security.SessionFixationValve.invoke(SessionFixationValve.java:77), org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:116), org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:423), org.apache.coyote.http11.AbstractHttp11Processor.process(AbstractHttp11Processor.java:1079), org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:625), org.apache.tomcat.util.net.JIoEndpoint$SocketProcessor.run(JIoEndpoint.java:316), java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1145), java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:615), org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61), java.lang.Thread.run(Thread.java:745)]","api":"portal","resource":"profile"}
0

异常报错。HTTP server 并不支持Add方法，增加profile；

message=HTTP method ADD METHOD NOT ALLOWED. not allowed for API portal#profile

Update a profile

Use the PUT method to update an existing profile.

  • URL
    /API/portal/profile/:profileId
  • Method
    PUT
  • Request Payload 
    {
  "id":"101",
  "name":"MyUpdatedCustomProfile",
  "description":"This is my updated custom profile"
}
  • Success Response
    • Code: 200
发送命令： 

PUT http://localhost:15177/bonita/API/portal/profile/1 HTTP/1.1
Host: localhost:15177
Connection: keep-alive
Accept: application/json, text/plain, */*
X-Bonita-API-Token: 7443d370-b6cd-4a41-94d4-29b176a517a2
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
DNT: 1
Referer: http://localhost:15177/bonita/portal.js/
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=0ED013D8072C1225D1370E66210FFD98; bonita.tenant=1; X-Bonita-API-Token=7443d370-b6cd-4a41-94d4-29b176a517a2; BOS_Locale=en

{ "id":"1","name":"user_wl" }


响应命令：产生如下错误；

message=HTTP method UPDATE METHOD NOT ALLOWED. not allowed for API portal#profile

暂时没有找到好的对策。


Search profiles

Use a GET method with filters and search terms to search for profiles.

  • URL
    /API/portal/profile?p={page}&c={count}&o={orders}&f={filters}&s={search}&d={deploy}

  • Method
    GET

  • Data Params
    Standard search parameters are available.
    You can filter on:

    • name={exact_profile_name}: retrieve only the profiles with the specified name. For example, retrieve the profile withname=Administrator: /API/portal/profile?p=0&c=10&f=name%3dAdministrator

    You can search on:

    • name: search all profiles which name starts with the search string. For example, name starting with Adm: /API/portal/profile?p=0&c=10&s=Adm

  • Success Response

    • Code: 200
    • Payload:
      An array of profile objects
发送命令： 

GET http://localhost:15177/bonita/API/portal/profile?p=0&c=10 HTTP/1.1
Host: localhost:15177
Connection: keep-alive
Accept: application/json, text/plain, */*
X-Bonita-API-Token: 7443d370-b6cd-4a41-94d4-29b176a517a2
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
DNT: 1
Referer: http://localhost:15177/bonita/portal.js/
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=0ED013D8072C1225D1370E66210FFD98; bonita.tenant=1; X-Bonita-API-Token=7443d370-b6cd-4a41-94d4-29b176a517a2; BOS_Locale=en
响应命令： 

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Pragma: No-cache
Cache-Control: no-cache,no-store,no-transform,max-age=0
Expires: 19    2016 07:47:42 GMT
Content-Range: 0-10/2
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 20 Oct 2016 07:47:42 GMT

289
[{"id":"2","creationDate":"2016-10-20 08:06:08.266","icon":"icons/profiles/profileAdmin.png","createdBy":"-1","description":"The administrator can install a process, manage the organization, and handle some errors (for example, by replaying a task).","name":"Administrator","is_default":"true","lastUpdateDate":"2016-10-20 08:06:25.531","updatedBy":"-1"},{"id":"1","creationDate":"2016-10-20 08:06:08.226","icon":"icons/profiles/profileUser.png","createdBy":"-1","description":"The user can view and perform tasks and can start a new case of a process.","name":"User","is_default":"true","lastUpdateDate":"2016-10-20 08:06:25.501","updatedBy":"-1"}]

Delete a profile

Use the DELETE method to delete an existing profile

  • URL
    /API/portal/profile/
  • Method
    DELETE
  • Success Response
    • Code: 200

ProfileEntry

Description

A profileEntry represents the association between pages and profiles. A profile is associated with a set of profileEntry items. This defines the pages that a user with this profile can access, and the menu structure that the user sees.

profileEntry 关联了用户轮廓与pages的关系。一个用户轮廓联系一组profileEntry项。profileEnry定义了用户轮廓可访问的页以及可见的菜单结构。

Identifier

Simple, the ID of the object (a long value)

Representation

{
  "id":"_profileEntry id_",
  "icon":"_icon used in the portal to represent a profileEntry_",
  "index":"_position in a menu_",
  "profile_id":"_id of the profile that contains this profileEntry_",
  "page":"_pageToken (menu name or menu item name) used in a portal menu to identify the page associated with the profileEntry_",
  "description":"_description_",
  "name":"_name of the profileEntry_",
  "type":"_link (if menu item) | folder (if menu)_",
  "isCustom":"_ true | false _",
  "parent_id":"_id or parent profileEntry if in a folder_"
}

Methods

The methods used for this resource are:

  • POST - Add a new profileEntry
  • GET - Read or search a profileEntry
  • PUT - Update a profileEntry
  • DELETE - Remove a profileEntry

ProfileMember

Description

A profileMember represents the association between the organization and profiles. In an organization we have three member_types = USER, GROUP and ROLE. You can assign a profile to a user by specifying a role, group, or specific user.

轮廓成员表示，组织和轮廓的关联。组织包含3个成员类型，USER，GROUP，ROLE。你可以通过说明role，group，或者user，把轮廓指派一个用户。

Identifier

Simple, the ID of the object (a long value)

Representation

{
  "id":"_profileMemberid_",
  "profile_id":"_id of the profile for this mapping_",
  "role_id":"_id of role, or -1 if the member type is not role_",
  "group_id":"_id of group, or -1 if the member type is not group_",
  "user_id":"_id of user, or -1 if the member type is not user_"
}

Methods

The methods used for this resource are:

  • POST - Add a new profileMember
  • GET - Search a profileMember
  • DELETE - Remove a profileMember
帮助文件中给出的发送命令格式如下：这两个反斜杠导致命令发送失败，去掉之后就正常返回结果。 

GET http://localhost:15177/bonita/API/portal/profileMember?p=0&c=10&f=member<span style="color:#ff0000;">\</span>_type%3duser&f=profile<span style="font-weight: bold; color: rgb(255, 0, 0); font-family: Arial, Helvetica, sans-serif;">\</span>_id%3d1 HTTP/1.1
Host: localhost:15177
Connection: keep-alive
Accept: application/json, text/plain, */*
X-Bonita-API-Token: 4941f6fb-b6d8-4ea0-aa73-405b9da01f2a
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
DNT: 1
Referer: http://localhost:15177/bonita/portal.js/
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=B1A651CAE491777F5514117D4D3EFE31; bonita.tenant=1; X-Bonita-API-Token=4941f6fb-b6d8-4ea0-aa73-405b9da01f2a; BOS_Locale=en

发送命令： 

GET http://localhost:15177/bonita/API/portal/profileMember?p=0&c=10&f=member_type%3duser&f=profile_id%3d1 HTTP/1.1
Host: localhost:15177
Connection: keep-alive
Accept: application/json, text/plain, */*
X-Bonita-API-Token: 4941f6fb-b6d8-4ea0-aa73-405b9da01f2a
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Maxthon/4.9.3.1000 Chrome/39.0.2146.0 Safari/537.36
DNT: 1
Referer: http://localhost:15177/bonita/portal.js/
Accept-Encoding: gzip,deflate
Accept-Language: zh-CN
Cookie: JSESSIONID=B1A651CAE491777F5514117D4D3EFE31; bonita.tenant=1; X-Bonita-API-Token=4941f6fb-b6d8-4ea0-aa73-405b9da01f2a; BOS_Locale=en

响应命令： 

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Pragma: No-cache
Cache-Control: no-cache,no-store,no-transform,max-age=0
Expires: 19    2016 12:38:57 GMT
Content-Range: 0-10/22
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 20 Oct 2016 12:38:57 GMT

2e5
[{"id":"41","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"1"},{"id":"3","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"2"},{"id":"11","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"3"},{"id":"39","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"4"},{"id":"43","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"5"},{"id":"29","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"6"},{"id":"37","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"7"},{"id":"35","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"8"},{"id":"15","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"9"},{"id":"13","profile_id":"1","role_id":"-1","group_id":"-1","user_id":"10"}]
0


Theme

Description

Use the theme resource for managing the portal and mobile app theme (look & feel).

Identifier

Simple, the ID of the object (a long value)

Methods

The methods used for this resource are:

  • POST - Change the theme
  • PUT - Restore the default theme
































 类似资料：

相关阅读

相关文章

相关问答

快捷导航： 新手教程 算法原理 架构设计 Java进阶 数据库进阶 大厂专栏 面试经验 编程笔记 编程问答 所有专题 文档资料 工具软件 电子书籍 小牛导航
在线工具： 房贷计算器 个税计算器 Linux命令查询 Json格式化 正则表达式 颜色转换 AES加解密 SHA1加密 MD5加密 毒鸡汤 字数统计 随机密码生成 进制转换 Base64编解码 励志句子
Copyright © 2019-2024 小牛知识库@xnip.cn. All Rights Reserved.