Lark Approval

https://open.larksuite.com/document/server-docs/approval-v4
Admin
Lark Approval is a comprehensive approval workflow management API that enables businesses to create,...
Tokens:4,205
Snippets:52
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /open-apis/approval/v4/instances

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Retrieves a list of approval instance IDs.

```APIDOC
## GET /open-apis/approval/v4/instances

### Description
Retrieves a list of approval instance IDs.

### Method
GET

### Endpoint
/open-apis/approval/v4/instances
```

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

### GET /open-apis/approval/v4/instances/:instance_id

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Retrieves the details of a specific approval instance.

```APIDOC
## GET /open-apis/approval/v4/instances/:instance_id

### Description
Retrieves the details of a specific approval instance by its ID.

### Method
GET

### Endpoint
/open-apis/approval/v4/instances/:instance_id

### Parameters
#### Path Parameters
- **instance_id** (string) - Required - The unique identifier of the approval instance.
```

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

### GET /open-apis/approval/v4/instances/:instance_id/comments

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Retrieves a list of comments for a specific approval instance.

```APIDOC
## GET /open-apis/approval/v4/instances/:instance_id/comments

### Description
Retrieves all comments associated with the specified approval instance.

### Method
GET

### Endpoint
/open-apis/approval/v4/instances/:instance_id/comments

### Parameters
#### Path Parameters
- **instance_id** (string) - Required - The ID of the approval instance.
```

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

### GET /open-apis/approval/v4/external_tasks

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Retrieves the status of external approval tasks.

```APIDOC
## GET /open-apis/approval/v4/external_tasks

### Description
Retrieves the current status of external approval tasks.

### Method
GET

### Endpoint
/open-apis/approval/v4/external_tasks
```

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

### POST /open-apis/approval/v4/instances

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Creates a new approval instance.

```APIDOC
## POST /open-apis/approval/v4/instances

### Description
Creates a new approval instance within the system.

### Method
POST

### Endpoint
/open-apis/approval/v4/instances
```

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

### POST /open-apis/approval/v4/external_instances

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Synchronizes an external approval instance.

```APIDOC
## POST /open-apis/approval/v4/external_instances

### Description
Synchronizes an external approval instance with the system.

### Method
POST

### Endpoint
/open-apis/approval/v4/external_instances
```

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

### POST /open-apis/approval/v4/instances/:instance_id/comments

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Creates a comment on a specific approval instance.

```APIDOC
## POST /open-apis/approval/v4/instances/:instance_id/comments

### Description
Creates a new comment for the specified approval instance.

### Method
POST

### Endpoint
/open-apis/approval/v4/instances/:instance_id/comments

### Parameters
#### Path Parameters
- **instance_id** (string) - Required - The ID of the approval instance.
```

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

### POST /open-apis/approval/v4/external_instances/check

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Validates an external approval instance.

```APIDOC
## POST /open-apis/approval/v4/external_instances/check

### Description
Performs validation checks on an external approval instance.

### Method
POST

### Endpoint
/open-apis/approval/v4/external_instances/check
```

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

### POST /open-apis/approval/v4/tasks/approve

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Approves a specific approval task.

```APIDOC
## POST /open-apis/approval/v4/tasks/approve

### Description
Approves an existing approval task.

### Method
POST

### Endpoint
/open-apis/approval/v4/tasks/approve
```

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

### 审批控件结构定义

Source: https://open.larksuite.com/document/server-docs/approval-v4/development-guide/approval-access-guide

描述审批表单中单个控件的基础属性结构，用于标识和定义控件类型。

```js
struct{
    String Id; //标识在一个审批定义中某一个控件的唯一 ID
    String CustomId; //自定义控件 ID，标识在一个审批定义中某一个控件的唯一 ID
    String Name; //该控件的名称
    String Type; //该控件的类型
} 
```

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

### POST /open-apis/approval/v4/external_approvals

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Creates a new external approval definition.

```APIDOC
## POST /open-apis/approval/v4/external_approvals

### Description
Creates a new external approval definition in the system.

### Method
POST

### Endpoint
/open-apis/approval/v4/external_approvals
```

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

### POST /open-apis/approval/v4/tasks/reject

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Rejects a specific approval task.

```APIDOC
## POST /open-apis/approval/v4/tasks/reject

### Description
Rejects an existing approval task.

### Method
POST

### Endpoint
/open-apis/approval/v4/tasks/reject
```

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

### POST /open-apis/approval/v4/instances/:instance_id/comments/remove

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Clears all comments from a specific approval instance.

```APIDOC
## POST /open-apis/approval/v4/instances/:instance_id/comments/remove

### Description
Removes all comments associated with the specified approval instance.

### Method
POST

### Endpoint
/open-apis/approval/v4/instances/:instance_id/comments/remove

### Parameters
#### Path Parameters
- **instance_id** (string) - Required - The ID of the approval instance.
```

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

### DELETE /open-apis/approval/v4/instances/:instance_id/comments/:comment_id

Source: https://open.larksuite.com/document/server-docs/approval-v4/approval-overview

Deletes a specific comment from an approval instance.

```APIDOC
## DELETE /open-apis/approval/v4/instances/:instance_id/comments/:comment_id

### Description
Deletes a specific comment identified by comment_id from the specified approval instance.

### Method
DELETE

### Endpoint
/open-apis/approval/v4/instances/:instance_id/comments/:comment_id

### Parameters
#### Path Parameters
- **instance_id** (string) - Required - The ID of the approval instance.
- **comment_id** (string) - Required - The ID of the comment to delete.
```
Tokens:
Raw