SeeyonCloud Open API

https://open.seeyoncloud.com/seeyonapi/
Admin
This project provides documentation for the SeeyonCloud Open API, offering interfaces and guidelines...
Tokens:38,766
Snippets:426
Trust Score:4.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get IsStart Method

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/77

Method to retrieve the boolean status indicating if the event has started.

```java
getIsStart | - | java.lang.Boolean | 获取isStart
```

--------------------------------

### GET Requests

Source: https://open.seeyoncloud.com/seeyonapi/842

Examples of making GET requests to retrieve data, including specifying return types and handling URL encoding.

```APIDOC
## GET Requests

Examples of making GET requests to retrieve data.

```java
// Access the interface to get member information by login name
// Expected return type is String, returning a JSON string
String json = client.get("orgMember/?loginName=" + loginName, String.class);

// Same call, returning a parsed Map
Map map = client.get("orgMember/?loginName=" + loginName, Map.class);

// Specify accept header, returning XML
String xml = client.get("flow/data/-5199818657160149985", String.class, "application/xml");

// Note: Chinese characters in the URL must be encoded
client.get("orgMembers/name/" + URLEncoder.encode("中文", "UTF-8"), String.class);
```
```

--------------------------------

### GET Request for Token with User Simulation

Source: https://open.seeyoncloud.com/seeyonapi/781

This GET request obtains a token and simulates a login for a specific user by appending the 'loginName' parameter to the URL.

```http
GET http://127.0.0.1/seeyon/rest/token/{userName}/{password}?loginName=zhangsan
```

--------------------------------

### GET Request with Login Simulation and User Agent

Source: https://open.seeyoncloud.com/seeyonapi/781

This GET request retrieves a token, simulates a user login, and specifies the client's user agent for mobile access.

```http
GET http://127.0.0.1/seeyon/rest/token/{userName}/{password}?loginName={loginName}&userAgentFrom=mobile
```

--------------------------------

### Obtain Token via GET

Source: https://open.seeyoncloud.com/seeyonapi/781

This method shows how to obtain an authentication token by sending a GET request with user credentials to the /seeyon/rest/token/{userName}/{password} endpoint.

```APIDOC
## Obtain Token via GET

### Description
Obtain an authentication token by sending a GET request with user credentials to the /seeyon/rest/token/{userName}/{password} endpoint. Ensure to set the `Accept` header to `application/json` for JSON responses.

### Method
GET

### Endpoint
/seeyon/rest/token/{userName}/{password}

### Parameters
#### Path Parameters
- **userName** (string) - Required - The REST account username.
- **password** (string) - Required - The REST account password.

#### Headers
- **Accept** (string) - Optional - Set to `application/json` to ensure JSON response format.

### Request Example
```http
GET http://127.0.0.1/seeyon/rest/token/rest/123456 HTTP/1.1
Host: 127.0.0.1
Accept: application/json
```

### Response
#### Success Response (200)
- **id** (string) - The authentication token.

#### Response Example
```json
{
  "bindingUser": null,
  "id": "a5ad648c-0a40-49b0-bedd-9fd7025313b5"
}
```
```

--------------------------------

### Meeting To-Do Generation Event Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/75

Provides methods to set and get the generated to-dos and their start status for the MeetingAffairsAssignedEvent.

```java
setAffairs | java.util.List<com.seeyon.ctp.common.po.affair.CtpAffair> | void | 设置生成的待办
```

```java
getAffairs | - | java.util.List<com.seeyon.ctp.common.po.affair.CtpAffair> | 获取生成的待办
```

```java
getIsStart | - | java.lang.Boolean | 获取是否开始
```

```java
setIsStart | java.lang.Boolean | void | 设置是否开始
```

--------------------------------

### EdocAffairsAssignedEvent - Is Start Node

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Check if the current node is the starting node. This event is triggered when document tasks are assigned.

```java
isStart()
```

--------------------------------

### Set IsStart Method

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/77

Method to set the boolean status indicating if the event has started. It takes a Boolean value.

```java
setIsStart | java.lang.Boolean | void | 设置isStart
```

--------------------------------

### EdocAffairsAssignedEvent - Set Start Node

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Set whether the current node is the starting node. This event is triggered upon the assignment of document tasks.

```java
setStart(boolean)
```

--------------------------------

### GET Authentication and Business Operations

Source: https://open.seeyoncloud.com/seeyonapi/781

This snippet shows how to obtain a REST authentication token using a GET request and then use it for subsequent business operations. It illustrates passing parameters directly in the URL for token retrieval and appending the token to subsequent request URLs.

```APIDOC
## GET /seeyon/rest/token/{restName}/{restPassword}

### Description
Obtains a REST authentication token using a GET request with username, password, and login name as URL parameters.

### Method
GET

### Endpoint
/seeyon/rest/token/{restName}/{restPassword}

### Parameters
#### Query Parameters
- **loginName** (string) - Required - The login name.

### Response
#### Success Response (200)
- **id** (string) - The authentication token.

#### Response Example
```json
{
  "id": "your_auth_token"
}
```

## GET /seeyon/rest/affair/pending/count?token={token}

### Description
Retrieves the count of pending affairs using the obtained authentication token passed as a query parameter.

### Method
GET

### Endpoint
/seeyon/rest/affair/pending/count

### Parameters
#### Query Parameters
- **token** (string) - Required - The authentication token obtained from the /token endpoint.

### Request Example
(No specific request body, query parameters are used)

### Response
#### Success Response (200)
- **count** (object) - Contains the count of pending affairs.

#### Response Example
```json
{
  "count": { ... }
}
```

## GET /seeyon/rest/affair/pending/code/{code}?token={token}

### Description
Retrieves pending affairs by code using the obtained authentication token passed as a query parameter.

### Method
GET

### Endpoint
/seeyon/rest/affair/pending/code/{code}

### Parameters
#### Path Parameters
- **code** (string) - Required - The code to filter pending affairs.
#### Query Parameters
- **token** (string) - Required - The authentication token obtained from the /token endpoint.

### Request Example
(No specific request body, path and query parameters are used)

### Response
#### Success Response (200)
- **affairs** (object) - Contains the pending affairs.

#### Response Example
```json
{
  "affairs": { ... }
}
```
```

--------------------------------

### GET Request for Token Generation

Source: https://open.seeyoncloud.com/seeyonapi/781

This GET request retrieves an authentication token. To ensure JSON format, include the 'Accept: application/json' header. The token is appended directly to the URL.

```http
GET http://127.0.0.1/seeyon/rest/token/rest/123456 HTTP/1.1
Host: 127.0.0.1
Accept: application/json
Content-Type: application/json
```

--------------------------------

### GET Request with Accept Header for JSON Response

Source: https://open.seeyoncloud.com/seeyonapi/781

To ensure a JSON response format when using GET for token retrieval, explicitly set the 'Accept: application/json' header.

```http
GET http://127.0.0.1/seeyon/rest/token/rest/123456 HTTP/1.1
```

--------------------------------

### Get Ext Summary Method

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/83

Retrieves summary information for external integrations. This method is used within the Feishu approval event context.

```java
getExtSummary | - | com.seeyon.apps.extIntegration.vo.ExtSummary | 获取待办
```

--------------------------------

### POST Requests

Source: https://open.seeyoncloud.com/seeyonapi/842

Examples of making POST requests to create new resources, including creating departments and members, and sending data as a Map or JSON string.

```APIDOC
## POST Requests

Examples of making POST requests to create new resources.

```java
// Create a new position
Map data = new HashMap() {
    {
        put("orgAccountId", 967547186016371000l);
        put("name", "Position Name");
    }
};
String post = client.post("orgDepartment", data, String.class); // Note: Do not pass null for Map data, even if empty, use `new HashMap()`

// Create a new member
Map data = new HashMap() {
    {
        put("orgAccountId", orgAccountId);
        put("name", memberName);
        put("code", "");
        put("sortId", 2);
        put("description", "");
        put("orgLevelId", levelId);
        put("orgPostId", postId);
        put("orgDepartmentId", departmentId);
        put("telNumber", "");
        put("birthday", null);
        put("officeNum", "");
        put("emailAddress", "");
        put("loginName", loginName);
    }
};
client.post("member", data, String.class);

// Sending data as a JSON string
client.post("flow/H0001",
    "{\"senderLoginName\":\"sender\",\"subject\":\"This was sent with JSON\",\"data\":\"HTML body\",\"attachments\":[-1,1]}",
    Long.class);
```

Data for creation and modification interfaces is typically sent as a Map for convenience. If you have a JSON string, you can pass it directly.
```

--------------------------------

### JSON Response with Binding User Information

Source: https://open.seeyoncloud.com/seeyonapi/781

This is an example of a JSON response that includes binding user details along with the token ID.

```json
{
  "bindingUser" : null,
  "id" : "a5ad648c-0a40-49b0-bedd-9fd7025313b5"
}
```

--------------------------------

### PUT Requests

Source: https://open.seeyoncloud.com/seeyonapi/842

Example of making a PUT request to update existing resource information, such as modifying department details.

```APIDOC
## PUT Requests

Example of making a PUT request to update existing resource information.

```java
// Modify department information
Map data = new HashMap() {
    {
        put("id", -2332227039700957764l);
        put("name", "Department Name");
    }
};
String department = client.put("orgDepartment", data, String.class); // Note: Do not pass null for Map data, even if empty, use `new HashMap()`
```
```

--------------------------------

### Java - Get CTPRestClient Instance

Source: https://open.seeyoncloud.com/seeyonapi/842

This snippet shows how to obtain an instance of the CTPRestClient for interacting with Seeyon's RESTful web services. Ensure the correct protocol, IP, and port are specified when initializing the CTPServiceClientManager.

```java
import com.seeyon.client.CTPRestClient;
import com.seeyon.client.CTPServiceClientManager;
...
// 指定协议、IP和端口，获取ClientManager
CTPServiceClientManager clientManager = CTPServiceClientManager.getInstance("http://127.0.0.1:8080");

/ 取得REST动态客户机实例
CTPRestClient client = clientManager.getRestClient();

```

--------------------------------

### DELETE Requests

Source: https://open.seeyoncloud.com/seeyonapi/842

Example of making a DELETE request to remove a resource, such as deleting a member.

```APIDOC
## DELETE Requests

Example of making a DELETE request to remove a resource.

```java
// Delete a member
client.delete("orgMember/?loginName=" + loginName, null, String.class)
```
```

--------------------------------

### Get Agent Method

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/83

Retrieves agent information. This method is common across agent-related events for accessing agent details.

```java
getAgent | - | com.seeyon.apps.agent.po.Agent | 获取Agent
```

--------------------------------

### M3OfflineInitEvent Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Provides methods to manage parameters and data for the M3OfflineInitEvent. These include getting and setting various maps and lists related to accounts, departments, members, posts, teams, and current user information.

```java
getParams
setParams
getAccountLastMap
getCurrentAccountId
setDepartmentLastMap
getDepartmentLastMap
setRelatedMemberMap
getRelatedMemberMap
setAccountLastMap
setCurrentAccountId
setPostLastMap
setTeamListMap
getMemberLastMap
getPostLastMap
setLevelLastMap
getLevelLastMap
setMemberLastMap
setCurrentUser
getTeamListMap
getCurrentUser
```

--------------------------------

### Simulate User Login for Token

Source: https://open.seeyoncloud.com/seeyonapi/781

This method allows obtaining a token by simulating a specific user's login, in addition to REST account authentication. It supports both POST and GET requests.

```APIDOC
## Simulate User Login for Token

### Description
Obtain an authentication token by simulating a specific user's login. This method requires REST account credentials and optionally accepts user identification parameters like `memberId`, `loginName`, or `memberCode`, along with `userAgentFrom` to specify the client type.

### Method
POST or GET

### Endpoint
POST: /seeyon/rest/token
GET: /seeyon/rest/token/{userName}/{password}

### Parameters
#### Request Body (POST)
- **userName** (string) - Required - The REST account username.
- **password** (string) - Required - The REST account password.
- **memberId** (string) - Optional - The ID of the user to simulate.
- **loginName** (string) - Optional - The login name of the user to simulate.
- **memberCode** (string) - Optional - The personnel code of the user to simulate.
- **userAgentFrom** (string) - Optional - The client type (e.g., 'pc', 'mobile', 'iphone').

#### Query Parameters (GET)
- **userName** (string) - Required - The REST account username.
- **password** (string) - Required - The REST account password.
- **loginName** (string) - Optional - The login name of the user to simulate.
- **userAgentFrom** (string) - Optional - The client type (e.g., 'pc', 'mobile', 'iphone').

### Request Example (POST)
```json
{
  "userName": "REST帐号",
  "password": "REST密码",
  "memberId": "用户的ID",
  "loginName": "用户的登录名",
  "code": "用户的人员编码",
  "userAgentFrom": "如pc、weixin、iphone"
}
```

### Request Example (GET)
```http
GET http://127.0.0.1/seeyon/rest/token/rest/123456?loginName=zhangsan HTTP/1.1
```

### Response
#### Success Response (200)
- **bindingUser** (string) - Information about the bound user.
- **id** (string) - The authentication token.

#### Response Example
```json
{
  "bindingUser": "...",
  "id": "013a2a1e-a0b0-4f66-b533-da0563f89c6c"
}
```
```

--------------------------------

### Get Old Agent Method

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/83

Retrieves the previous state of an agent. This is useful in update events to compare old and new configurations.

```java
getOldAgent | - | com.seeyon.apps.agent.po.Agent | 获取oldAgent
```

--------------------------------

### Update Department Role Event Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Provides methods to set and get old/new role lists and department details for the UpdateDeptRoleEvent.

```java
setOldRoleList | java.util.List<java.util.Map> | void | 设置oldRoleList
```

```java
setNewRoleList | java.util.List<java.util.Map> | void | 设置newRoleList
```

```java
getNewRoleList | - | java.util.List<java.util.Map> | 获取newRoleList
```

```java
getOldRoleList | - | java.util.List<java.util.Map> | 获取oldRoleList
```

```java
setDepartment | com.seeyon.ctp.organization.bo.V3xOrgDepartment | void | 设置department
```

```java
getDepartment | - | com.seeyon.ctp.organization.bo.V3xOrgDepartment | 获取department
```

--------------------------------

### BbsAddEvent Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/68

Provides methods to set and get the BbsArticleBO for the BbsAddEvent. This allows manipulation of the discussion article content.

```java
setBbsArticleBO | com.seeyon.apps.bbs.bo.BbsArticleBO | void | 设置bbsArticleBO
```

```java
getBbsArticleBO | - | com.seeyon.apps.bbs.bo.BbsArticleBO | 获取bbsArticleBO
```

--------------------------------

### POST Authentication and Business Operations

Source: https://open.seeyoncloud.com/seeyonapi/781

This snippet demonstrates how to obtain a REST authentication token using a POST request and then use that token to perform business operations via GET requests. It emphasizes using HTTPS and including the token in the request header for security.

```APIDOC
## POST /seeyon/rest/token

### Description
Obtains a REST authentication token using POST request with username, password, and login name.

### Method
POST

### Endpoint
/seeyon/rest/token

### Parameters
#### Request Body
- **userName** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.
- **loginName** (string) - Required - The login name.

### Request Example
```json
{
  "userName": "restName",
  "password": "restPassword",
  "loginName": "loginName"
}
```

### Response
#### Success Response (200)
- **id** (string) - The authentication token.

#### Response Example
```json
{
  "id": "your_auth_token"
}
```

## GET /seeyon/rest/affair/pending/count

### Description
Retrieves the count of pending affairs using the obtained authentication token.

### Method
GET

### Endpoint
/seeyon/rest/affair/pending/count

### Parameters
#### Request Headers
- **token** (string) - Required - The authentication token obtained from the /token endpoint.

### Request Example
(No specific request body, headers are used)

### Response
#### Success Response (200)
- **count** (object) - Contains the count of pending affairs.

#### Response Example
```json
{
  "count": { ... }
}
```
```

--------------------------------

### News Publish Listener Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/76

Provides methods to set and get the NewsDataBO for news publishing events. The setNewsDataBO method is used to configure the business object, while getNewsDataBO retrieves it.

```Java
setNewsDataBO | com.seeyon.apps.news.bo.NewsDataBO | void | 设置newsDataBO
```

```Java
getNewsDataBO | - | com.seeyon.apps.news.bo.NewsDataBO | 获取newsDataBO
```

--------------------------------

### BbsReplyEvent Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/68

Provides methods to get and set the replier's member ID and the associated article data for the BbsReplyEvent. This is useful for tracking replies and their context.

```java
getMemberId | - | java.lang.Long | 获取回复人
```

```java
setMemberId | java.lang.Long | void | 设置回复人
```

```java
setBbsArticleBO | com.seeyon.apps.bbs.bo.BbsArticleBO | void | 设置bbsArticleBO
```

```java
getBbsArticleBO | - | com.seeyon.apps.bbs.bo.BbsArticleBO | 获取bbsArticleBO
```

--------------------------------

### Task - New Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/70

Represents an event for creating a new task. Use this to get or set the task information business object.

```java
com.seeyon.apps.taskmanage.event.TaskInfoAddEvent
```

--------------------------------

### Add Post Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Represents an event triggered after a new post (position) is created. Provides methods to get and set post-related information.

```java
com.seeyon.ctp.organization.event.AddPostEvent
```

--------------------------------

### Enterprise Information Seal Synchronization Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/85

Fired when electronic signature enterprise real-name information is saved. Use to get or set enterprise configuration details.

```java
com.seeyon.apps.econtract.event.SealSynEvent
```

--------------------------------

### EdocTransferEvent Details

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Provides information about the EdocTransferEvent, used for document transfer events. It includes methods to set and get affair details and transfer destinations.

```java
com.seeyon.apps.edoc.event.EdocTransferEvent
```

--------------------------------

### Retrieve Organization Member Information via GET Request

Source: https://open.seeyoncloud.com/seeyonapi/842

Fetch organization member details by login name. The response can be parsed as a String (JSON) or a Map. Ensure URLs with Chinese characters are URL-encoded.

```java
// 访问按登录名获取人员信息的接口
// 期待的返回值类型为String，此时返回JSON串
String json = client.get("orgMember/?loginName=" + loginName, String.class);
// 同样的调用，此时将JSON解析为Map返回
Map map = client.get("orgMember/?loginName=" + loginName, Map.class);
// 此处指定了accept，返回值为xml
String xml = client.get("flow/data/-5199818657160149985" , String.class,"application/xml");
// 注意URL中的中文一定要进行编码
client.get("orgMembers/name/" + URLEncoder.encode("中文","UTF-8"), String.class);
```

--------------------------------

### Initialize and Authenticate REST Client

Source: https://open.seeyoncloud.com/seeyonapi/842

This snippet shows how to initialize the CTPRestClient and authenticate with the Seeyon server. It requires the server address and user credentials.

```Java
package com.seeyon.ctp.rest.resources;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;

import com.seeyon.client.CTPRestClient;
import com.seeyon.client.CTPServiceClientManager;

public class RestWebServiceClient {

    //REST用户登录名
    private String userName = "macx";
    //REST用户密码
    private String password = "123456";
    //定义REST动态客户机
    private CTPRestClient client = null;

    public RestWebServiceClient(){
        //取得指定服务主机的客户端管理器。
        //参数为服务主机地址，包含{协议}{Ip}:{端口}，如http://127.0.0.1:8088
        CTPServiceClientManager clientManager = CTPServiceClientManager.getInstance("http://127.0.0.1:8088");
        //取得REST动态客户机。
        client = clientManager.getRestClient();
        //登录校验,成功返回true,失败返回false,此过程并会把验证通过获取的token保存在缓存中
        //再请求访问其他资源时会自动把token放入请求header中。
        client.authenticate(userName, password);
    }

    public void testRest(){
        //URL为中文的部分要进行编码
        String loginName = URLEncoder.encode("张三", "UTF-8");
        //将当前请求绑定具体的用户
        client.bindUser(loginName);
        /*
        * get请求方式代码示例
         */

        //参数类型为QueryParam
        //根据登录名获取人员信息
        client.get("orgMember?loginName="+loginName, String.class);

        try {
            //URL为中文的部分要进行编码
            client.get("orgMember?loginName="+loginName, String.class);
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }

        //参数类型为PathParam
        //根据人员ID获取人员信息
        client.get("orgMember/-8361687019900091749", String.class);

        //参数类型为QueryParam和PathParam
        //根据人员电话号码和单位ID获取人员信息
        client.get("orgMember/telephone/15810557555?unitId=4526361456900091749", String.class);

        /*
         * put请求方式代码示例
         * 按照人员ID更新人员
         */
        Map map = new HashMap();
        map.put("id", -8361687019900091749L);
        map.put("type", 1);
        map.put("name", "macx");
        map.put("enabled", true);
        map.put("code", 8);
        map.put("orgLevelId", 2345678);
        //省略其他属性的设置
        //...
        String uri = "orgMember";
        client.put(uri, map, String.class);

        /*
         * delete请求方式代码示例
         * 按照人员ID删除人员
         */
        String url = "orgMember/-8361687019900091749";
        client.delete(url, null, String.class);

        /*
         * POST请求方式代码示例
         * 新增人员
         */
        Map beanMap = new HashMap();
        beanMap.put("id", 123456789);
        beanMap.put("orgAccountId", 1111111);
        beanMap.put("name", "macx11");
        beanMap.put("orgPostId", 9999999);
        beanMap.put("orgDepartmentId", 88888888);
        beanMap.put("orgLevelId", 23456789);
        beanMap.put("loginName", "macx11");
        //省略其他属性的设置
        //...
        String addUri = "orgMember";
        client.post(addUri, beanMap, String.class);
    }
}
```

--------------------------------

### Project Delete Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/80

Listens for events related to the deletion of projects. The listener is triggered after the project is deleted. Provides methods to get and set project IDs and phase IDs.

```java
com.seeyon.apps.project.event.ProjectDeleteEvent
```

--------------------------------

### Get Affairs Method

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/77

Method to get the affairs associated with the Office Affairs Assigned Event. It returns a list of CtpAffair objects.

```java
getAffairs | - | java.util.List<com.seeyon.ctp.common.po.affair.CtpAffair> | 获取affairs
```

--------------------------------

### Obtain Token via POST

Source: https://open.seeyoncloud.com/seeyonapi/781

This method demonstrates how to obtain an authentication token by sending a POST request with user credentials to the /seeyon/rest/token endpoint.

```APIDOC
## Obtain Token via POST

### Description
Obtain an authentication token by sending a POST request with user credentials to the /seeyon/rest/token endpoint.

### Method
POST

### Endpoint
/seeyon/rest/token

### Parameters
#### Request Body
- **userName** (string) - Required - The REST account username.
- **password** (string) - Required - The REST account password.

### Request Example
```json
{
  "userName": "rest",
  "password": "123456"
}
```

### Response
#### Success Response (200)
- **id** (string) - The authentication token.

#### Response Example
```json
{
  "id": "013a2a1e-a0b0-4f66-b533-da0563f89c6c"
}
```
```

--------------------------------

### Create New Member via POST Request

Source: https://open.seeyoncloud.com/seeyonapi/842

Create a new member with detailed information provided in a Map. Ensure the Map is not null, even if empty.

```java
// 新建人员
Map data = new HashMap() {
    {
        put("orgAccountId", orgAccountId);
        put("name", memberName);
        put("code", "");
        put("sortId", 2);
        put("description", "");
        put("orgLevelId", levelId);
        put("orgPostId", postId);
        put("orgDepartmentId", departmentId);
        put("telNumber", "");
        put("birthday", null);
        put("officeNum", "");
        put("emailAddress", "");
        put("loginName", loginName);
    }
};
client.post("member", data, String.class);
```

--------------------------------

### Create New Organization Department via POST Request

Source: https://open.seeyoncloud.com/seeyonapi/842

Create a new organization department using a Map for data. Ensure the Map is not null, even if empty.

```java
// 新建岗位
Map data = new HashMap() {
    {
        put("orgAccountId", 967547186016371000l);
        put("name", "岗位名称");
    }
};
String post = client.post("orgDepartment", data, String.class);//注意：这里的Map data 切勿传入null，及时data没有信息，也需Map data = new HashMap();
```

--------------------------------

### EdocTemplateSaveEvent Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Provides methods to get or set the template ID when a document is saved as a template.

```java
getTemplateId | - | java.lang.Long | 获取公文保存公文模板时存为的新模板的模板ID
```

```java
setTemplateId | java.lang.Long | void | 设置公文保存公文模板时存为的新模板的模板ID
```

--------------------------------

### 基于GET的认证示例

Source: https://open.seeyoncloud.com/seeyonapi/781

使用GET请求获取Rest认证Token，并将Token作为URL参数传递。适用于需要快速调用Rest接口且对安全性要求不高的场景。

```java
try
{
	/** 第一步：访问/seeyon/rest/token获取Rest认证token **/
    String url = String.format("http://127.0.0.1/seeyon/rest/token/%s/%s?loginName=%s", "restName", "restPassword", "loginName");
    HttpHeaders headers = new HttpHeaders();
    // 必须：设置内容协商为JSON，接口最终会返回JSON对象
    headers.setContentType(MediaType.APPLICATION_JSON);
    HttpEntity<String> entity = new HttpEntity<>(headers);
    ResponseEntity<Map<String, Object>> response = restTemplate.exchange(url, HttpMethod.GET, entity, new ParameterizedTypeReference<Map<String, Object>>(){});
    Map<String, Object> tokenInfo = response.getBody();
	String token = (String) tokenInfo.get("id");

	/** 第二步：访问V5的Rest开放接口，进行业务增删改查操作 **/
    String restUrl1 = "http://127.0.0.1/seeyon/rest/affair/pending/count?token=" + token;
    Map<String, Object> count = sendPostRequest(restUrl1);

	// token可以多次使用
	String restUrl2 = "http://127.0.0.1/seeyon/rest/affair/pending/code/002?token=" + token;
    Map<String, Object> count = sendGetRequest(restUrl2);
}
catch (RestClientException e)
{
	// 根据实际情况决定是否需要抛出异常或返回特定错误信息
    String error = "Rest认证不成功，可能是Rest帐号密码错误，可能是连接不上。" + e.getLocalizedMessage();
}

```

--------------------------------

### EdocSignEvent Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Provides methods to get or set the EdocSignReceipt and the send detail ID for the EdocSignEvent.

```java
getEdocSignReceipt | - | com.seeyon.v3x.edoc.domain.EdocSignReceipt | 获取老公文签收回执单据对象EdocSignReceipt
```

```java
setEdocSignReceipt | com.seeyon.v3x.edoc.domain.EdocSignReceipt | void | 设置EdocSignReceipt
```

```java
getSendDetailId | - | java.lang.Long | 获取公文发文详细ID,EdocSendDetail对象主键
```

```java
setSendDetailId | java.lang.Long | void | 设置sendDetailId
```

--------------------------------

### Create Resource via POST Request with JSON String

Source: https://open.seeyoncloud.com/seeyonapi/842

Create a resource by sending a JSON string directly in the POST request body. This is an alternative to using a Map for data.

```java
client.post("flow/H0001",
    "{\"senderLoginName\":\"sender\",\"subject\":\"这是用JSON发的\",\"data\":\"HTML正文\",\"attachments\":[-1,1]}",
    Long.class);
```

--------------------------------

### Update Level Event Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Provides methods to get and set the old and current level for the UpdateLevelEvent.

```java
getLevel | - | com.seeyon.ctp.organization.bo.V3xOrgLevel | 获取level
```

```java
setLevel | com.seeyon.ctp.organization.bo.V3xOrgLevel | void | 设置level
```

```java
setOldLevel | com.seeyon.ctp.organization.bo.V3xOrgLevel | void | 设置oldLevel
```

```java
getOldLevel | - | com.seeyon.ctp.organization.bo.V3xOrgLevel | 获取oldLevel
```

--------------------------------

### Spring Boot REST Client for Seeyon API

Source: https://open.seeyoncloud.com/seeyonapi/1956

This Spring Boot controller demonstrates how to obtain a token from the Seeyon API and then use it to call a business interface. It requires a RestTemplate and proper configuration of URLs and credentials.

```java
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import java.util.HashMap;
import java.util.Map;

/**
 * @author: 开放平台
 * @date: 2024-08-14
 * @description: 获取token并调用业务接口实现类
 */
@RestController()
@RequestMapping("/restTest")
public class RestTestController {

    @GetMapping("/test")
    public void test() throws Exception {
        // 获取token
        RestTemplate restTemplate = new RestTemplate();
        Map<String, Object> chanelBody = new HashMap<>();
        chanelBody.put("id", 397624945116616L); //根据实际情况调整
        chanelBody.put("secret", "a2bb6e04-f179-45dc-b051-ad45d9ae6c18"); //根据实际情况调整
        chanelBody.put("loginName", "xxx"); //根据实际情况调整，token绑定的人员，调用接口存在获取当前人员信息的场景下此字段必传，否则可以不用传
		chanelBody.put("dataCarried", "xxx"); //此参数在回调方法中将返回，可用于定位批次关系，建议传递类似loginName等能标识的值

        HttpEntity<Object> tokenEntity = new HttpEntity<>(chanelBody);
        String tokenUrl = "http://192.168.225.26:30581/seeyon/rest/token/channel"; //根据实际情况调整
        restTemplate.exchange(tokenUrl, HttpMethod.POST, tokenEntity, String.class);

        //调用三方互信接口
        String channelUrl = "http://192.168.225.26:30581/seeyon/rest/form/getformdata/-4707313976826705432"; //根据实际情况调整
        HttpHeaders headers = new HttpHeaders();
        headers.set("token", RestCallbackController.token);
        HttpEntity<Object> channelEntity = new HttpEntity<>(headers);
        ResponseEntity<String> channelRespose = restTemplate.exchange(channelUrl, HttpMethod.GET, channelEntity, String.class);
        System.out.println(channelRespose.getBody());

    }
}

```

--------------------------------

### CollaborationAddCommentEvent

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/71

Represents an event triggered after a comment is added. Provides methods to get and set the comment ID.

```java
com.seeyon.apps.collaboration.event.CollaborationAddCommentEvent
```

--------------------------------

### POST Request for Token with User Simulation

Source: https://open.seeyoncloud.com/seeyonapi/781

This POST request allows for obtaining a token while simulating a login for a specific user. Include user identification parameters like 'memberId', 'loginName', or 'memberCode'.

```http
POST http://127.0.0.1/seeyon/rest/token
{
"userName":"REST帐号",
"password":"REST密码",
"memberId":"用户的ID",
"loginName":"用户的登录名",
"code":"用户的人员编码",
"userAgentFrom":"如pc、weixin、iphone"
}
```

--------------------------------

### Delete Account Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

This event is triggered when an account is deleted. It provides methods to get and set the account object.

```java
com.seeyon.ctp.organization.event.DeleteAccountEvent
```

--------------------------------

### EdocAffairsAssignedEvent - Get Current Affair

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Obtain the current affair object. This event is triggered when document tasks are assigned.

```java
getCurrentAffair()
```

--------------------------------

### EdocAffairPrintEvent - Get Affairs

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Retrieve the collection of affairs designated for printing. This event is associated with the printing of document affairs.

```java
getAffairs()
```

--------------------------------

### CollaborationAffairPrintEvent

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/71

Represents an event triggered after an affair is printed. Provides methods to get and set the list of CtpAffair objects.

```java
com.seeyon.apps.collaboration.event.CollaborationAffairPrintEvent
```

--------------------------------

### Project Add Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/80

Listens for events related to the creation of new projects. The listener is triggered after the project is created.

```java
com.seeyon.apps.project.event.ProjectAddEvent
```

--------------------------------

### Update Duty Level Event Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Includes methods to get and set the old and current duty levels for the UpdateDutyLevelEvent.

```java
getOldDutyLevel | - | com.seeyon.ctp.organization.bo.V3xOrgDutyLevel | 获取oldDutyLevel
```

```java
setOldDutyLevel | com.seeyon.ctp.organization.bo.V3xOrgDutyLevel | void | 设置oldDutyLevel
```

```java
setDutyLevel | com.seeyon.ctp.organization.bo.V3xOrgDutyLevel | void | 设置dutyLevel
```

```java
getDutyLevel | - | com.seeyon.ctp.organization.bo.V3xOrgDutyLevel | 获取dutyLevel
```

--------------------------------

### URL Parameter for Token Authentication

Source: https://open.seeyoncloud.com/seeyonapi/781

This method shows how to pass the authentication token as a URL parameter. This is an alternative to including the token in the HTTP header.

```http
http://127.0.0.1/seeyon/rest/orgMember/123?token=013a2a1e-a0b0-4f66-b533-da0563f89c6c
```

--------------------------------

### Delete Post Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Represents an event triggered after a post is deleted. It offers methods to set and get the post object.

```Java
com.seeyon.ctp.organization.event.DeletePostEvent
```

--------------------------------

### Delete Department Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Represents an event triggered after a department is deleted. It provides methods to get and set the department object.

```Java
com.seeyon.ctp.organization.event.DeleteDepartmentEvent
```

--------------------------------

### CollaborationAffairsAssignedEvent

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/71

Represents an event triggered during workflow processing. Provides methods to get and set the current affair and a list of affairs.

```java
com.seeyon.apps.collaboration.event.CollaborationAffairsAssignedEvent
```

--------------------------------

### V5 Unified Todo Item Push Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/83

Handles events for unified todo items in V5. Use this to synchronize task statuses across systems.

```java
com.seeyon.apps.zhifei.event.ExtIntegrationExtendEvent
```

--------------------------------

### Add Department Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/78

Represents an event triggered after a new department is added. Provides methods to get and set the department object.

```java
com.seeyon.ctp.organization.event.AddDepartmentEvent
```

--------------------------------

### TaskInfoAddEvent Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/70

Provides methods for adding a new task.

```APIDOC
## TaskInfoAddEvent

### Description
Methods for adding a new task.

### Methods
- **getTaskInfoBO** () - com.seeyon.apps.taskmanage.bo.TaskInfoBO - Retrieves the TaskInfoBO object.
- **setTaskInfoBO** (com.seeyon.apps.taskmanage.bo.TaskInfoBO) - void - Sets the TaskInfoBO object for the new task.
```

--------------------------------

### EdocAddCommentEvent

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/73

Triggered when a comment is added to an edoc, specifically during submission or save-as-draft scenarios. It provides methods to get and set the comment ID.

```APIDOC
## EdocAddCommentEvent

### Description
This event is triggered after a comment is added to an edoc, typically during submission or when saving a draft. It allows for operations related to the newly added comment.

### Methods

#### getCommentId
- **Description**: Retrieves the ID of the newly added comment.
- **Returns**: `java.lang.Long` - The ID of the comment.

#### setCommentId
- **Parameters**:
  - **commentId** (`java.lang.Long`) - Required - The ID of the comment to set.
- **Description**: Sets the ID for the newly added comment.
- **Returns**: `void`
```

--------------------------------

### Agent New Listener Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/83

Listens for new agent creation events. Use this to manage agent lifecycle and permissions.

```java
com.seeyon.apps.agent.event.AgentAddEvent
```

--------------------------------

### CollaborationAddTrackMemberEvent

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/71

Represents an event triggered after a tracking member is added. Provides methods to get and set the affair ID and object ID.

```java
com.seeyon.apps.collaboration.event.CollaborationAddTrackMemberEvent
```

--------------------------------

### V8 Ticket Interfaces

Source: https://open.seeyoncloud.com/seeyonapi/843

A collection of interfaces for managing V8 tickets and related information.

```APIDOC
## V8 Ticket Interfaces

### Description
Provides access to V8 ticket-related functionalities, including checking tickets, retrieving domain IDs, plugin information, system variables, and member roles.

### Endpoints

#### checkTicket
- **Method**: GET (assumed)
- **Endpoint**: /interface for v8/checkTicket
- **Parameters**: 
  - **ticket** (String) - Required - The ticket to check.

#### getDomainIds
- **Method**: GET (assumed)
- **Endpoint**: /interface for v8/getDomainIds
- **Parameters**: 
  - **param1** (String) - Required
  - **param2** (Long) - Required

#### getPluginInfo
- **Method**: GET (assumed)
- **Endpoint**: /interface for v8/getPluginInfo
- **Parameters**: 
  - **param1** (String) - Required

#### getSysVarList
- **Method**: GET (assumed)
- **Endpoint**: /interface for v8/getSysVarList
- **Parameters**: 
  - **param1** (String) - Required

#### getSysByName
- **Method**: GET (assumed)
- **Endpoint**: /interface for v8/getSysByName
- **Parameters**: 
  - **param1** (String) - Required
  - **param2** (String) - Required
  - **param3** (Long) - Required

#### getMemberRoles
- **Method**: GET (assumed)
- **Endpoint**: /interface for v8/getMemberRoles
- **Parameters**: 
  - **param1** (String) - Required
  - **param2** (Long) - Required

### Response
(Specific response details for each endpoint are not provided in the source.)
```

--------------------------------

### 基于POST的认证示例（推荐）

Source: https://open.seeyoncloud.com/seeyonapi/781

使用POST请求获取Rest认证Token，并将Token放入请求头中，配合HTTPS请求以保障数据传输安全。适用于需要安全调用Rest接口的场景。

```java
try
{
	/** 第一步：访问/seeyon/rest/token获取Rest认证token **/
    String url = "https://xxx/seeyon/rest/token/";
    HttpHeaders headers = new HttpHeaders();
    // 必须：设置内容协商为JSON，接口最终会返回JSON对象
	headers.setAccept(MediaType.parseMediaTypes("application/json"));
    headers.setContentType(MediaType.APPLICATION_JSON);
	// 以POST形式发送，构建请求体
    Map<String,Object> body = new HashMap<>();
    body.put("userName","restName");
    body.put("password","restPassword");
    body.put("loginName","loginName");

    // 发送POST请求，并指定URL、请求实体和返回类型
    ResponseEntity<Map<String, Object>> response = restTemplate.exchange(
    	url,HttpMethod.POST,new HttpEntity<>(body,headers),new ParameterizedTypeReference<Map<String, Object>>() {});
    Map<String, Object> tokenInfo = response.getBody();
	String token = (String) tokenInfo.get("id");

	/** 第二步：访问V5的Rest开放接口，进行业务增删改查操作 **/
    String restUrl1 = "https://xxx/seeyon/rest/affair/pending/count";
	HttpHeaders headers1 = new HttpHeaders();
	// 必须：设置内容协商为JSON，接口最终会返回JSON对象
	headers1.setAccept(MediaType.parseMediaTypes("application/json"));
	headers1.setContentType(MediaType.APPLICATION_JSON);
	// 把token放到header中
	headers1.add("token", token);
	ResponseEntity<Map<String, Object>> response1 = restTemplate.exchange(restUrl1, HttpMethod.GET, new HttpEntity<>(headers1), new ParameterizedTypeReference<Map<String, Object>>(){});
   Map<String, Object> count = response1.getBody();
}
catch (RestClientException e)
{
	// 根据实际情况决定是否需要抛出异常或返回特定错误信息
    String error = "Rest认证不成功，可能是Rest帐号密码错误，可能是连接不上。" + e.getLocalizedMessage();
}

```

--------------------------------

### Task - Finish Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/70

Represents an event for marking a task as completed. Use this to get or set the task information business object.

```java
com.seeyon.apps.taskmanage.event.TaskInfoFinishEvent
```

--------------------------------

### Task - Delete Event

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/70

Represents an event for deleting an existing task. Use this to get or set the task information business object.

```java
com.seeyon.apps.taskmanage.event.TaskInfoDeleteEvent
```

--------------------------------

### CalEventAddEvent Methods

Source: https://open.seeyoncloud.com/seeyonapi/8.2/event/70

Provides methods for adding a new calendar event.

```APIDOC
## CalEventAddEvent

### Description
Methods for adding a new calendar event.

### Methods
- **setSharedMembers** (java.util.List<java.lang.Long>) - void - Sets the shared members for the event.
- **setCurMemberList** (java.util.List<java.lang.Long>) - void - Sets the current member list for the event.
- **setCalEventBO** (com.seeyon.apps.calendar.bo.CalEventBO) - void - Sets the CalEventBO object.
- **getCalEventBO** () - com.seeyon.apps.calendar.bo.CalEventBO - Retrieves the CalEventBO object.
- **getSharedMembers** () - java.util.List<java.lang.Long> - Retrieves the shared members.
- **getCurMemberList** () - java.util.List<java.lang.Long> - Retrieves the current member list.
```
Tokens:
Raw