Tower Open API
Tower 协作使用
GraphQL 向飞书小程序和网页版提供 API 服务。
GraphQL 相比于
REST API,其具备更加强大的数据能力和灵活性,具体可参见:
GraphQL is the better REST
通过开放 Tower GraphQL 接口能力,用户可使用 API 完成应用内大部分的数据操作,包括且不限于:成员信息查询、项目及任务的增删改查等。
API Endpoints
POST https://api.feixiang.work/graphql
身份认证
用户在使用 Tower GraphQL 之前,首先需要在 Tower 应用内获取正确的访问令牌(API Token),Tower 用户访问令牌(API Token)基于 OAuth Token 实现,具备以下特性:
- 与当前用户身份绑定
- 权限一致性
- 时效性
- 自定义作用域 scope
chart
Query
query chart($uuid: String!) {
chart(uuid: $uuid) {
aggregator
color
creator {
...MemberFragment
}
dashboard {
...DashboardFragment
}
filterBuilder {
...FilterBuilderFragment
}
groupData
name
organization {
...OrganizationFragment
}
position
settings
showValue
sourceSgids
sources {
...ChartSourceInterfaceFragment
}
type
uuid
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"chart": {
"aggregator": "abc123",
"color": "xyz789",
"creator": Member,
"dashboard": Dashboard,
"filterBuilder": FilterBuilder,
"groupData": {},
"name": "xyz789",
"organization": Organization,
"position": 123.45,
"settings": {},
"showValue": false,
"sourceSgids": ["abc123"],
"sources": [ChartSourceInterface],
"type": "abc123",
"uuid": "xyz789"
}
}
}
dashboard
Query
query dashboard($uuid: String!) {
dashboard(uuid: $uuid) {
accesses {
...VisibilityScopeIdentityInterfaceFragment
}
charts {
...ChartFragment
}
chartsCount
color
creator {
...MemberFragment
}
icon
name
organization {
...OrganizationFragment
}
uuid
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"dashboard": {
"accesses": [VisibilityScopeIdentityInterface],
"charts": [Chart],
"chartsCount": 123,
"color": "xyz789",
"creator": Member,
"icon": "abc123",
"name": "xyz789",
"organization": Organization,
"uuid": "abc123"
}
}
}
dashboards
[Dashboard!]!
名称 | 描述 |
---|---|
role -
String!
|
角色标识,edit 为「我创建的」仪表盘,read 为「分享给我的」仪表盘 |
orderByAbbr -
Boolean
|
是否按首字母升序排序,默认为 false
|
Query
query dashboards($role: String!, $orderByAbbr: Boolean) {
dashboards(role: $role, orderByAbbr: $orderByAbbr) {
accesses {
...VisibilityScopeIdentityInterfaceFragment
}
charts {
...ChartFragment
}
chartsCount
color
creator {
...MemberFragment
}
icon
name
organization {
...OrganizationFragment
}
uuid
}
}
Variables
{"role": "xyz789", "orderByAbbr": false}
Response
{
"data": {
"dashboards": [
{
"accesses": [VisibilityScopeIdentityInterface],
"charts": [Chart],
"chartsCount": 987,
"color": "abc123",
"creator": Member,
"icon": "xyz789",
"name": "abc123",
"organization": Organization,
"uuid": "xyz789"
}
]
}
}
field
Query
query field($uuid: String!) {
field(uuid: $uuid) {
attachableType
canEditMetaField
canHidden
canRemoved
columnWidth
deletedAt
hidden
key
metaField {
...MetaFieldFragment
}
position
required
sgid
uuid
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"field": {
"attachableType": "xyz789",
"canEditMetaField": false,
"canHidden": true,
"canRemoved": true,
"columnWidth": 123,
"deletedAt": ISO8601DateTime,
"hidden": false,
"key": "xyz789",
"metaField": MetaField,
"position": 123.45,
"required": true,
"sgid": "abc123",
"uuid": "abc123"
}
}
}
larkApp
Query
query larkApp($uuid: String!) {
larkApp(uuid: $uuid) {
jsapiTicket
status
uuid
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"larkApp": {"jsapiTicket": "abc123", "status": "xyz789", "uuid": "abc123"}
}
}
me
Query
query me {
me {
avatar
collaborationScenes
dateFormatPreference
departments {
...LarkDepartmentFragment
}
featureGuidePreference
fields {
...FieldFragment
}
id
isAppAdmin
isTemplateAdmin
languagePreference
larkApp {
...LarkAppFragment
}
larkUser {
...LarkUserFragment
}
name
notificationPreference
notificationUnreadCount
orderPreference
organization {
...OrganizationFragment
}
pinyin
pinyinAbbr
projectPreference
recentSearchHistory {
...SearchFragment
}
searcher {
...SearcherFragment
}
sidebarPreference
status
subscribeProductDemoEnabled
tasksViews {
...TasksViewFragment
}
teamPreference
templatePreference
uuid
workloadPreference
}
}
Response
{
"data": {
"me": {
"avatar": "abc123",
"collaborationScenes": ["abc123"],
"dateFormatPreference": "xyz789",
"departments": [LarkDepartment],
"featureGuidePreference": {},
"fields": [Field],
"id": "xyz789",
"isAppAdmin": false,
"isTemplateAdmin": false,
"languagePreference": "xyz789",
"larkApp": LarkApp,
"larkUser": LarkUser,
"name": "xyz789",
"notificationPreference": {},
"notificationUnreadCount": 987,
"orderPreference": {},
"organization": Organization,
"pinyin": "xyz789",
"pinyinAbbr": "xyz789",
"projectPreference": {},
"recentSearchHistory": [Search],
"searcher": Searcher,
"sidebarPreference": {},
"status": "abc123",
"subscribeProductDemoEnabled": true,
"tasksViews": [TasksView],
"teamPreference": {},
"templatePreference": {},
"uuid": "abc123",
"workloadPreference": {}
}
}
}
member
Query
query member($uuid: String!) {
member(uuid: $uuid) {
avatar
collaborationScenes
dateFormatPreference
departments {
...LarkDepartmentFragment
}
featureGuidePreference
fields {
...FieldFragment
}
id
isAppAdmin
isTemplateAdmin
languagePreference
larkApp {
...LarkAppFragment
}
larkUser {
...LarkUserFragment
}
name
notificationPreference
notificationUnreadCount
orderPreference
organization {
...OrganizationFragment
}
pinyin
pinyinAbbr
projectPreference
recentSearchHistory {
...SearchFragment
}
searcher {
...SearcherFragment
}
sidebarPreference
status
subscribeProductDemoEnabled
tasksViews {
...TasksViewFragment
}
teamPreference
templatePreference
uuid
workloadPreference
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"member": {
"avatar": "xyz789",
"collaborationScenes": ["abc123"],
"dateFormatPreference": "abc123",
"departments": [LarkDepartment],
"featureGuidePreference": {},
"fields": [Field],
"id": "abc123",
"isAppAdmin": true,
"isTemplateAdmin": false,
"languagePreference": "xyz789",
"larkApp": LarkApp,
"larkUser": LarkUser,
"name": "xyz789",
"notificationPreference": {},
"notificationUnreadCount": 123,
"orderPreference": {},
"organization": Organization,
"pinyin": "xyz789",
"pinyinAbbr": "abc123",
"projectPreference": {},
"recentSearchHistory": [Search],
"searcher": Searcher,
"sidebarPreference": {},
"status": "abc123",
"subscribeProductDemoEnabled": true,
"tasksViews": [TasksView],
"teamPreference": {},
"templatePreference": {},
"uuid": "abc123",
"workloadPreference": {}
}
}
}
newChart
Chart!
名称 | 描述 |
---|---|
sourceSgids -
[String!]!
|
数据源 sgid 数组 |
aggregator -
String!
|
统计项 |
groupBy -
String!
|
分组方式 |
timeGranularity -
String
|
时间颗粒度 |
conditions -
JSON
|
筛选器 |
Query
query newChart($sourceSgids: [String!]!, $aggregator: String!, $groupBy: String!, $timeGranularity: String, $conditions: JSON) {
newChart(sourceSgids: $sourceSgids, aggregator: $aggregator, groupBy: $groupBy, timeGranularity: $timeGranularity, conditions: $conditions) {
aggregator
color
creator {
...MemberFragment
}
dashboard {
...DashboardFragment
}
filterBuilder {
...FilterBuilderFragment
}
groupData
name
organization {
...OrganizationFragment
}
position
settings
showValue
sourceSgids
sources {
...ChartSourceInterfaceFragment
}
type
uuid
}
}
Variables
{
"sourceSgids": ["abc123"],
"aggregator": "xyz789",
"groupBy": "abc123",
"timeGranularity": "xyz789",
"conditions": {}
}
Response
{
"data": {
"newChart": {
"aggregator": "abc123",
"color": "xyz789",
"creator": Member,
"dashboard": Dashboard,
"filterBuilder": FilterBuilder,
"groupData": {},
"name": "xyz789",
"organization": Organization,
"position": 987.65,
"settings": {},
"showValue": false,
"sourceSgids": ["xyz789"],
"sources": [ChartSourceInterface],
"type": "abc123",
"uuid": "abc123"
}
}
}
project
Query
query project($uuid: String!) {
project(uuid: $uuid) {
accesses {
...VisibilityScopeIdentityInterfaceFragment
}
canExportTasks
category
color
createdAt
creator {
...MemberFragment
}
customFields {
...FieldInterfaceFragment
}
deletedAt
description
dueDate
dueTime
externalAccessRole
icon
id
larkChat {
...LarkChatFragment
}
latestStatusReport {
...ProjectsStatusReportFragment
}
leader {
...MemberFragment
}
metaFields {
...MetaFieldFragment
}
milestones {
...TaskFragment
}
name
notificationTypeSettings
organization {
...OrganizationFragment
}
permitLeave
public
role
scenes {
...ProjectSceneFragment
}
sections {
...SectionFragment
}
sgid
startDate
startTime
status
storyFeeds
teams {
...TeamFragment
}
unusedSystemMetaFields {
...MetaFieldFragment
}
updatedAt
uuid
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"project": {
"accesses": [VisibilityScopeIdentityInterface],
"canExportTasks": true,
"category": "xyz789",
"color": "xyz789",
"createdAt": ISO8601DateTime,
"creator": Member,
"customFields": [FieldInterface],
"deletedAt": ISO8601DateTime,
"description": "xyz789",
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"externalAccessRole": "xyz789",
"icon": "xyz789",
"id": "xyz789",
"larkChat": LarkChat,
"latestStatusReport": ProjectsStatusReport,
"leader": Member,
"metaFields": [MetaField],
"milestones": [Task],
"name": "abc123",
"notificationTypeSettings": {},
"organization": Organization,
"permitLeave": true,
"public": true,
"role": "abc123",
"scenes": [ProjectScene],
"sections": [Section],
"sgid": "abc123",
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"status": "abc123",
"storyFeeds": [StoryFeedUnion],
"teams": [Team],
"unusedSystemMetaFields": [MetaField],
"updatedAt": ISO8601DateTime,
"uuid": "xyz789"
}
}
}
projectBoardTasks
BoardTaskResult!
名称 | 描述 |
---|---|
uuid -
String!
|
项目场景 uuid |
viewUuid -
String
|
视图 uuid |
groupUuid -
String
|
分组 uuid |
groupBy -
String
|
分组方式, section 手动分组, nothing 不分组, state 按处理状态, assignee 按负责人, creator 按创建人 |
orderBy -
String
|
排序方式, position 手动排序,due_at 按截止时间, created_at 按创建时间, updated_at 按更新时间 |
orderSort -
String
|
排序顺序, ASC 升序, DESC 降序 |
filters -
JSON
|
筛选条件 |
conjunction -
String
|
|
keyword -
String
|
|
client -
String
|
|
offset -
Int
|
Default = 0 |
limit -
Int
|
分页请求,默认值为 50. Default = 50 |
hideSubtask -
Boolean
|
是否隐藏子任务 |
disableTreeView -
Boolean
|
是否关闭树状结构 |
uncollapsedUuids -
[String!]
|
|
conditions -
JSON
|
Query
query projectBoardTasks($uuid: String!, $viewUuid: String, $groupUuid: String, $groupBy: String, $orderBy: String, $orderSort: String, $filters: JSON, $conjunction: String, $keyword: String, $client: String, $offset: Int, $limit: Int, $hideSubtask: Boolean, $disableTreeView: Boolean, $uncollapsedUuids: [String!], $conditions: JSON) {
projectBoardTasks(uuid: $uuid, viewUuid: $viewUuid, groupUuid: $groupUuid, groupBy: $groupBy, orderBy: $orderBy, orderSort: $orderSort, filters: $filters, conjunction: $conjunction, keyword: $keyword, client: $client, offset: $offset, limit: $limit, hideSubtask: $hideSubtask, disableTreeView: $disableTreeView, uncollapsedUuids: $uncollapsedUuids, conditions: $conditions) {
groups {
...BoardTaskGroupFragment
}
}
}
Variables
{
"uuid": "abc123",
"viewUuid": "abc123",
"groupUuid": "xyz789",
"groupBy": "abc123",
"orderBy": "abc123",
"orderSort": "abc123",
"filters": {},
"conjunction": "xyz789",
"keyword": "xyz789",
"client": "abc123",
"offset": 0,
"limit": 50,
"hideSubtask": true,
"disableTreeView": true,
"uncollapsedUuids": ["xyz789"],
"conditions": {}
}
Response
{
"data": {
"projectBoardTasks": {"groups": [BoardTaskGroup]}
}
}
projectCalendarTasks
CalendarTaskResult!
名称 | 描述 |
---|---|
uuid -
String!
|
项目场景 uuid |
viewUuid -
String
|
视图 uuid |
groupUuid -
String
|
分组 uuid |
groupBy -
String
|
分组方式, section 手动分组, nothing 不分组, state 按处理状态, assignee 按负责人, creator 按创建人 |
orderBy -
String
|
排序方式, position 手动排序,due_at 按截止时间, created_at 按创建时间, updated_at 按更新时间 |
orderSort -
String
|
排序顺序, ASC 升序, DESC 降序 |
filters -
JSON
|
筛选条件 |
conjunction -
String
|
|
keyword -
String
|
|
client -
String
|
|
offset -
Int
|
Default = 0 |
limit -
Int
|
分页请求,默认值为 50. Default = 50 |
hideSubtask -
Boolean
|
是否隐藏子任务 |
disableTreeView -
Boolean
|
是否关闭树状结构 |
uncollapsedUuids -
[String!]
|
|
conditions -
JSON
|
|
startDate -
ISO8601Date!
|
日历开始日期 |
endDate -
ISO8601Date!
|
日历结束日期 |
Query
query projectCalendarTasks($uuid: String!, $viewUuid: String, $groupUuid: String, $groupBy: String, $orderBy: String, $orderSort: String, $filters: JSON, $conjunction: String, $keyword: String, $client: String, $offset: Int, $limit: Int, $hideSubtask: Boolean, $disableTreeView: Boolean, $uncollapsedUuids: [String!], $conditions: JSON, $startDate: ISO8601Date!, $endDate: ISO8601Date!) {
projectCalendarTasks(uuid: $uuid, viewUuid: $viewUuid, groupUuid: $groupUuid, groupBy: $groupBy, orderBy: $orderBy, orderSort: $orderSort, filters: $filters, conjunction: $conjunction, keyword: $keyword, client: $client, offset: $offset, limit: $limit, hideSubtask: $hideSubtask, disableTreeView: $disableTreeView, uncollapsedUuids: $uncollapsedUuids, conditions: $conditions, startDate: $startDate, endDate: $endDate) {
tasks {
...CalendarTaskFragment
}
}
}
Variables
{
"uuid": "abc123",
"viewUuid": "abc123",
"groupUuid": "abc123",
"groupBy": "abc123",
"orderBy": "abc123",
"orderSort": "xyz789",
"filters": {},
"conjunction": "xyz789",
"keyword": "xyz789",
"client": "xyz789",
"offset": 0,
"limit": 50,
"hideSubtask": true,
"disableTreeView": true,
"uncollapsedUuids": ["xyz789"],
"conditions": {},
"startDate": ISO8601Date,
"endDate": ISO8601Date
}
Response
{
"data": {
"projectCalendarTasks": {"tasks": [CalendarTask]}
}
}
projects
ProjectConnection!
名称 | 描述 |
---|---|
status -
String
|
项目状态,archived 归档, active 激活 |
category -
String
|
项目类型,默认值为 normal 正常项目. Default = "normal" |
after -
String
|
返回 n 条数据之后的查询结果 |
before -
String
|
返回 n 条数据之前的查询结果 |
first -
Int
|
返回前 n 条查询结果 |
last -
Int
|
返回后 n 条查询结果 |
Query
query projects($status: String, $category: String, $after: String, $before: String, $first: Int, $last: Int) {
projects(status: $status, category: $category, after: $after, before: $before, first: $first, last: $last) {
edges {
...ProjectEdgeFragment
}
nodes {
...ProjectFragment
}
pageInfo {
...PageInfoFragment
}
variables
}
}
Variables
{
"status": "abc123",
"category": "normal",
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123
}
Response
{
"data": {
"projects": {
"edges": [ProjectEdge],
"nodes": [Project],
"pageInfo": PageInfo,
"variables": {}
}
}
}
projectsAndTeams
ProjectsAndTeams!
名称 | 描述 |
---|---|
status -
String
|
项目状态,active 进行中, archived 已归档, all 所有项目 |
category -
String
|
项目类型,默认为 normal 正常. Default = "normal" |
Query
query projectsAndTeams($status: String, $category: String) {
projectsAndTeams(status: $status, category: $category) {
favoriteProjects {
...ProjectFragment
}
hasArchivedProjects
joinedTeams {
...TeamFragment
}
projectsWithoutTeam {
...ProjectFragment
}
}
}
Variables
{
"status": "xyz789",
"category": "normal"
}
Response
{
"data": {
"projectsAndTeams": {
"favoriteProjects": [Project],
"hasArchivedProjects": false,
"joinedTeams": [Team],
"projectsWithoutTeam": [Project]
}
}
}
projectScene
Query
query projectScene($uuid: String!) {
projectScene(uuid: $uuid) {
category
fields {
...FieldFragment
}
id
metaFields {
...MetaFieldFragment
}
name
onlineImport {
...OnlineImportFragment
}
position
project {
...ProjectFragment
}
sections {
...SectionFragment
}
setting
sgid
tasksViews {
...TasksViewFragment
}
tasksWorkflow {
...WorkflowFragment
}
unusedSystemMetaFields {
...MetaFieldFragment
}
uuid
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"projectScene": {
"category": "xyz789",
"fields": [Field],
"id": "abc123",
"metaFields": [MetaField],
"name": "xyz789",
"onlineImport": OnlineImport,
"position": 987.65,
"project": Project,
"sections": [Section],
"setting": ProjectSceneSettingUnion,
"sgid": "xyz789",
"tasksViews": [TasksView],
"tasksWorkflow": Workflow,
"unusedSystemMetaFields": [MetaField],
"uuid": "xyz789"
}
}
}
projectSceneTasks
ListTaskResult!
名称 | 描述 |
---|---|
uuid -
String!
|
项目场景 uuid |
viewUuid -
String
|
视图 uuid |
groupUuid -
String
|
分组 uuid |
groupBy -
String
|
分组方式, section 手动分组, nothing 不分组, state 按处理状态, assignee 按负责人, creator 按创建人 |
orderBy -
String
|
排序方式, position 手动排序,due_at 按截止时间, created_at 按创建时间, updated_at 按更新时间 |
orderSort -
String
|
排序顺序, ASC 升序, DESC 降序 |
filters -
JSON
|
筛选条件 |
conjunction -
String
|
|
keyword -
String
|
|
client -
String
|
|
offset -
Int
|
Default = 0 |
limit -
Int
|
分页请求,默认值为 50. Default = 50 |
hideSubtask -
Boolean
|
是否隐藏子任务 |
disableTreeView -
Boolean
|
是否关闭树状结构 |
uncollapsedUuids -
[String!]
|
|
conditions -
JSON
|
Query
query projectSceneTasks($uuid: String!, $viewUuid: String, $groupUuid: String, $groupBy: String, $orderBy: String, $orderSort: String, $filters: JSON, $conjunction: String, $keyword: String, $client: String, $offset: Int, $limit: Int, $hideSubtask: Boolean, $disableTreeView: Boolean, $uncollapsedUuids: [String!], $conditions: JSON) {
projectSceneTasks(uuid: $uuid, viewUuid: $viewUuid, groupUuid: $groupUuid, groupBy: $groupBy, orderBy: $orderBy, orderSort: $orderSort, filters: $filters, conjunction: $conjunction, keyword: $keyword, client: $client, offset: $offset, limit: $limit, hideSubtask: $hideSubtask, disableTreeView: $disableTreeView, uncollapsedUuids: $uncollapsedUuids, conditions: $conditions) {
groups {
...ListTaskGroupFragment
}
metricsResults {
...MetricsResultFragment
}
subtasks {
...ListSubtasksFragment
}
tasks {
...ListTaskFragment
}
totalCount
treeView
variables
}
}
Variables
{
"uuid": "xyz789",
"viewUuid": "xyz789",
"groupUuid": "xyz789",
"groupBy": "abc123",
"orderBy": "xyz789",
"orderSort": "xyz789",
"filters": {},
"conjunction": "abc123",
"keyword": "abc123",
"client": "abc123",
"offset": 0,
"limit": 50,
"hideSubtask": true,
"disableTreeView": true,
"uncollapsedUuids": ["abc123"],
"conditions": {}
}
Response
{
"data": {
"projectSceneTasks": {
"groups": [ListTaskGroup],
"metricsResults": [MetricsResult],
"subtasks": [ListSubtasks],
"tasks": [ListTask],
"totalCount": 123,
"treeView": false,
"variables": {}
}
}
}
resourceSelectIdentities
ResourceSelectOptionInterfaceConnection!
名称 | 描述 |
---|---|
keyword -
String
|
查询关键字,为空时,表示查询所有 |
scene -
String
|
|
teamUuid -
String
|
团队 uuid |
projectUuid -
String
|
项目 uuid |
excludeDepartment -
Boolean
|
排除部门,若为 true 查询结果为成员 |
onlyIncludeDepartment -
Boolean
|
仅包含部门,若为 true 查询结果为部门,与 excludeDepartment 同为 true 时,onlyIncludeDepartment 字段生效 |
excludeUuids -
[String!]
|
排除的部门或成员 uuid |
after -
String
|
返回 n 条数据之后的查询结果 |
before -
String
|
返回 n 条数据之前的查询结果 |
first -
Int
|
返回前 n 条查询结果 |
last -
Int
|
返回后 n 条查询结果 |
Query
query resourceSelectIdentities($keyword: String, $scene: String, $teamUuid: String, $projectUuid: String, $excludeDepartment: Boolean, $onlyIncludeDepartment: Boolean, $excludeUuids: [String!], $after: String, $before: String, $first: Int, $last: Int) {
resourceSelectIdentities(keyword: $keyword, scene: $scene, teamUuid: $teamUuid, projectUuid: $projectUuid, excludeDepartment: $excludeDepartment, onlyIncludeDepartment: $onlyIncludeDepartment, excludeUuids: $excludeUuids, after: $after, before: $before, first: $first, last: $last) {
edges {
...ResourceSelectOptionInterfaceEdgeFragment
}
nodes {
...ResourceSelectOptionInterfaceFragment
}
pageInfo {
...PageInfoFragment
}
}
}
Variables
{
"keyword": "abc123",
"scene": "xyz789",
"teamUuid": "abc123",
"projectUuid": "abc123",
"excludeDepartment": false,
"onlyIncludeDepartment": true,
"excludeUuids": ["abc123"],
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123
}
Response
{
"data": {
"resourceSelectIdentities": {
"edges": [ResourceSelectOptionInterfaceEdge],
"nodes": [ResourceSelectOptionInterface],
"pageInfo": PageInfo
}
}
}
resourceSelectLarkCalendars
Query
query resourceSelectLarkCalendars {
resourceSelectLarkCalendars {
calendarId
description
summary
}
}
Response
{
"data": {
"resourceSelectLarkCalendars": [
{"calendarId": "abc123", "description": "abc123", "summary": "xyz789"}
]
}
}
task
Query
query task($uuid: String!) {
task(uuid: $uuid) {
ancestors {
...TaskFragment
}
assignee {
...MemberFragment
}
category
collaborators {
...VisibilityScopeIdentityInterfaceFragment
}
completeStatus
completedAt
completer {
...MemberFragment
}
coverImageAttachment {
...AttachmentFragment
}
createdAt
creator {
...MemberFragment
}
customFields {
...FieldInterfaceFragment
}
deletedAt
dependencies {
...TasksDependencyFragment
}
description
dueDate
dueTime
editor {
...MemberFragment
}
followUpDependencies {
...TasksDependencyFragment
}
followUpDescendants {
...TaskFragment
}
id
isAssigneeRead
isCollaborator
keyMarks
larkChat {
...LarkChatFragment
}
larkFiles {
...LarkFileFragment
}
metaFields {
...MetaFieldFragment
}
parent {
...TaskFragment
}
persisted
projects {
...ProjectFragment
}
reactions {
...ReactionFragment
}
reactors {
...MemberFragment
}
repetition {
...RepetitionFragment
}
role
scenes {
...ProjectSceneFragment
}
sections {
...SectionFragment
}
sgid
startDate
startTime
state {
...StateFragment
}
storyFeeds
subtasks {
...TaskFragment
}
tasksProjects {
...ProjectTaskFragment
}
title
uniqueId
updatedAt
uuid
workflow {
...WorkflowFragment
}
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"task": {
"ancestors": [Task],
"assignee": Member,
"category": "abc123",
"collaborators": [VisibilityScopeIdentityInterface],
"completeStatus": "abc123",
"completedAt": ISO8601DateTime,
"completer": Member,
"coverImageAttachment": Attachment,
"createdAt": ISO8601DateTime,
"creator": Member,
"customFields": [FieldInterface],
"deletedAt": ISO8601DateTime,
"dependencies": [TasksDependency],
"description": "xyz789",
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"editor": Member,
"followUpDependencies": [TasksDependency],
"followUpDescendants": [Task],
"id": "xyz789",
"isAssigneeRead": false,
"isCollaborator": false,
"keyMarks": {},
"larkChat": LarkChat,
"larkFiles": [LarkFile],
"metaFields": [MetaField],
"parent": Task,
"persisted": true,
"projects": [Project],
"reactions": [Reaction],
"reactors": [Member],
"repetition": Repetition,
"role": "xyz789",
"scenes": [ProjectScene],
"sections": [Section],
"sgid": "xyz789",
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"state": State,
"storyFeeds": [StoryFeedUnion],
"subtasks": [Task],
"tasksProjects": [ProjectTask],
"title": "xyz789",
"uniqueId": 123,
"updatedAt": ISO8601DateTime,
"uuid": "xyz789",
"workflow": Workflow
}
}
}
tasksViewByMember
Query
query tasksViewByMember($uuid: String!, $quickFilterTerm: String) {
tasksViewByMember(uuid: $uuid, quickFilterTerm: $quickFilterTerm) {
category
creator {
...MemberFragment
}
deletedAt
displayMode
fieldsColumns {
...FieldsColumnFragment
}
filterBuilder {
...FilterBuilderFragment
}
name
persisted
selected
sgid
uuid
}
}
Variables
{"uuid": "abc123", "quickFilterTerm": "xyz789"}
Response
{
"data": {
"tasksViewByMember": {
"category": "xyz789",
"creator": Member,
"deletedAt": ISO8601DateTime,
"displayMode": "xyz789",
"fieldsColumns": [FieldsColumn],
"filterBuilder": FilterBuilder,
"name": "abc123",
"persisted": false,
"selected": true,
"sgid": "xyz789",
"uuid": "xyz789"
}
}
}
tasksViewByProjectsScene
Query
query tasksViewByProjectsScene($uuid: String!, $quickFilterTerm: String) {
tasksViewByProjectsScene(uuid: $uuid, quickFilterTerm: $quickFilterTerm) {
category
creator {
...MemberFragment
}
deletedAt
displayMode
fieldsColumns {
...FieldsColumnFragment
}
filterBuilder {
...FilterBuilderFragment
}
name
persisted
selected
sgid
uuid
}
}
Variables
{"uuid": "xyz789", "quickFilterTerm": "xyz789"}
Response
{
"data": {
"tasksViewByProjectsScene": {
"category": "xyz789",
"creator": Member,
"deletedAt": ISO8601DateTime,
"displayMode": "xyz789",
"fieldsColumns": [FieldsColumn],
"filterBuilder": FilterBuilder,
"name": "abc123",
"persisted": false,
"selected": true,
"sgid": "abc123",
"uuid": "xyz789"
}
}
}
tasksViewBySearch
Query
query tasksViewBySearch($uuid: String!, $quickFilterTerm: String) {
tasksViewBySearch(uuid: $uuid, quickFilterTerm: $quickFilterTerm) {
category
creator {
...MemberFragment
}
deletedAt
displayMode
fieldsColumns {
...FieldsColumnFragment
}
filterBuilder {
...FilterBuilderFragment
}
name
persisted
selected
sgid
uuid
}
}
Variables
{"uuid": "abc123", "quickFilterTerm": "abc123"}
Response
{
"data": {
"tasksViewBySearch": {
"category": "xyz789",
"creator": Member,
"deletedAt": ISO8601DateTime,
"displayMode": "xyz789",
"fieldsColumns": [FieldsColumn],
"filterBuilder": FilterBuilder,
"name": "abc123",
"persisted": false,
"selected": true,
"sgid": "xyz789",
"uuid": "xyz789"
}
}
}
tasksWorkflow
Query
query tasksWorkflow($uuid: String!) {
tasksWorkflow(uuid: $uuid) {
asTemplate
category
default
deletedAt
key
name
projects {
...ProjectFragment
}
sgid
states {
...StateFragment
}
templateKey
uuid
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"tasksWorkflow": {
"asTemplate": true,
"category": "xyz789",
"default": true,
"deletedAt": ISO8601DateTime,
"key": "abc123",
"name": "xyz789",
"projects": [Project],
"sgid": "abc123",
"states": [State],
"templateKey": "abc123",
"uuid": "xyz789"
}
}
}
team
Query
query team($uuid: String!) {
team(uuid: $uuid) {
createdAt
creator {
...MemberFragment
}
deletedAt
fields {
...FieldFragment
}
filterBuilder {
...FilterBuilderFragment
}
leader {
...MemberFragment
}
name
organization {
...OrganizationFragment
}
permitLeave
position
projects {
...ProjectFragment
}
public
sgid
teammates {
...VisibilityScopeIdentityInterfaceFragment
}
uuid
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"team": {
"createdAt": ISO8601DateTime,
"creator": Member,
"deletedAt": ISO8601DateTime,
"fields": [Field],
"filterBuilder": FilterBuilder,
"leader": Member,
"name": "xyz789",
"organization": Organization,
"permitLeave": true,
"position": 987.65,
"projects": [Project],
"public": false,
"sgid": "abc123",
"teammates": [VisibilityScopeIdentityInterface],
"uuid": "xyz789"
}
}
}
teamProjects
ProjectConnection!
名称 | 描述 |
---|---|
uuid -
String!
|
任务流程 uuid |
orderBy -
String
|
排序方式, position 手动排序,name 按项目名称, latest_status 按最新状态, due_at 按截止时间, leader_id 按负责人 |
orderSort -
String
|
暂未启用 |
quickFilterTerm -
String
|
筛选项, active_projects 进行中的, archived_projects 已归档的, all_projects 所有项目 |
after -
String
|
返回 n 条数据之后的查询结果 |
before -
String
|
返回 n 条数据之前的查询结果 |
first -
Int
|
返回前 n 条查询结果 |
last -
Int
|
返回后 n 条查询结果 |
Query
query teamProjects($uuid: String!, $orderBy: String, $orderSort: String, $quickFilterTerm: String, $after: String, $before: String, $first: Int, $last: Int) {
teamProjects(uuid: $uuid, orderBy: $orderBy, orderSort: $orderSort, quickFilterTerm: $quickFilterTerm, after: $after, before: $before, first: $first, last: $last) {
edges {
...ProjectEdgeFragment
}
nodes {
...ProjectFragment
}
pageInfo {
...PageInfoFragment
}
variables
}
}
Variables
{
"uuid": "xyz789",
"orderBy": "xyz789",
"orderSort": "abc123",
"quickFilterTerm": "xyz789",
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 987
}
Response
{
"data": {
"teamProjects": {
"edges": [ProjectEdge],
"nodes": [Project],
"pageInfo": PageInfo,
"variables": {}
}
}
}
teamsWorkloads
WorkloadConnection!
名称 | 描述 |
---|---|
uuid -
String!
|
项目组 uuid |
orderBy -
String
|
排序方式, pending 按待处理, in_progress 按正在处理, upcoming 按即将逾期, delayed 按已逾期 |
after -
String
|
返回 n 条数据之后的查询结果 |
before -
String
|
返回 n 条数据之前的查询结果 |
first -
Int
|
返回前 n 条查询结果 |
last -
Int
|
返回后 n 条查询结果 |
Query
query teamsWorkloads($uuid: String!, $orderBy: String, $after: String, $before: String, $first: Int, $last: Int) {
teamsWorkloads(uuid: $uuid, orderBy: $orderBy, after: $after, before: $before, first: $first, last: $last) {
edges {
...WorkloadEdgeFragment
}
nodes {
...WorkloadFragment
}
pageInfo {
...PageInfoFragment
}
variables
}
}
Variables
{
"uuid": "xyz789",
"orderBy": "abc123",
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 987
}
Response
{
"data": {
"teamsWorkloads": {
"edges": [WorkloadEdge],
"nodes": [Workload],
"pageInfo": PageInfo,
"variables": {}
}
}
}
addDashboardAccesses
AddDashboardAccessesMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
仪表盘 uuid |
accessSgids -
[String!]
|
成员/部门的 sgid 数组 |
Query
mutation addDashboardAccesses($uuid: String!, $accessSgids: [String!]) {
addDashboardAccesses(uuid: $uuid, accessSgids: $accessSgids) {
dashboard {
...DashboardFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"uuid": "abc123", "accessSgids": ["abc123"]}
Response
{
"data": {
"addDashboardAccesses": {
"dashboard": Dashboard,
"errors": [BaseError]
}
}
}
addProjectAccesses
AddProjectAccessesMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目 uuid |
accessSgids -
[String!]
|
部门或成员 sgids |
role -
String
|
部门或成员访问项目的权限, edit 编辑, remark 仅讨论 |
Query
mutation addProjectAccesses($uuid: String!, $accessSgids: [String!], $role: String) {
addProjectAccesses(uuid: $uuid, accessSgids: $accessSgids, role: $role) {
errors {
...BaseErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"uuid": "abc123", "accessSgids": ["abc123"], "role": "xyz789"}
Response
{
"data": {
"addProjectAccesses": {
"errors": [BaseError],
"project": Project
}
}
}
addTaskDependency
Query
mutation addTaskDependency($uuid: String!, $dependentUuid: String!) {
addTaskDependency(uuid: $uuid, dependentUuid: $dependentUuid) {
errors {
...BaseErrorFragment
}
tasksDependency {
...TasksDependencyFragment
}
}
}
Variables
{"uuid": "xyz789", "dependentUuid": "abc123"}
Response
{
"data": {
"addTaskDependency": {
"errors": [BaseError],
"tasksDependency": TasksDependency
}
}
}
addTaskToScene
AddTaskToSceneMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
sceneUuid -
String!
|
场景 uuid |
sectionUuid -
String
|
分组 uuid |
Query
mutation addTaskToScene($uuid: String!, $sceneUuid: String!, $sectionUuid: String) {
addTaskToScene(uuid: $uuid, sceneUuid: $sceneUuid, sectionUuid: $sectionUuid) {
conflictScene {
...ConflictSceneFragment
}
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"uuid": "abc123", "sceneUuid": "abc123", "sectionUuid": "xyz789"}
Response
{
"data": {
"addTaskToScene": {
"conflictScene": ConflictScene,
"errors": [BaseError],
"task": Task
}
}
}
addTeammates
AddTeammatesMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目组 uuid |
teammateSgids -
[String!]
|
成员 sgid ,支持部门或成员 |
Query
mutation addTeammates($uuid: String!, $teammateSgids: [String!]) {
addTeammates(uuid: $uuid, teammateSgids: $teammateSgids) {
errors {
...BaseErrorFragment
}
team {
...TeamFragment
}
}
}
Variables
{"uuid": "xyz789", "teammateSgids": ["xyz789"]}
Response
{
"data": {
"addTeammates": {
"errors": [BaseError],
"team": Team
}
}
}
addTeamProjects
Query
mutation addTeamProjects($uuid: String!, $projectUuids: [String!]) {
addTeamProjects(uuid: $uuid, projectUuids: $projectUuids) {
errors {
...BaseErrorFragment
}
team {
...TeamFragment
}
}
}
Variables
{"uuid": "xyz789", "projectUuids": ["xyz789"]}
Response
{
"data": {
"addTeamProjects": {
"errors": [BaseError],
"team": Team
}
}
}
createChart
CreateChartMutationPayload
名称 | 描述 |
---|---|
dashboardUuid -
String!
|
仪表盘 uuid |
name -
String
|
名称 |
type -
String!
|
图表类型,如下所示
|
color -
String
|
颜色 |
showValue -
Boolean
|
图表中是否显示数据 |
template -
String
|
|
sourceSgids -
[String!]!
|
数据源 sgid 数组 |
aggregator -
String!
|
统计项 |
groupBy -
String!
|
分组方式 |
timeGranularity -
String
|
时间颗粒度 |
conditions -
JSON
|
筛选器 |
Query
mutation createChart($dashboardUuid: String!, $name: String, $type: String!, $color: String, $showValue: Boolean, $template: String, $sourceSgids: [String!]!, $aggregator: String!, $groupBy: String!, $timeGranularity: String, $conditions: JSON) {
createChart(dashboardUuid: $dashboardUuid, name: $name, type: $type, color: $color, showValue: $showValue, template: $template, sourceSgids: $sourceSgids, aggregator: $aggregator, groupBy: $groupBy, timeGranularity: $timeGranularity, conditions: $conditions) {
chart {
...ChartFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{
"dashboardUuid": "xyz789",
"name": "abc123",
"type": "abc123",
"color": "abc123",
"showValue": false,
"template": "xyz789",
"sourceSgids": ["xyz789"],
"aggregator": "abc123",
"groupBy": "abc123",
"timeGranularity": "abc123",
"conditions": {}
}
Response
{
"data": {
"createChart": {
"chart": Chart,
"errors": [BaseError]
}
}
}
createChartSearch
CreateChartSearchMutationPayload
名称 | 描述 |
---|---|
name -
String
|
搜索名称 |
uuid -
String!
|
图表 uuid |
groupUuid -
String!
|
图表分组 uuid |
Query
mutation createChartSearch($name: String, $uuid: String!, $groupUuid: String!) {
createChartSearch(name: $name, uuid: $uuid, groupUuid: $groupUuid) {
errors {
...BaseErrorFragment
}
search {
...SearchFragment
}
}
}
Variables
{"name": "abc123", "uuid": "abc123", "groupUuid": "abc123"}
Response
{
"data": {
"createChartSearch": {
"errors": [BaseError],
"search": Search
}
}
}
createDashboard
Query
mutation createDashboard($name: String!, $color: String, $icon: String) {
createDashboard(name: $name, color: $color, icon: $icon) {
dashboard {
...DashboardFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"name": "xyz789", "color": "xyz789", "icon": "xyz789"}
Response
{
"data": {
"createDashboard": {
"dashboard": Dashboard,
"errors": [BaseError]
}
}
}
createField
CreateFieldMutationPayload
名称 | 描述 |
---|---|
attachableSgid -
String!
|
|
key -
String
|
字段 key |
name -
String
|
字段名称 |
description -
String
|
字段描述 |
public -
Boolean
|
是否公开 |
required -
Boolean
|
是否必填 |
inputType -
String
|
字段类型 |
settings -
JSON
|
|
asTemplate -
Boolean
|
是否添加为模版 |
Query
mutation createField($attachableSgid: String!, $key: String, $name: String, $description: String, $public: Boolean, $required: Boolean, $inputType: String, $settings: JSON, $asTemplate: Boolean) {
createField(attachableSgid: $attachableSgid, key: $key, name: $name, description: $description, public: $public, required: $required, inputType: $inputType, settings: $settings, asTemplate: $asTemplate) {
errors {
...BaseErrorFragment
}
field {
...FieldFragment
}
}
}
Variables
{
"attachableSgid": "abc123",
"key": "xyz789",
"name": "xyz789",
"description": "xyz789",
"public": true,
"required": true,
"inputType": "abc123",
"settings": {},
"asTemplate": false
}
Response
{
"data": {
"createField": {
"errors": [BaseError],
"field": Field
}
}
}
createLarkCalendar
Query
mutation createLarkCalendar($summary: String!) {
createLarkCalendar(summary: $summary) {
errors {
...BaseErrorFragment
}
larkCalendar {
...LarkCalendarFragment
}
}
}
Variables
{"summary": "abc123"}
Response
{
"data": {
"createLarkCalendar": {
"errors": [BaseError],
"larkCalendar": LarkCalendar
}
}
}
createLarkCalendarEvent
CreateLarkCalendarEventMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
larkCalendarId -
String!
|
飞书日历 ID |
Query
mutation createLarkCalendarEvent($uuid: String!, $larkCalendarId: String!) {
createLarkCalendarEvent(uuid: $uuid, larkCalendarId: $larkCalendarId) {
errors {
...BaseErrorFragment
}
larkCalendarEvent {
...LarkCalendarEventFragment
}
}
}
Variables
{"uuid": "abc123", "larkCalendarId": "abc123"}
Response
{
"data": {
"createLarkCalendarEvent": {
"errors": [BaseError],
"larkCalendarEvent": LarkCalendarEvent
}
}
}
createLarkFile
CreateLarkFileMutationPayload
名称 | 描述 |
---|---|
uuid -
String
|
任务 uuid |
category -
String!
|
文件类型 |
name -
String!
|
文件名 |
metadata -
JSON
|
文件 meta |
Query
mutation createLarkFile($uuid: String, $category: String!, $name: String!, $metadata: JSON) {
createLarkFile(uuid: $uuid, category: $category, name: $name, metadata: $metadata) {
errors {
...BaseErrorFragment
}
larkFile {
...LarkFileFragment
}
task {
...TaskFragment
}
}
}
Variables
{
"uuid": "abc123",
"category": "abc123",
"name": "abc123",
"metadata": {}
}
Response
{
"data": {
"createLarkFile": {
"errors": [BaseError],
"larkFile": LarkFile,
"task": Task
}
}
}
createMemberTask
CreateMemberTaskMutationPayload
名称 | 描述 |
---|---|
title -
String!
|
任务标题 |
description -
String
|
任务描述 |
startDate -
ISO8601DateTime
|
开始日期 |
startTime -
ISO8601DateTime
|
开始时间 |
dueDate -
ISO8601DateTime
|
截止日期 |
dueTime -
ISO8601DateTime
|
截止时间 |
assigneeUuid -
String
|
负责人 uuid |
files -
JSON
|
附件 |
customFieldValues -
JSON
|
自定义字段 |
projectUuids -
[String!]
|
所属项目 uuid |
sceneUuids -
[String!]
|
所属项目场景 uuid |
parentUuid -
String
|
父任务 uuid |
prevTaskId -
String
|
前置任务 uuid |
repetition -
JSON
|
循环设置 |
sceneUuid -
String
|
场景 uuid |
sectionUuid -
String
|
分组 uuid |
Query
mutation createMemberTask($title: String!, $description: String, $startDate: ISO8601DateTime, $startTime: ISO8601DateTime, $dueDate: ISO8601DateTime, $dueTime: ISO8601DateTime, $assigneeUuid: String, $files: JSON, $customFieldValues: JSON, $projectUuids: [String!], $sceneUuids: [String!], $parentUuid: String, $prevTaskId: String, $repetition: JSON, $sceneUuid: String, $sectionUuid: String) {
createMemberTask(title: $title, description: $description, startDate: $startDate, startTime: $startTime, dueDate: $dueDate, dueTime: $dueTime, assigneeUuid: $assigneeUuid, files: $files, customFieldValues: $customFieldValues, projectUuids: $projectUuids, sceneUuids: $sceneUuids, parentUuid: $parentUuid, prevTaskId: $prevTaskId, repetition: $repetition, sceneUuid: $sceneUuid, sectionUuid: $sectionUuid) {
conflictScenes {
...ProjectSceneFragment
}
errors {
...BaseErrorFragment
}
section {
...SectionFragment
}
task {
...TaskFragment
}
}
}
Variables
{
"title": "abc123",
"description": "abc123",
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"assigneeUuid": "xyz789",
"files": {},
"customFieldValues": {},
"projectUuids": ["abc123"],
"sceneUuids": ["xyz789"],
"parentUuid": "xyz789",
"prevTaskId": "xyz789",
"repetition": {},
"sceneUuid": "abc123",
"sectionUuid": "xyz789"
}
Response
{
"data": {
"createMemberTask": {
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"section": Section,
"task": Task
}
}
}
createProject
CreateProjectMutationPayload
名称 | 描述 |
---|---|
name -
String!
|
项目名称 |
color -
String
|
项目颜色,目前支持 blue,red,green,orange,pink,lightblue,teal,lime, purple,grey,orchird,brown |
icon -
String
|
|
teamUuids -
[String!]
|
项目组 uuid |
public -
Boolean
|
是否设置为公开项目 |
asTemplate -
Boolean
|
是否添加为模版 |
templateUuid -
String
|
项目模板 uuid ,若填写,则使用模板创建新项目 |
initLarkChat -
Boolean
|
Query
mutation createProject($name: String!, $color: String, $icon: String, $teamUuids: [String!], $public: Boolean, $asTemplate: Boolean, $templateUuid: String, $initLarkChat: Boolean) {
createProject(name: $name, color: $color, icon: $icon, teamUuids: $teamUuids, public: $public, asTemplate: $asTemplate, templateUuid: $templateUuid, initLarkChat: $initLarkChat) {
errors {
...BaseErrorFragment
}
projectCreation {
...ProjectCreationFragment
}
}
}
Variables
{
"name": "abc123",
"color": "abc123",
"icon": "xyz789",
"teamUuids": ["xyz789"],
"public": false,
"asTemplate": true,
"templateUuid": "xyz789",
"initLarkChat": true
}
Response
{
"data": {
"createProject": {
"errors": [BaseError],
"projectCreation": ProjectCreation
}
}
}
createProjectScene
CreateProjectSceneMutationPayload
名称 | 描述 |
---|---|
projectUuid -
String!
|
项目 uui |
workflowUuid -
String!
|
任务流程 uuid |
name -
String!
|
场景名 |
Query
mutation createProjectScene($projectUuid: String!, $workflowUuid: String!, $name: String!) {
createProjectScene(projectUuid: $projectUuid, workflowUuid: $workflowUuid, name: $name) {
errors {
...BaseErrorFragment
}
projectScene {
...ProjectSceneFragment
}
}
}
Variables
{"projectUuid": "xyz789", "workflowUuid": "abc123", "name": "xyz789"}
Response
{
"data": {
"createProjectScene": {
"errors": [BaseError],
"projectScene": ProjectScene
}
}
}
createProjectSceneTaskGroup
CreateProjectSceneTaskGroupMutationPayload
名称 | 描述 |
---|---|
groupBy -
String!
|
分组方式,固定值为 section ,即按手动分组 |
projectSceneUuid -
String!
|
项目场景 uuid |
resource -
JSON!
|
资源,固定传字段 name ,表示分组名称 |
prevGroupUuid -
String
|
上一个分组 uuid |
Query
mutation createProjectSceneTaskGroup($groupBy: String!, $projectSceneUuid: String!, $resource: JSON!, $prevGroupUuid: String) {
createProjectSceneTaskGroup(groupBy: $groupBy, projectSceneUuid: $projectSceneUuid, resource: $resource, prevGroupUuid: $prevGroupUuid) {
errors {
...BaseErrorFragment
}
group {
...ListTaskGroupFragment
}
}
}
Variables
{
"groupBy": "abc123",
"projectSceneUuid": "abc123",
"resource": {},
"prevGroupUuid": "abc123"
}
Response
{
"data": {
"createProjectSceneTaskGroup": {
"errors": [BaseError],
"group": ListTaskGroup
}
}
}
createProjectsStatusReport
CreateProjectsStatusReportMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目 uuid |
status -
String!
|
项目状态, on_track 正常, at_risk 低风险, off_track 高风险 |
title -
String!
|
报告标题 |
summary -
String
|
报告描述 |
Query
mutation createProjectsStatusReport($uuid: String!, $status: String!, $title: String!, $summary: String) {
createProjectsStatusReport(uuid: $uuid, status: $status, title: $title, summary: $summary) {
errors {
...BaseErrorFragment
}
statusReport {
...ProjectsStatusReportFragment
}
}
}
Variables
{"uuid": "xyz789", "status": "abc123", "title": "xyz789", "summary": "xyz789"}
Response
{
"data": {
"createProjectsStatusReport": {
"errors": [BaseError],
"statusReport": ProjectsStatusReport
}
}
}
createProjectTask
CreateProjectTaskMutationPayload
名称 | 描述 |
---|---|
title -
String!
|
任务标题 |
description -
String
|
任务描述 |
startDate -
ISO8601DateTime
|
开始日期 |
startTime -
ISO8601DateTime
|
开始时间 |
dueDate -
ISO8601DateTime
|
截止日期 |
dueTime -
ISO8601DateTime
|
截止时间 |
assigneeUuid -
String
|
负责人 uuid |
files -
JSON
|
附件 |
customFieldValues -
JSON
|
自定义字段 |
projectUuids -
[String!]
|
所属项目 uuid |
sceneUuids -
[String!]
|
所属项目场景 uuid |
parentUuid -
String
|
父任务 uuid |
prevTaskId -
String
|
前置任务 uuid |
repetition -
JSON
|
循环设置 |
projectUuid -
String
|
所属项目 uuid |
sceneUuid -
String!
|
场景 uuid |
sectionUuid -
String
|
分组 uuid |
stateUuid -
String
|
任务状态 uuid,可通过「task」查询结果中的「state」字段获得 |
category -
String
|
类型, normal 任务, milestone 里程碑 |
Query
mutation createProjectTask($title: String!, $description: String, $startDate: ISO8601DateTime, $startTime: ISO8601DateTime, $dueDate: ISO8601DateTime, $dueTime: ISO8601DateTime, $assigneeUuid: String, $files: JSON, $customFieldValues: JSON, $projectUuids: [String!], $sceneUuids: [String!], $parentUuid: String, $prevTaskId: String, $repetition: JSON, $projectUuid: String, $sceneUuid: String!, $sectionUuid: String, $stateUuid: String, $category: String) {
createProjectTask(title: $title, description: $description, startDate: $startDate, startTime: $startTime, dueDate: $dueDate, dueTime: $dueTime, assigneeUuid: $assigneeUuid, files: $files, customFieldValues: $customFieldValues, projectUuids: $projectUuids, sceneUuids: $sceneUuids, parentUuid: $parentUuid, prevTaskId: $prevTaskId, repetition: $repetition, projectUuid: $projectUuid, sceneUuid: $sceneUuid, sectionUuid: $sectionUuid, stateUuid: $stateUuid, category: $category) {
conflictScenes {
...ProjectSceneFragment
}
errors {
...BaseErrorFragment
}
section {
...SectionFragment
}
task {
...TaskFragment
}
}
}
Variables
{
"title": "abc123",
"description": "abc123",
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"assigneeUuid": "abc123",
"files": {},
"customFieldValues": {},
"projectUuids": ["abc123"],
"sceneUuids": ["abc123"],
"parentUuid": "xyz789",
"prevTaskId": "abc123",
"repetition": {},
"projectUuid": "abc123",
"sceneUuid": "abc123",
"sectionUuid": "abc123",
"stateUuid": "xyz789",
"category": "abc123"
}
Response
{
"data": {
"createProjectTask": {
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"section": Section,
"task": Task
}
}
}
createReaction
Query
mutation createReaction($id: String!) {
createReaction(id: $id) {
errors {
...BaseErrorFragment
}
reactable {
...ReactableInterfaceFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"createReaction": {
"errors": [BaseError],
"reactable": ReactableInterface
}
}
}
createRemark
Query
mutation createRemark($resourceSgid: String!, $content: String!) {
createRemark(resourceSgid: $resourceSgid, content: $content) {
errors {
...BaseErrorFragment
}
remark {
...RemarkFragment
}
resource
}
}
Variables
{"resourceSgid": "abc123", "content": "xyz789"}
Response
{
"data": {
"createRemark": {
"errors": [BaseError],
"remark": Remark,
"resource": RemarkResourceUnion
}
}
}
createSearch
CreateSearchMutationPayload
名称 | 描述 |
---|---|
keyword -
String!
|
搜索关键字 |
pageName -
String
|
页面名称 |
pageUuid -
String
|
页面 uuid ,项目页面搜索时填写项目场景 uuid |
Query
mutation createSearch($keyword: String!, $pageName: String, $pageUuid: String) {
createSearch(keyword: $keyword, pageName: $pageName, pageUuid: $pageUuid) {
errors {
...BaseErrorFragment
}
search {
...SearchFragment
}
}
}
Variables
{"keyword": "xyz789", "pageName": "xyz789", "pageUuid": "xyz789"}
Response
{
"data": {
"createSearch": {
"errors": [BaseError],
"search": Search
}
}
}
createTask
CreateTaskMutationPayload
名称 | 描述 |
---|---|
title -
String!
|
任务标题 |
description -
String
|
任务描述 |
startDate -
ISO8601DateTime
|
开始日期 |
startTime -
ISO8601DateTime
|
开始时间 |
dueDate -
ISO8601DateTime
|
截止日期 |
dueTime -
ISO8601DateTime
|
截止时间 |
assigneeUuid -
String
|
负责人 uuid |
files -
JSON
|
附件 |
customFieldValues -
JSON
|
自定义字段 |
projectUuids -
[String!]
|
所属项目 uuid |
sceneUuids -
[String!]
|
所属项目场景 uuid |
parentUuid -
String
|
父任务 uuid |
prevTaskId -
String
|
前置任务 uuid |
repetition -
JSON
|
循环设置 |
Query
mutation createTask($title: String!, $description: String, $startDate: ISO8601DateTime, $startTime: ISO8601DateTime, $dueDate: ISO8601DateTime, $dueTime: ISO8601DateTime, $assigneeUuid: String, $files: JSON, $customFieldValues: JSON, $projectUuids: [String!], $sceneUuids: [String!], $parentUuid: String, $prevTaskId: String, $repetition: JSON) {
createTask(title: $title, description: $description, startDate: $startDate, startTime: $startTime, dueDate: $dueDate, dueTime: $dueTime, assigneeUuid: $assigneeUuid, files: $files, customFieldValues: $customFieldValues, projectUuids: $projectUuids, sceneUuids: $sceneUuids, parentUuid: $parentUuid, prevTaskId: $prevTaskId, repetition: $repetition) {
conflictScenes {
...ProjectSceneFragment
}
errors {
...BaseErrorFragment
}
section {
...SectionFragment
}
task {
...TaskFragment
}
}
}
Variables
{
"title": "xyz789",
"description": "xyz789",
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"assigneeUuid": "xyz789",
"files": {},
"customFieldValues": {},
"projectUuids": ["xyz789"],
"sceneUuids": ["abc123"],
"parentUuid": "xyz789",
"prevTaskId": "xyz789",
"repetition": {}
}
Response
{
"data": {
"createTask": {
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"section": Section,
"task": Task
}
}
}
createTaskRepetition
CreateTaskRepetitionMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
category -
String
|
循环类型,固定两个选项:system 系统、custom 自定义 |
unit -
String!
|
循环单位,固定四个选项:day 天、week 周、month 月、year 年 |
step -
Int!
|
循环步长 |
targets -
[Int!]
|
对自定义设置循环的具体描述,对不同「单位」,该值的取值范围会有不同目标选项
|
endDate -
ISO8601Date
|
循环停止日期 |
Query
mutation createTaskRepetition($uuid: String!, $category: String, $unit: String!, $step: Int!, $targets: [Int!], $endDate: ISO8601Date) {
createTaskRepetition(uuid: $uuid, category: $category, unit: $unit, step: $step, targets: $targets, endDate: $endDate) {
errors {
...BaseErrorFragment
}
taskRepetition {
...RepetitionFragment
}
}
}
Variables
{
"uuid": "abc123",
"category": "abc123",
"unit": "abc123",
"step": 987,
"targets": [987],
"endDate": ISO8601Date
}
Response
{
"data": {
"createTaskRepetition": {
"errors": [BaseError],
"taskRepetition": Repetition
}
}
}
createTasksState
CreateTasksStateMutationPayload
名称 | 描述 |
---|---|
workflowUuid -
String!
|
任务流程 uuid |
name -
String!
|
状态名称 |
color -
String!
|
状态颜色,目前支持 blue,red,green,orange,pink,lightblue,teal,lime,purple,grey,orchird,brown |
completeStatus -
String!
|
完成状态,固定三个状态值,pending 待处理、 in_progress 进行中、 completed 已完成 |
Query
mutation createTasksState($workflowUuid: String!, $name: String!, $color: String!, $completeStatus: String!) {
createTasksState(workflowUuid: $workflowUuid, name: $name, color: $color, completeStatus: $completeStatus) {
errors {
...BaseErrorFragment
}
tasksState {
...StateFragment
}
}
}
Variables
{
"workflowUuid": "abc123",
"name": "abc123",
"color": "xyz789",
"completeStatus": "xyz789"
}
Response
{
"data": {
"createTasksState": {
"errors": [BaseError],
"tasksState": State
}
}
}
createTasksView
CreateTasksViewMutationPayload
名称 | 描述 |
---|---|
name -
String!
|
视图名字 |
fromViewUuid -
String!
|
视图来源 uuid ,即是从哪个视图下触发的新建 |
displayMode -
String
|
展示方式, list 列表视图, board 看板视图, gantt 甘特视图 |
Query
mutation createTasksView($name: String!, $fromViewUuid: String!, $displayMode: String) {
createTasksView(name: $name, fromViewUuid: $fromViewUuid, displayMode: $displayMode) {
errors {
...BaseErrorFragment
}
tasksView {
...TasksViewFragment
}
}
}
Variables
{"name": "xyz789", "fromViewUuid": "abc123", "displayMode": "xyz789"}
Response
{
"data": {
"createTasksView": {
"errors": [BaseError],
"tasksView": TasksView
}
}
}
createTasksWorkflow
CreateTasksWorkflowMutationPayload
名称 | 描述 |
---|---|
attachableSgid -
String
|
|
name -
String!
|
任务流程名称 |
statesAttributes -
JSON!
|
状态属性,包括每个状态的名称,颜色和完成状态值 |
Query
mutation createTasksWorkflow($attachableSgid: String, $name: String!, $statesAttributes: JSON!) {
createTasksWorkflow(attachableSgid: $attachableSgid, name: $name, statesAttributes: $statesAttributes) {
errors {
...BaseErrorFragment
}
tasksWorkflow {
...WorkflowFragment
}
}
}
Variables
{
"attachableSgid": "abc123",
"name": "abc123",
"statesAttributes": {}
}
Response
{
"data": {
"createTasksWorkflow": {
"errors": [BaseError],
"tasksWorkflow": Workflow
}
}
}
createTeam
CreateTeamMutationPayload
名称 | 描述 |
---|---|
name -
String!
|
|
public -
Boolean
|
是否公开 |
projectUuids -
[String!]
|
项目 uuid |
teammateSgids -
[String!]
|
成员或部门 sgid |
Query
mutation createTeam($name: String!, $public: Boolean, $projectUuids: [String!], $teammateSgids: [String!]) {
createTeam(name: $name, public: $public, projectUuids: $projectUuids, teammateSgids: $teammateSgids) {
errors {
...BaseErrorFragment
}
team {
...TeamFragment
}
}
}
Variables
{
"name": "abc123",
"public": true,
"projectUuids": ["abc123"],
"teammateSgids": ["xyz789"]
}
Response
{
"data": {
"createTeam": {
"errors": [BaseError],
"team": Team
}
}
}
destroyChart
Query
mutation destroyChart($uuid: String!) {
destroyChart(uuid: $uuid) {
chart {
...ChartFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyChart": {
"chart": Chart,
"errors": [BaseError]
}
}
}
destroyDashboard
Query
mutation destroyDashboard($uuid: String!) {
destroyDashboard(uuid: $uuid) {
dashboard {
...DashboardFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"destroyDashboard": {
"dashboard": Dashboard,
"errors": [BaseError]
}
}
}
destroyField
Query
mutation destroyField($uuid: String!, $removeMetaField: Boolean) {
destroyField(uuid: $uuid, removeMetaField: $removeMetaField) {
errors {
...BaseErrorFragment
}
field {
...FieldFragment
}
}
}
Variables
{"uuid": "xyz789", "removeMetaField": true}
Response
{
"data": {
"destroyField": {
"errors": [BaseError],
"field": Field
}
}
}
destroyProject
Query
mutation destroyProject($uuid: String!) {
destroyProject(uuid: $uuid) {
errors {
...BaseErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyProject": {
"errors": [BaseError],
"project": Project
}
}
}
destroyProjectScene
Query
mutation destroyProjectScene($uuid: String!) {
destroyProjectScene(uuid: $uuid) {
errors {
...BaseErrorFragment
}
projectScene {
...ProjectSceneFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyProjectScene": {
"errors": [BaseError],
"projectScene": ProjectScene
}
}
}
destroyReaction
Query
mutation destroyReaction($id: String!) {
destroyReaction(id: $id) {
errors {
...BaseErrorFragment
}
reactable {
...ReactableInterfaceFragment
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"destroyReaction": {
"errors": [BaseError],
"reactable": ReactableInterface
}
}
}
destroyRemark
Query
mutation destroyRemark($uuid: String!) {
destroyRemark(uuid: $uuid) {
errors {
...BaseErrorFragment
}
remark {
...RemarkFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyRemark": {
"errors": [BaseError],
"remark": Remark
}
}
}
destroySection
Query
mutation destroySection($uuid: String!) {
destroySection(uuid: $uuid) {
errors {
...BaseErrorFragment
}
section {
...SectionFragment
}
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"destroySection": {
"errors": [BaseError],
"section": Section
}
}
}
destroyTask
Query
mutation destroyTask($uuid: String!) {
destroyTask(uuid: $uuid) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyTask": {
"errors": [BaseError],
"task": Task
}
}
}
destroyTaskLarkFile
Query
mutation destroyTaskLarkFile($uuid: String!, $fileUuids: [String!]!) {
destroyTaskLarkFile(uuid: $uuid, fileUuids: $fileUuids) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"uuid": "abc123", "fileUuids": ["xyz789"]}
Response
{
"data": {
"destroyTaskLarkFile": {
"errors": [BaseError],
"task": Task
}
}
}
destroyTaskRepetition
Query
mutation destroyTaskRepetition($uuid: String!) {
destroyTaskRepetition(uuid: $uuid) {
errors {
...BaseErrorFragment
}
taskRepetition {
...RepetitionFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyTaskRepetition": {
"errors": [BaseError],
"taskRepetition": Repetition
}
}
}
destroyTasksState
DestroyTasksStateMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务状态 uuid |
toUuid -
String
|
指定新的任务状态 uuid ,当删除的任务状态下存在任务时,需指定新的状态 |
Query
mutation destroyTasksState($uuid: String!, $toUuid: String) {
destroyTasksState(uuid: $uuid, toUuid: $toUuid) {
errors {
...BaseErrorFragment
}
tasksState {
...StateFragment
}
}
}
Variables
{"uuid": "abc123", "toUuid": "abc123"}
Response
{
"data": {
"destroyTasksState": {
"errors": [BaseError],
"tasksState": State
}
}
}
destroyTasksView
Query
mutation destroyTasksView($uuid: String!) {
destroyTasksView(uuid: $uuid) {
errors {
...BaseErrorFragment
}
tasksView {
...TasksViewFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyTasksView": {
"errors": [BaseError],
"tasksView": TasksView
}
}
}
destroyTasksWorkflow
Query
mutation destroyTasksWorkflow($uuid: String!) {
destroyTasksWorkflow(uuid: $uuid) {
errors {
...BaseErrorFragment
}
tasksWorkflow {
...WorkflowFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"destroyTasksWorkflow": {
"errors": [BaseError],
"tasksWorkflow": Workflow
}
}
}
destroyTeam
DestroyTeamMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目组 uuid |
projectUuids -
[String!]
|
项目 uuid ,若填写则同时归档项目 |
Query
mutation destroyTeam($uuid: String!, $projectUuids: [String!]) {
destroyTeam(uuid: $uuid, projectUuids: $projectUuids) {
errors {
...BaseErrorFragment
}
team {
...TeamFragment
}
}
}
Variables
{"uuid": "xyz789", "projectUuids": ["abc123"]}
Response
{
"data": {
"destroyTeam": {
"errors": [BaseError],
"team": Team
}
}
}
duplicateDashboard
Query
mutation duplicateDashboard($uuid: String!, $name: String!) {
duplicateDashboard(uuid: $uuid, name: $name) {
dashboard {
...DashboardFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"uuid": "abc123", "name": "abc123"}
Response
{
"data": {
"duplicateDashboard": {
"dashboard": Dashboard,
"errors": [BaseError]
}
}
}
joinTask
Query
mutation joinTask($id: String!) {
joinTask(id: $id) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"joinTask": {
"errors": [BaseError],
"task": Task
}
}
}
leaveTask
Query
mutation leaveTask($id: String!) {
leaveTask(id: $id) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"leaveTask": {
"errors": [BaseError],
"task": Task
}
}
}
moveChart
MoveChartMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
图表 uuid |
prevUuid -
String
|
前面图表的 uuid |
nextUuid -
String
|
后面图表的 uuid |
Query
mutation moveChart($uuid: String!, $prevUuid: String, $nextUuid: String) {
moveChart(uuid: $uuid, prevUuid: $prevUuid, nextUuid: $nextUuid) {
chart {
...ChartFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"uuid": "xyz789", "prevUuid": "abc123", "nextUuid": "abc123"}
Response
{
"data": {
"moveChart": {
"chart": Chart,
"errors": [BaseError]
}
}
}
moveTask
MoveTaskMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
taskContextSgid -
String!
|
|
parentUuid -
String
|
父任务 uuid |
sectionUuid -
String
|
分组 uuid |
stateUuid -
String
|
任务状态 uuid,可通过「task」查询结果中的「state」字段获得 |
assigneeUuid -
String
|
负责人 uuid |
customFieldValues -
JSON
|
自定义字段 |
prevUuid -
String
|
前置任务 uuid |
nextUuid -
String
|
后置任务 uuid |
scopeContextSgid -
String
|
Query
mutation moveTask($uuid: String!, $taskContextSgid: String!, $parentUuid: String, $sectionUuid: String, $stateUuid: String, $assigneeUuid: String, $customFieldValues: JSON, $prevUuid: String, $nextUuid: String, $scopeContextSgid: String) {
moveTask(uuid: $uuid, taskContextSgid: $taskContextSgid, parentUuid: $parentUuid, sectionUuid: $sectionUuid, stateUuid: $stateUuid, assigneeUuid: $assigneeUuid, customFieldValues: $customFieldValues, prevUuid: $prevUuid, nextUuid: $nextUuid, scopeContextSgid: $scopeContextSgid) {
conflictScene {
...ConflictSceneFragment
}
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{
"uuid": "xyz789",
"taskContextSgid": "xyz789",
"parentUuid": "abc123",
"sectionUuid": "xyz789",
"stateUuid": "abc123",
"assigneeUuid": "abc123",
"customFieldValues": {},
"prevUuid": "abc123",
"nextUuid": "abc123",
"scopeContextSgid": "xyz789"
}
Response
{
"data": {
"moveTask": {
"conflictScene": ConflictScene,
"errors": [BaseError],
"task": Task
}
}
}
remindTask
RemindTaskMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
content -
String!
|
催促内容 |
remindInLarkChat -
Boolean
|
是否在飞书群聊中同时发送消息 |
Query
mutation remindTask($uuid: String!, $content: String!, $remindInLarkChat: Boolean) {
remindTask(uuid: $uuid, content: $content, remindInLarkChat: $remindInLarkChat) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"uuid": "abc123", "content": "abc123", "remindInLarkChat": true}
Response
{
"data": {
"remindTask": {
"errors": [BaseError],
"task": Task
}
}
}
removeDashboardAccesses
RemoveDashboardAccessesMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
仪表盘 uuid |
accessSgids -
[String!]
|
成员/部门的 sgid 数组 |
Query
mutation removeDashboardAccesses($uuid: String!, $accessSgids: [String!]) {
removeDashboardAccesses(uuid: $uuid, accessSgids: $accessSgids) {
dashboard {
...DashboardFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"uuid": "abc123", "accessSgids": ["xyz789"]}
Response
{
"data": {
"removeDashboardAccesses": {
"dashboard": Dashboard,
"errors": [BaseError]
}
}
}
removeTaskCollaborators
RemoveTaskCollaboratorsMutationPayload
名称 | 描述 |
---|---|
id -
String!
|
任务 id |
collaboratorIds -
[String!]!
|
协作者 uuid |
Query
mutation removeTaskCollaborators($id: String!, $collaboratorIds: [String!]!) {
removeTaskCollaborators(id: $id, collaboratorIds: $collaboratorIds) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"id": "abc123", "collaboratorIds": ["abc123"]}
Response
{
"data": {
"removeTaskCollaborators": {
"errors": [BaseError],
"task": Task
}
}
}
removeTaskDependency
Query
mutation removeTaskDependency($uuid: String!) {
removeTaskDependency(uuid: $uuid) {
errors {
...BaseErrorFragment
}
tasksDependency {
...TasksDependencyFragment
}
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"removeTaskDependency": {
"errors": [BaseError],
"tasksDependency": TasksDependency
}
}
}
removeTaskFromScene
Query
mutation removeTaskFromScene($uuid: String!, $sceneUuid: String!) {
removeTaskFromScene(uuid: $uuid, sceneUuid: $sceneUuid) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"uuid": "abc123", "sceneUuid": "abc123"}
Response
{
"data": {
"removeTaskFromScene": {
"errors": [BaseError],
"task": Task
}
}
}
restoreTasksWorkflow
Query
mutation restoreTasksWorkflow($uuid: String!) {
restoreTasksWorkflow(uuid: $uuid) {
errors {
...BaseErrorFragment
}
tasksWorkflow {
...WorkflowFragment
}
}
}
Variables
{"uuid": "abc123"}
Response
{
"data": {
"restoreTasksWorkflow": {
"errors": [BaseError],
"tasksWorkflow": Workflow
}
}
}
updateChart
UpdateChartMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
图表 uuid |
name -
String
|
名称 |
type -
String
|
图表类型,如下所示
|
color -
String
|
颜色 |
showValue -
Boolean
|
图表中是否显示数据 |
sourceSgids -
[String!]
|
数据源 sgid 数组 |
aggregator -
String
|
统计项 |
groupBy -
String
|
分组方式 |
timeGranularity -
String
|
时间颗粒度 |
conditions -
JSON
|
筛选器 |
Query
mutation updateChart($uuid: String!, $name: String, $type: String, $color: String, $showValue: Boolean, $sourceSgids: [String!], $aggregator: String, $groupBy: String, $timeGranularity: String, $conditions: JSON) {
updateChart(uuid: $uuid, name: $name, type: $type, color: $color, showValue: $showValue, sourceSgids: $sourceSgids, aggregator: $aggregator, groupBy: $groupBy, timeGranularity: $timeGranularity, conditions: $conditions) {
chart {
...ChartFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{
"uuid": "abc123",
"name": "abc123",
"type": "abc123",
"color": "abc123",
"showValue": false,
"sourceSgids": ["xyz789"],
"aggregator": "xyz789",
"groupBy": "abc123",
"timeGranularity": "abc123",
"conditions": {}
}
Response
{
"data": {
"updateChart": {
"chart": Chart,
"errors": [BaseError]
}
}
}
updateDashboard
UpdateDashboardMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
仪表盘 uuid |
name -
String
|
名称 |
color -
String
|
颜色 |
icon -
String
|
图标 |
Query
mutation updateDashboard($uuid: String!, $name: String, $color: String, $icon: String) {
updateDashboard(uuid: $uuid, name: $name, color: $color, icon: $icon) {
dashboard {
...DashboardFragment
}
errors {
...BaseErrorFragment
}
}
}
Variables
{"uuid": "abc123", "name": "xyz789", "color": "xyz789", "icon": "xyz789"}
Response
{
"data": {
"updateDashboard": {
"dashboard": Dashboard,
"errors": [BaseError]
}
}
}
updateField
UpdateFieldMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
字段 uuid |
name -
String
|
字段名称 |
description -
String
|
字段描述 |
public -
Boolean
|
是否公开 |
inputType -
String
|
字段类型 |
settings -
JSON
|
|
hidden -
Boolean
|
是否隐藏 |
required -
Boolean
|
是否必填 |
asTemplate -
Boolean
|
是否添加为模版 |
Query
mutation updateField($uuid: String!, $name: String, $description: String, $public: Boolean, $inputType: String, $settings: JSON, $hidden: Boolean, $required: Boolean, $asTemplate: Boolean) {
updateField(uuid: $uuid, name: $name, description: $description, public: $public, inputType: $inputType, settings: $settings, hidden: $hidden, required: $required, asTemplate: $asTemplate) {
errors {
...BaseErrorFragment
}
field {
...FieldFragment
}
}
}
Variables
{
"uuid": "abc123",
"name": "xyz789",
"description": "abc123",
"public": false,
"inputType": "abc123",
"settings": {},
"hidden": true,
"required": true,
"asTemplate": true
}
Response
{
"data": {
"updateField": {
"errors": [BaseError],
"field": Field
}
}
}
updatePosition
UpdatePositionMutationPayload
名称 | 描述 |
---|---|
id -
String!
|
资源 id |
prevId -
String
|
上一个资源 id |
nextId -
String
|
下一个资源 id |
scopeContextId -
String
|
上下文资源 id |
Query
mutation updatePosition($id: String!, $prevId: String, $nextId: String, $scopeContextId: String) {
updatePosition(id: $id, prevId: $prevId, nextId: $nextId, scopeContextId: $scopeContextId) {
errors {
...BaseErrorFragment
}
success
}
}
Variables
{
"id": "abc123",
"prevId": "abc123",
"nextId": "abc123",
"scopeContextId": "xyz789"
}
Response
{
"data": {
"updatePosition": {
"errors": [BaseError],
"success": false
}
}
}
updateProject
UpdateProjectMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目 uuid |
name -
String
|
项目名称 |
icon -
String
|
|
color -
String
|
项目颜色 |
leaderUuid -
String
|
项目负责人 uuid |
public -
Boolean
|
项目是否公开 |
externalAccessRole -
String
|
协助者权限, remark 仅可讨论, edit 可以编辑 |
teamUuids -
[String!]
|
所属项目组 uuid 列表 |
startDate -
ISO8601DateTime
|
项目开始日期 |
startTime -
ISO8601DateTime
|
项目开始时间 |
dueDate -
ISO8601DateTime
|
项目截止日期 |
dueTime -
ISO8601DateTime
|
项目截止时间 |
description -
String
|
项目描述 |
customFieldValues -
JSON
|
项目自定义字段值 |
Query
mutation updateProject($uuid: String!, $name: String, $icon: String, $color: String, $leaderUuid: String, $public: Boolean, $externalAccessRole: String, $teamUuids: [String!], $startDate: ISO8601DateTime, $startTime: ISO8601DateTime, $dueDate: ISO8601DateTime, $dueTime: ISO8601DateTime, $description: String, $customFieldValues: JSON) {
updateProject(uuid: $uuid, name: $name, icon: $icon, color: $color, leaderUuid: $leaderUuid, public: $public, externalAccessRole: $externalAccessRole, teamUuids: $teamUuids, startDate: $startDate, startTime: $startTime, dueDate: $dueDate, dueTime: $dueTime, description: $description, customFieldValues: $customFieldValues) {
errors {
...BaseErrorFragment
}
hasAccess
project {
...ProjectFragment
}
}
}
Variables
{
"uuid": "abc123",
"name": "xyz789",
"icon": "xyz789",
"color": "xyz789",
"leaderUuid": "abc123",
"public": true,
"externalAccessRole": "abc123",
"teamUuids": ["xyz789"],
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"description": "xyz789",
"customFieldValues": {}
}
Response
{
"data": {
"updateProject": {
"errors": [BaseError],
"hasAccess": true,
"project": Project
}
}
}
updateProjectAccesses
UpdateProjectAccessesMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目 uuid |
accessSgids -
[String!]
|
部门/成员 sgid |
role -
String!
|
项目权限, remark 仅可讨论, edit 可以编辑 |
Query
mutation updateProjectAccesses($uuid: String!, $accessSgids: [String!], $role: String!) {
updateProjectAccesses(uuid: $uuid, accessSgids: $accessSgids, role: $role) {
errors {
...BaseErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"uuid": "xyz789", "accessSgids": ["xyz789"], "role": "abc123"}
Response
{
"data": {
"updateProjectAccesses": {
"errors": [BaseError],
"project": Project
}
}
}
updateProjectScene
UpdateProjectSceneMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
场景 uuid |
name -
String
|
场景名称 |
workflowUuid -
String
|
工作流 uuid |
migratedStateUuids -
JSON
|
迁移后状态 uuid ,当存在状态不一致进行迁移时,需要配置前后状态对应关系 |
tasksOption -
String
|
存在流程冲突时,选择处理方式, removeFromCurrentScene 从当前场景移除自定义流程任务, removeFromAnotherScene 从其它场景移除自定义流程任务 |
Query
mutation updateProjectScene($uuid: String!, $name: String, $workflowUuid: String, $migratedStateUuids: JSON, $tasksOption: String) {
updateProjectScene(uuid: $uuid, name: $name, workflowUuid: $workflowUuid, migratedStateUuids: $migratedStateUuids, tasksOption: $tasksOption) {
conflictScenes {
...ProjectSceneFragment
}
errors {
...BaseErrorFragment
}
projectScene {
...ProjectSceneFragment
}
}
}
Variables
{
"uuid": "abc123",
"name": "xyz789",
"workflowUuid": "xyz789",
"migratedStateUuids": {},
"tasksOption": "xyz789"
}
Response
{
"data": {
"updateProjectScene": {
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"projectScene": ProjectScene
}
}
}
updateProjectsStatusReport
UpdateProjectsStatusReportMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
报告 uuid |
status -
String
|
报告类型, on_track 正常, at_risk 低风险, off_track 高风险 |
title -
String
|
报告标题 |
summary -
String
|
报告描述 |
Query
mutation updateProjectsStatusReport($uuid: String!, $status: String, $title: String, $summary: String) {
updateProjectsStatusReport(uuid: $uuid, status: $status, title: $title, summary: $summary) {
errors {
...BaseErrorFragment
}
statusReport {
...ProjectsStatusReportFragment
}
}
}
Variables
{"uuid": "abc123", "status": "xyz789", "title": "abc123", "summary": "xyz789"}
Response
{
"data": {
"updateProjectsStatusReport": {
"errors": [BaseError],
"statusReport": ProjectsStatusReport
}
}
}
updateProjectStatus
UpdateProjectStatusMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目 uuid |
status -
String!
|
项目状态, archived 归档, active 激活 |
Query
mutation updateProjectStatus($uuid: String!, $status: String!) {
updateProjectStatus(uuid: $uuid, status: $status) {
errors {
...BaseErrorFragment
}
project {
...ProjectFragment
}
}
}
Variables
{"uuid": "xyz789", "status": "abc123"}
Response
{
"data": {
"updateProjectStatus": {
"errors": [BaseError],
"project": Project
}
}
}
updateRemark
Query
mutation updateRemark($uuid: String!, $content: String!) {
updateRemark(uuid: $uuid, content: $content) {
errors {
...BaseErrorFragment
}
remark {
...RemarkFragment
}
resource
}
}
Variables
{"uuid": "xyz789", "content": "abc123"}
Response
{
"data": {
"updateRemark": {
"errors": [BaseError],
"remark": Remark,
"resource": RemarkResourceUnion
}
}
}
updateSection
Query
mutation updateSection($uuid: String!, $name: String!) {
updateSection(uuid: $uuid, name: $name) {
errors {
...BaseErrorFragment
}
section {
...SectionFragment
}
}
}
Variables
{"uuid": "xyz789", "name": "abc123"}
Response
{
"data": {
"updateSection": {
"errors": [BaseError],
"section": Section
}
}
}
updateTask
UpdateTaskMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
title -
String
|
任务标题 |
startDate -
ISO8601DateTime
|
开始日期 |
dueDate -
ISO8601DateTime
|
截止日期 |
startTime -
ISO8601DateTime
|
开始时间 |
dueTime -
ISO8601DateTime
|
截止时间 |
description -
String
|
任务描述 |
assigneeUuid -
String
|
负责人 uuid |
sectionUuid -
String
|
分组 uuid |
customFieldValues -
JSON
|
自定义字段 |
prevId -
String
|
前一个任务 sgid |
nextId -
String
|
后一个任务 sgid |
scopeContextId -
String
|
|
autoAdjustFollowUpTasks -
Boolean
|
|
coverImage -
String
|
|
repetition -
JSON
|
循环设置 |
Query
mutation updateTask($uuid: String!, $title: String, $startDate: ISO8601DateTime, $dueDate: ISO8601DateTime, $startTime: ISO8601DateTime, $dueTime: ISO8601DateTime, $description: String, $assigneeUuid: String, $sectionUuid: String, $customFieldValues: JSON, $prevId: String, $nextId: String, $scopeContextId: String, $autoAdjustFollowUpTasks: Boolean, $coverImage: String, $repetition: JSON) {
updateTask(uuid: $uuid, title: $title, startDate: $startDate, dueDate: $dueDate, startTime: $startTime, dueTime: $dueTime, description: $description, assigneeUuid: $assigneeUuid, sectionUuid: $sectionUuid, customFieldValues: $customFieldValues, prevId: $prevId, nextId: $nextId, scopeContextId: $scopeContextId, autoAdjustFollowUpTasks: $autoAdjustFollowUpTasks, coverImage: $coverImage, repetition: $repetition) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{
"uuid": "xyz789",
"title": "xyz789",
"startDate": ISO8601DateTime,
"dueDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"description": "xyz789",
"assigneeUuid": "xyz789",
"sectionUuid": "abc123",
"customFieldValues": {},
"prevId": "xyz789",
"nextId": "abc123",
"scopeContextId": "xyz789",
"autoAdjustFollowUpTasks": false,
"coverImage": "xyz789",
"repetition": {}
}
Response
{
"data": {
"updateTask": {
"errors": [BaseError],
"task": Task
}
}
}
updateTaskCategory
UpdateTaskCategoryMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
category -
String!
|
类型, normal 任务, milestone 里程碑 |
Query
mutation updateTaskCategory($uuid: String!, $category: String!) {
updateTaskCategory(uuid: $uuid, category: $category) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"uuid": "xyz789", "category": "xyz789"}
Response
{
"data": {
"updateTaskCategory": {
"errors": [BaseError],
"task": Task
}
}
}
updateTaskCollaborators
UpdateTaskCollaboratorsMutationPayload
名称 | 描述 |
---|---|
id -
String!
|
任务 id |
collaboratorIds -
[String!]!
|
协作者 uuid |
Query
mutation updateTaskCollaborators($id: String!, $collaboratorIds: [String!]!) {
updateTaskCollaborators(id: $id, collaboratorIds: $collaboratorIds) {
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{"id": "abc123", "collaboratorIds": ["xyz789"]}
Response
{
"data": {
"updateTaskCollaborators": {
"errors": [BaseError],
"task": Task
}
}
}
updateTaskParent
UpdateTaskParentMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务 uuid |
parentUuid -
String
|
父任务 uuid |
prevUuid -
String
|
前一个任务 uuid |
scopeContextSgid -
String
|
|
taskContextSgid -
String
|
Query
mutation updateTaskParent($uuid: String!, $parentUuid: String, $prevUuid: String, $scopeContextSgid: String, $taskContextSgid: String) {
updateTaskParent(uuid: $uuid, parentUuid: $parentUuid, prevUuid: $prevUuid, scopeContextSgid: $scopeContextSgid, taskContextSgid: $taskContextSgid) {
conflictScene {
...ConflictSceneFragment
}
errors {
...BaseErrorFragment
}
task {
...TaskFragment
}
}
}
Variables
{
"uuid": "abc123",
"parentUuid": "abc123",
"prevUuid": "abc123",
"scopeContextSgid": "abc123",
"taskContextSgid": "abc123"
}
Response
{
"data": {
"updateTaskParent": {
"conflictScene": ConflictScene,
"errors": [BaseError],
"task": Task
}
}
}
updateTasksState
UpdateTasksStateMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务流程状态值 uuid |
name -
String
|
任务流程状态值名称 |
color -
String
|
任务流程状态颜色 |
completeStatus -
String
|
任务流程完成状态, pending 待处理, in_progress 进行中,completed 已完成 |
Query
mutation updateTasksState($uuid: String!, $name: String, $color: String, $completeStatus: String) {
updateTasksState(uuid: $uuid, name: $name, color: $color, completeStatus: $completeStatus) {
errors {
...BaseErrorFragment
}
tasksState {
...StateFragment
}
}
}
Variables
{
"uuid": "xyz789",
"name": "xyz789",
"color": "abc123",
"completeStatus": "abc123"
}
Response
{
"data": {
"updateTasksState": {
"errors": [BaseError],
"tasksState": State
}
}
}
updateTasksView
UpdateTasksViewMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务视图 uuid |
name -
String
|
任务视图名称 |
displayMode -
String
|
展示方式, list 列表, board 看板, gantt 甘特图 |
groupUuids -
JSON
|
分组 uuid |
Query
mutation updateTasksView($uuid: String!, $name: String, $displayMode: String, $groupUuids: JSON) {
updateTasksView(uuid: $uuid, name: $name, displayMode: $displayMode, groupUuids: $groupUuids) {
errors {
...BaseErrorFragment
}
tasksView {
...TasksViewFragment
}
}
}
Variables
{
"uuid": "abc123",
"name": "xyz789",
"displayMode": "xyz789",
"groupUuids": {}
}
Response
{
"data": {
"updateTasksView": {
"errors": [BaseError],
"tasksView": TasksView
}
}
}
updateTasksViewField
UpdateTasksViewFieldMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
字段 uuid |
name -
String
|
字段名称 |
description -
String
|
字段描述 |
public -
Boolean
|
是否公开 |
inputType -
String
|
字段类型 |
settings -
JSON
|
|
hidden -
Boolean
|
是否隐藏 |
required -
Boolean
|
是否必填 |
asTemplate -
Boolean
|
是否添加为模版 |
viewUuid -
String!
|
视图 uuid |
Query
mutation updateTasksViewField($uuid: String!, $name: String, $description: String, $public: Boolean, $inputType: String, $settings: JSON, $hidden: Boolean, $required: Boolean, $asTemplate: Boolean, $viewUuid: String!) {
updateTasksViewField(uuid: $uuid, name: $name, description: $description, public: $public, inputType: $inputType, settings: $settings, hidden: $hidden, required: $required, asTemplate: $asTemplate, viewUuid: $viewUuid) {
column {
...FieldsColumnFragment
}
errors {
...BaseErrorFragment
}
field {
...FieldFragment
}
}
}
Variables
{
"uuid": "abc123",
"name": "abc123",
"description": "abc123",
"public": true,
"inputType": "abc123",
"settings": {},
"hidden": true,
"required": false,
"asTemplate": true,
"viewUuid": "xyz789"
}
Response
{
"data": {
"updateTasksViewField": {
"column": FieldsColumn,
"errors": [BaseError],
"field": Field
}
}
}
updateTasksViewFilterForm
UpdateTasksViewFilterFormMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务视图 uuid |
groupBy -
String
|
分组方式, section 手动分组, nothing 不分组, state 按处理状态, assignee 按负责人, creator 按创建人 |
colorBy -
String
|
|
orderBy -
String
|
排序方式, position 手动排序,due_at 按截止时间, created_at 按创建时间, updated_at 按更新时间 |
orderSort -
String
|
排序顺序, asc 升序, desc 降序 |
filters -
JSON
|
筛选条件 |
conjunction -
String
|
|
hideSubtask -
Boolean
|
是否显示子任务 |
disableTreeView -
Boolean
|
子任务是否以树状结构显示 |
conditions -
JSON
|
先决条件 |
timeGranularity -
String
|
|
autoAdjustFollowUpTasks -
Boolean
|
|
hideFieldName -
Boolean
|
|
hideLunar -
Boolean
|
是否隐藏农历 |
Query
mutation updateTasksViewFilterForm($uuid: String!, $groupBy: String, $colorBy: String, $orderBy: String, $orderSort: String, $filters: JSON, $conjunction: String, $hideSubtask: Boolean, $disableTreeView: Boolean, $conditions: JSON, $timeGranularity: String, $autoAdjustFollowUpTasks: Boolean, $hideFieldName: Boolean, $hideLunar: Boolean) {
updateTasksViewFilterForm(uuid: $uuid, groupBy: $groupBy, colorBy: $colorBy, orderBy: $orderBy, orderSort: $orderSort, filters: $filters, conjunction: $conjunction, hideSubtask: $hideSubtask, disableTreeView: $disableTreeView, conditions: $conditions, timeGranularity: $timeGranularity, autoAdjustFollowUpTasks: $autoAdjustFollowUpTasks, hideFieldName: $hideFieldName, hideLunar: $hideLunar) {
errors {
...BaseErrorFragment
}
filterBuilder {
...FilterBuilderFragment
}
}
}
Variables
{
"uuid": "xyz789",
"groupBy": "xyz789",
"colorBy": "xyz789",
"orderBy": "abc123",
"orderSort": "abc123",
"filters": {},
"conjunction": "abc123",
"hideSubtask": false,
"disableTreeView": false,
"conditions": {},
"timeGranularity": "abc123",
"autoAdjustFollowUpTasks": true,
"hideFieldName": false,
"hideLunar": false
}
Response
{
"data": {
"updateTasksViewFilterForm": {
"errors": [BaseError],
"filterBuilder": FilterBuilder
}
}
}
updateTasksWorkflow
UpdateTasksWorkflowMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
任务流程 uuid |
name -
String
|
任务流程名称 |
states -
JSON
|
|
migratedStateKeys -
JSON
|
Query
mutation updateTasksWorkflow($uuid: String!, $name: String, $states: JSON, $migratedStateKeys: JSON) {
updateTasksWorkflow(uuid: $uuid, name: $name, states: $states, migratedStateKeys: $migratedStateKeys) {
errors {
...BaseErrorFragment
}
tasksWorkflow {
...WorkflowFragment
}
}
}
Variables
{
"uuid": "abc123",
"name": "abc123",
"states": {},
"migratedStateKeys": {}
}
Response
{
"data": {
"updateTasksWorkflow": {
"errors": [BaseError],
"tasksWorkflow": Workflow
}
}
}
updateTeam
UpdateTeamMutationPayload
名称 | 描述 |
---|---|
uuid -
String!
|
项目组 uuid |
name -
String
|
项目名称 |
public -
Boolean
|
是否为公开项目 |
leaderUuid -
String
|
项目组负责人 |
Query
mutation updateTeam($uuid: String!, $name: String, $public: Boolean, $leaderUuid: String) {
updateTeam(uuid: $uuid, name: $name, public: $public, leaderUuid: $leaderUuid) {
errors {
...BaseErrorFragment
}
team {
...TeamFragment
}
}
}
Variables
{"uuid": "abc123", "name": "abc123", "public": false, "leaderUuid": "xyz789"}
Response
{
"data": {
"updateTeam": {
"errors": [BaseError],
"team": Team
}
}
}
BoardTaskGroup
看板视图任务分组
字段名 | 描述 |
---|---|
group -
ListTaskGroup
|
分组 |
tasks -
[ListTask!]!
|
任务 |
示例
{
"group": ListTaskGroup,
"tasks": [ListTask]
}
CalendarTask
日历任务
字段名 | 描述 |
---|---|
dueDate -
ISO8601Date!
|
任务结束日期 |
startDate -
ISO8601Date!
|
任务开始日期 |
task -
Task!
|
任务 |
示例
{
"dueDate": ISO8601Date,
"startDate": ISO8601Date,
"task": Task
}
Chart
图表
字段名 | 描述 |
---|---|
aggregator -
String!
|
统计项 |
color -
String!
|
颜色 |
creator -
Member!
|
创建人 |
dashboard -
Dashboard!
|
所属仪表盘 |
filterBuilder -
FilterBuilder!
|
筛选器 |
groupData -
JSON
|
分组数据 |
name -
String
|
名称 |
organization -
Organization!
|
组织 |
position -
Float
|
位置 |
settings -
JSON
|
图表 x 与 y 轴的配置信息 |
showValue -
Boolean!
|
图表中是否显示数据 |
sourceSgids -
[String!]!
|
项目组、项目、场景数据源 sgid 数组,全部项目用 all 标识 |
sources -
[ChartSourceInterface!]!
|
数据源信息 |
type -
String!
|
图表类型 |
uuid -
String!
|
图表 uuid |
示例
{
"aggregator": "xyz789",
"color": "abc123",
"creator": Member,
"dashboard": Dashboard,
"filterBuilder": FilterBuilder,
"groupData": {},
"name": "xyz789",
"organization": Organization,
"position": 987.65,
"settings": {},
"showValue": true,
"sourceSgids": ["xyz789"],
"sources": [ChartSourceInterface],
"type": "xyz789",
"uuid": "xyz789"
}
ConflictScene
场景冲突
字段名 | 描述 |
---|---|
canCopy -
Boolean
|
是否可复制 |
canMove -
Boolean
|
是否可移动 |
conflictCount -
Int
|
冲突数量 |
scene -
ProjectScene!
|
场景 |
示例
{
"canCopy": false,
"canMove": false,
"conflictCount": 123,
"scene": ProjectScene
}
Dashboard
仪表盘
字段名 | 描述 |
---|---|
accesses -
[VisibilityScopeIdentityInterface!]!
|
访问权限列表 |
charts -
[Chart!]!
|
仪表盘图表列表 |
chartsCount -
Int!
|
图表数量 |
color -
String
|
颜色 |
creator -
Member!
|
创建人 |
icon -
String
|
图标 |
name -
String!
|
名称 |
organization -
Organization!
|
组织 |
uuid -
String!
|
仪表盘 uuid |
示例
{
"accesses": [VisibilityScopeIdentityInterface],
"charts": [Chart],
"chartsCount": 123,
"color": "xyz789",
"creator": Member,
"icon": "abc123",
"name": "abc123",
"organization": Organization,
"uuid": "abc123"
}
Field
字段
字段名 | 描述 |
---|---|
attachableType -
String
|
|
canEditMetaField -
Boolean!
|
是否可编辑 |
canHidden -
Boolean!
|
是否可隐藏 |
canRemoved -
Boolean!
|
是否可移除 |
columnWidth -
Int
|
列宽 |
deletedAt -
ISO8601DateTime
|
删除时间 |
hidden -
Boolean!
|
是否隐藏 |
key -
String!
|
字段 key |
metaField -
MetaField!
|
基础字段 |
position -
Float
|
|
required -
Boolean!
|
是否必填 |
sgid -
String!
|
字段 sgid |
uuid -
String!
|
字段 uuid |
示例
{
"attachableType": "xyz789",
"canEditMetaField": true,
"canHidden": true,
"canRemoved": true,
"columnWidth": 987,
"deletedAt": ISO8601DateTime,
"hidden": false,
"key": "abc123",
"metaField": MetaField,
"position": 987.65,
"required": false,
"sgid": "xyz789",
"uuid": "abc123"
}
FieldInterface
字段名 | 描述 |
---|---|
inputType -
String!
|
字段类型 |
key -
String!
|
字段 key |
metaField -
MetaField!
|
基础字段 |
sgid -
String!
|
字段 sgid |
示例
{
"inputType": "abc123",
"key": "abc123",
"metaField": MetaField,
"sgid": "xyz789"
}
FilterBuilder
筛选
字段名 | 描述 |
---|---|
availableAggregators -
JSON
|
可用的统计项 |
availableColorBy -
JSON
|
|
availableCustomFilters -
JSON
|
可用的自定义筛选 |
availableGroups -
JSON
|
可用分组方式 |
availableOrders -
JSON
|
可用排序方式 |
availableQuickFilterTerms -
JSON
|
可用的快速筛选 |
availableTimeGranularity -
JSON
|
|
filterForm -
FilterForm!
|
筛选来源 |
uuid -
String
|
筛选 uuid |
variables -
JSON
|
变量 |
示例
{
"availableAggregators": {},
"availableColorBy": {},
"availableCustomFilters": {},
"availableGroups": {},
"availableOrders": {},
"availableQuickFilterTerms": {},
"availableTimeGranularity": {},
"filterForm": FilterForm,
"uuid": "xyz789",
"variables": {}
}
FilterForm
筛选表
字段名 | 描述 |
---|---|
autoAdjustFollowUpTasks -
Boolean
|
自动调整后置任务时间,用于甘特视图 |
category -
String!
|
筛选表类型 |
client -
String
|
|
colorBy -
String
|
着色方式 |
conditions -
[FilterCondition!]!
|
筛选条件 |
conjunction -
String
|
|
customFilters -
[Filter!]!
|
|
disableTreeView -
Boolean!
|
是否关闭树状结构 |
filters -
JSON
|
|
groupBy -
String
|
分组方式 |
hideFieldName -
Boolean
|
是否隐藏字段名字,用于看板视图 |
hideLunar -
Boolean!
|
是否隐藏农历 |
hideSubtask -
Boolean!
|
是否隐藏子任务 |
keyword -
String
|
|
name -
String
|
|
orderBy -
String
|
排序方式 |
orderSort -
String
|
升降序规则 |
quickFilterTerm -
String
|
快速筛选项 |
rawConditions -
JSON!
|
原始条件 |
sgid -
String
|
筛选表 sgid |
timeGranularity -
String
|
时间粒度,day ,week ,month,quarter,year ,用于甘特视图 |
uuid -
String
|
筛选表 uuid |
示例
{
"autoAdjustFollowUpTasks": true,
"category": "xyz789",
"client": "abc123",
"colorBy": "abc123",
"conditions": [FilterCondition],
"conjunction": "xyz789",
"customFilters": [Filter],
"disableTreeView": false,
"filters": {},
"groupBy": "abc123",
"hideFieldName": true,
"hideLunar": true,
"hideSubtask": true,
"keyword": "xyz789",
"name": "abc123",
"orderBy": "abc123",
"orderSort": "abc123",
"quickFilterTerm": "abc123",
"rawConditions": {},
"sgid": "abc123",
"timeGranularity": "abc123",
"uuid": "abc123"
}
LarkDepartment
飞书部门
字段名 | 描述 |
---|---|
deletedAt -
ISO8601DateTime
|
删除时间 |
name -
String!
|
部门名称 |
uuid -
String!
|
部门 uuid |
示例
{
"deletedAt": ISO8601DateTime,
"name": "abc123",
"uuid": "xyz789"
}
ListSubtasks
列表子任务
字段名 | 描述 |
---|---|
listTasks -
[ListTask!]!
|
列表任务 |
parentUuid -
String!
|
父任务 uuid |
示例
{"listTasks": [ListTask], "parentUuid": "xyz789"}
ListTaskResult
列表任务结果
字段名 | 描述 |
---|---|
groups -
[ListTaskGroup!]
|
分组列表 |
metricsResults -
[MetricsResult!]
|
统计结果 |
subtasks -
[ListSubtasks!]!
|
子任务列表 |
tasks -
[ListTask!]!
|
任务列表 |
totalCount -
Int
|
任务总数,树状结构下不含子任务 |
treeView -
Boolean!
|
是否以树状结构展示 |
variables -
JSON
|
示例
{
"groups": [ListTaskGroup],
"metricsResults": [MetricsResult],
"subtasks": [ListSubtasks],
"tasks": [ListTask],
"totalCount": 987,
"treeView": true,
"variables": {}
}
Member
成员
字段名 | 描述 |
---|---|
avatar -
String
|
|
collaborationScenes -
[String!]!
|
协作场景 |
dateFormatPreference -
String
|
日期格式设置偏好 |
departments -
[LarkDepartment!]!
|
|
featureGuidePreference -
JSON
|
|
fields -
[Field!]
|
|
id -
String!
|
成员 id |
isAppAdmin -
Boolean!
|
是否为负责人 |
isTemplateAdmin -
Boolean!
|
是否为模版负责人 |
languagePreference -
String
|
显示语言设置偏好 |
larkApp -
LarkApp!
|
飞书 app 信息 |
larkUser -
LarkUser
|
飞书成员信息 |
name -
String!
|
成员名字 |
notificationPreference -
JSON
|
消息设置偏好 |
notificationUnreadCount -
Int
|
消息未读数 |
orderPreference -
JSON
|
排序偏好 |
organization -
Organization!
|
|
pinyin -
String
|
成员名称拼音 |
pinyinAbbr -
String
|
成员名称拼音简写 |
projectPreference -
JSON
|
项目偏好 |
recentSearchHistory -
[Search!]!
|
最近搜索记录 |
searcher -
Searcher!
|
|
sidebarPreference -
JSON
|
侧边栏偏好 |
status -
String!
|
成员状态 |
subscribeProductDemoEnabled -
Boolean!
|
|
tasksViews -
[TasksView!]!
|
我的任务视图 |
teamPreference -
JSON
|
项目组喜欢 |
templatePreference -
JSON
|
模版偏好 |
uuid -
String!
|
成员 uuid |
workloadPreference -
JSON
|
工作流程偏好 |
示例
{
"avatar": "abc123",
"collaborationScenes": ["xyz789"],
"dateFormatPreference": "xyz789",
"departments": [LarkDepartment],
"featureGuidePreference": {},
"fields": [Field],
"id": "abc123",
"isAppAdmin": true,
"isTemplateAdmin": false,
"languagePreference": "abc123",
"larkApp": LarkApp,
"larkUser": LarkUser,
"name": "xyz789",
"notificationPreference": {},
"notificationUnreadCount": 987,
"orderPreference": {},
"organization": Organization,
"pinyin": "abc123",
"pinyinAbbr": "xyz789",
"projectPreference": {},
"recentSearchHistory": [Search],
"searcher": Searcher,
"sidebarPreference": {},
"status": "abc123",
"subscribeProductDemoEnabled": true,
"tasksViews": [TasksView],
"teamPreference": {},
"templatePreference": {},
"uuid": "xyz789",
"workloadPreference": {}
}
MetaField
基础字段
字段名 | 描述 |
---|---|
canRemoved -
Boolean
|
是否可移除 |
canUpdate -
Boolean
|
是否可更新 |
category -
String!
|
字段类型,system 系统字段,custom 用户自定义字段 |
deletedAt -
ISO8601DateTime
|
删除时间 |
description -
String
|
字段描述 |
enabled -
Boolean
|
|
inputOptions -
JSON
|
选项值 |
inputType -
String!
|
字段类型,text 文本, number 数字, select 选择, datetime 日期, member 成员 |
intactInputOptions -
JSON
|
|
key -
String!
|
字段 key |
name -
String!
|
字段名称 |
pinyin -
String
|
|
pinyinAbbr -
String
|
|
public -
Boolean!
|
|
rootObjects - object[] |
|
scope -
String
|
范围,task 作用域为任务,team 作用域为项目组 |
settings -
JSON
|
|
templateKey -
String
|
团队模板字段 key |
uuid -
String!
|
字段 uuid |
示例
{
"canRemoved": false,
"canUpdate": true,
"category": "xyz789",
"deletedAt": ISO8601DateTime,
"description": "xyz789",
"enabled": true,
"inputOptions": {},
"inputType": "abc123",
"intactInputOptions": {},
"key": "abc123",
"name": "abc123",
"pinyin": "abc123",
"pinyinAbbr": "abc123",
"public": true,
"rootObjects": [null],
"scope": "abc123",
"settings": {},
"templateKey": "xyz789",
"uuid": "xyz789"
}
MetaFieldGroup
基础字段分组
字段名 | 描述 |
---|---|
metaFields -
[MetaField!]!
|
基础字段列表 |
name -
String
|
分组名称 |
template -
Boolean!
|
是否为模版 |
示例
{
"metaFields": [MetaField],
"name": "abc123",
"template": true
}
MetricsResult
统计结果
字段名 | 描述 |
---|---|
aggregator -
String!
|
统计项名称,none 不统计, count_all 数量, count_empty 空行数量, count_not_empty 非空行数量, count_unique 唯一值数量, percent_empty 空行占比, percent_not_empty 非空行占比, sum 求和, average 平均值, median 中间值, min 最小值, max 最大值, range 范围, earliest_date 最早, latest_date 最晚, date_range 时间范围 |
columnUuid -
String!
|
列字段 uuid |
groupUuid -
String!
|
分组 uuid |
uuid -
ID!
|
统计数据 uuid |
value -
String!
|
统计值 |
示例
{
"aggregator": "xyz789",
"columnUuid": "abc123",
"groupUuid": "abc123",
"uuid": ID,
"value": "xyz789"
}
Notification
消息
字段名 | 描述 |
---|---|
action -
String!
|
操作类型,如修改字段 |
createdAt -
ISO8601DateTime!
|
消息创建时间 |
detail -
JSON
|
消息详情 |
resourceType -
String!
|
资源类型,Team 项目组,Project 项目, Member 成员 |
status -
String!
|
消息状态,unread 未读, read 已读 |
uuid -
String!
|
消息 uuid |
示例
{
"action": "xyz789",
"createdAt": ISO8601DateTime,
"detail": {},
"resourceType": "xyz789",
"status": "abc123",
"uuid": "abc123"
}
NotificationGroup
消息
字段名 | 描述 |
---|---|
latestNotifiedAt -
ISO8601DateTime!
|
最新推送消息时间 |
notifications -
[Notification!]!
|
消息内容 |
sgid -
String!
|
消息 sgid |
status -
String!
|
消息状态,unread 未读, read 已读 |
subject -
NotificationSubjectInterface
|
消息主题 |
totalCount -
Int!
|
消息总数 |
示例
{
"latestNotifiedAt": ISO8601DateTime,
"notifications": [Notification],
"sgid": "abc123",
"status": "abc123",
"subject": NotificationSubjectInterface,
"totalCount": 123
}
NotificationSubjectTask
消息主题
字段名 | 描述 |
---|---|
category -
String!
|
任务类型,milestone 为里程碑, normal 为任务 |
completeStatus -
String!
|
完成状态, pending 待处理, in_progress 进行中, completed 已完成 |
name -
String!
|
主题名称 |
resourceType -
String!
|
资源类型 |
sgid -
String!
|
主题 sgid |
state -
State!
|
任务状态,取当前任务的任务流程状态值 |
uuid -
String!
|
主题 uuid |
示例
{
"category": "abc123",
"completeStatus": "abc123",
"name": "abc123",
"resourceType": "xyz789",
"sgid": "abc123",
"state": State,
"uuid": "abc123"
}
NumberField
字段名 | 描述 |
---|---|
inputType -
String!
|
字段类型 |
key -
String!
|
字段 key |
metaField -
MetaField!
|
基础字段 |
sgid -
String!
|
字段 sgid |
value -
String
|
示例
{
"inputType": "xyz789",
"key": "xyz789",
"metaField": MetaField,
"sgid": "abc123",
"value": "abc123"
}
Operation
操作提示
字段名 | 描述 |
---|---|
action -
String!
|
操作的具体类型,比如删除任务 |
canRevoke -
Boolean!
|
是否可撤销 |
createdAt -
ISO8601DateTime!
|
创建时间 |
details -
JSON
|
操作详情 |
revokedAt -
ISO8601DateTime
|
撤销时间 |
uuid -
String!
|
操作 uuid |
示例
{
"action": "abc123",
"canRevoke": false,
"createdAt": ISO8601DateTime,
"details": {},
"revokedAt": ISO8601DateTime,
"uuid": "abc123"
}
PaidPlan
付费计划
字段名 | 描述 |
---|---|
appAdmin -
Boolean
|
是否为飞书管理员 |
category -
String!
|
计划类型,free 免费版, expert 专业版 |
currentMemberAvailable -
Boolean
|
当前成员是否可用 |
freeMetaFieldUuids -
[String!]
|
|
planExpiredAt -
ISO8601DateTime
|
计划到期时间 |
planType -
String!
|
计划类型,free , active_day |
privileges -
[Privilege!]!
|
权限 |
uuid -
String!
|
计划 uuid |
示例
{
"appAdmin": true,
"category": "abc123",
"currentMemberAvailable": false,
"freeMetaFieldUuids": ["abc123"],
"planExpiredAt": ISO8601DateTime,
"planType": "abc123",
"privileges": [Privilege],
"uuid": "xyz789"
}
Privilege
字段名 | 描述 |
---|---|
category -
PrivilegeCategory!
|
|
limit -
Int
|
|
used -
Int
|
示例
{"category": PrivilegeCategory, "limit": 987, "used": 987}
Project
项目
字段名 | 描述 |
---|---|
accesses -
[VisibilityScopeIdentityInterface!]!
|
访问权限 |
canExportTasks -
Boolean!
|
是否支持导出任务 |
category -
String!
|
项目类型 |
color -
String
|
项目颜色 |
createdAt -
ISO8601DateTime!
|
创建时间 |
creator -
Member!
|
创建者 |
customFields -
[FieldInterface!]!
|
用户自定义字段 |
deletedAt -
ISO8601DateTime
|
删除时间 |
description -
String
|
项目描述 |
dueDate -
ISO8601DateTime
|
截止日期 |
dueTime -
ISO8601DateTime
|
截止时间 |
externalAccessRole -
String!
|
|
icon -
String
|
|
id -
String!
|
项目 id |
larkChat -
LarkChat
|
飞书群聊地址 |
latestStatusReport -
ProjectsStatusReport
|
最新状态 |
leader -
Member!
|
负责人 |
metaFields -
[MetaField!]!
|
基础字段 |
milestones -
[Task!]!
|
里程碑 |
name -
String!
|
项目名称 |
notificationTypeSettings -
JSON!
|
消息设置 |
organization -
Organization!
|
组织 |
permitLeave -
Boolean
|
是否允许退出项目 |
public -
Boolean!
|
是否为公开项目 |
role -
String
|
项目权限,edit 编辑权限, remark 仅可讨论 |
scenes -
[ProjectScene!]!
|
场景 |
sections -
[Section!]!
|
分组 |
sgid -
String!
|
|
startDate -
ISO8601DateTime
|
开始日期 |
startTime -
ISO8601DateTime
|
开始时间 |
status -
String!
|
项目状态 |
storyFeeds - object[] |
动态 |
teams -
[Team!]!
|
所属项目组 |
unusedSystemMetaFields -
[MetaField!]
|
未使用的系统字段 |
updatedAt -
ISO8601DateTime!
|
更新时间 |
uuid -
String!
|
项目 uuid |
示例
{
"accesses": [VisibilityScopeIdentityInterface],
"canExportTasks": true,
"category": "abc123",
"color": "abc123",
"createdAt": ISO8601DateTime,
"creator": Member,
"customFields": [FieldInterface],
"deletedAt": ISO8601DateTime,
"description": "abc123",
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"externalAccessRole": "abc123",
"icon": "xyz789",
"id": "xyz789",
"larkChat": LarkChat,
"latestStatusReport": ProjectsStatusReport,
"leader": Member,
"metaFields": [MetaField],
"milestones": [Task],
"name": "abc123",
"notificationTypeSettings": {},
"organization": Organization,
"permitLeave": true,
"public": false,
"role": "xyz789",
"scenes": [ProjectScene],
"sections": [Section],
"sgid": "xyz789",
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"status": "xyz789",
"storyFeeds": [null],
"teams": [Team],
"unusedSystemMetaFields": [MetaField],
"updatedAt": ISO8601DateTime,
"uuid": "xyz789"
}
ProjectConnection
The connection type for Project.
字段名 | 描述 |
---|---|
edges -
[ProjectEdge]
|
A list of edges. |
nodes -
[Project]
|
A list of nodes. |
pageInfo -
PageInfo!
|
Information to aid in pagination. |
variables -
JSON
|
示例
{
"edges": [ProjectEdge],
"nodes": [Project],
"pageInfo": PageInfo,
"variables": {}
}
ProjectCreation
项目创建
字段名 | 描述 |
---|---|
asTemplate -
Boolean
|
是否为模版 |
failedInfo -
String
|
失败信息 |
initLarkChat -
Boolean
|
|
project -
Project
|
项目 |
status -
String!
|
创建状态,queuing_for_initialization 请求中,initializing 进行中,success 成功 |
uuid -
String!
|
示例
{
"asTemplate": false,
"failedInfo": "abc123",
"initLarkChat": true,
"project": Project,
"status": "xyz789",
"uuid": "xyz789"
}
ProjectScene
项目场景
字段名 | 描述 |
---|---|
category -
String!
|
场景类型,progress 进展场景, task 任务场景 |
fields -
[Field!]
|
场景字段列表 |
id -
String!
|
场景 id |
metaFields -
[MetaField!]
|
基础字段列表 |
name -
String!
|
场景名称 |
onlineImport -
OnlineImport
|
|
position -
Float
|
场景位置 |
project -
Project!
|
项目 |
sections -
[Section!]!
|
分组 |
setting - object |
场景设置 |
sgid -
String!
|
|
tasksViews -
[TasksView!]!
|
任务视图列表 |
tasksWorkflow -
Workflow
|
任务工作流程 |
unusedSystemMetaFields -
[MetaField!]
|
未使用的系统字段列表 |
uuid -
String!
|
场景 uuid |
示例
{
"category": "xyz789",
"fields": [Field],
"id": "xyz789",
"metaFields": [MetaField],
"name": "xyz789",
"onlineImport": OnlineImport,
"position": 987.65,
"project": Project,
"sections": [Section],
"sgid": "xyz789",
"tasksViews": [TasksView],
"tasksWorkflow": Workflow,
"unusedSystemMetaFields": [MetaField],
"uuid": "abc123"
}
ProjectSceneTaskSetting
项目场景任务设置
字段名 | 描述 |
---|---|
currentGroupColumn -
String!
|
当前分组 |
currentSortColumn -
String!
|
当前排序字段 |
currentSortSequence -
String!
|
当前排序方式 |
currentView -
String!
|
当前视图 |
groupColumns -
[String!]!
|
分组列表 |
sortColumns -
[String!]!
|
排序字段列表 |
sortSequences -
[String!]!
|
排序方式 |
views -
[String!]!
|
视图列表 |
示例
{
"currentGroupColumn": "abc123",
"currentSortColumn": "abc123",
"currentSortSequence": "xyz789",
"currentView": "abc123",
"groupColumns": ["xyz789"],
"sortColumns": ["xyz789"],
"sortSequences": ["xyz789"],
"views": ["xyz789"]
}
ProjectTask
项目任务
字段名 | 描述 |
---|---|
id -
String!
|
任务 id |
isAncestor -
Boolean!
|
是否为祖先 |
project -
Project!
|
项目 |
scene -
ProjectScene!
|
场景 |
section -
Section!
|
分组 |
state -
State
|
状态 |
uuid -
String!
|
任务 uuid |
示例
{
"id": "abc123",
"isAncestor": false,
"project": Project,
"scene": ProjectScene,
"section": Section,
"state": State,
"uuid": "xyz789"
}
ProjectsAndTeams
项目及项目组
字段名 | 描述 |
---|---|
favoriteProjects -
[Project!]!
|
我关注项目 |
hasArchivedProjects -
Boolean!
|
已归档项目 |
joinedTeams -
[Team!]!
|
加入项目的项目 |
projectsWithoutTeam -
[Project!]!
|
无项目组项目 |
示例
{
"favoriteProjects": [Project],
"hasArchivedProjects": true,
"joinedTeams": [Team],
"projectsWithoutTeam": [Project]
}
ProjectsStatusReport
项目状态报告
字段名 | 描述 |
---|---|
createdAt -
ISO8601DateTime!
|
创建时间 |
creator -
Member!
|
创建人 |
editedAt -
ISO8601DateTime!
|
更新时间 |
formattedSummary -
String
|
格式化描述 |
status -
String!
|
项目状态, on_track 正常, at_risk 低风险, off_track 高风险 |
summary -
String
|
描述 |
title -
String!
|
标题 |
uuid -
String!
|
状态报告 uuid |
示例
{
"createdAt": ISO8601DateTime,
"creator": Member,
"editedAt": ISO8601DateTime,
"formattedSummary": "xyz789",
"status": "xyz789",
"summary": "abc123",
"title": "xyz789",
"uuid": "xyz789"
}
ReactableInterface
字段名 | 描述 |
---|---|
id -
String!
|
|
reactions -
[Reaction!]!
|
影响 |
reactors -
[Member!]!
|
影响人 |
示例
{
"id": "xyz789",
"reactions": [Reaction],
"reactors": [Member]
}
Reaction
影响
字段名 | 描述 |
---|---|
member -
Member!
|
成员 |
reactable -
ReactableInterface!
|
影响内容 |
示例
{
"member": Member,
"reactable": ReactableInterface
}
Remark
备注
字段名 | 描述 |
---|---|
content -
String!
|
内容 |
createdAt -
ISO8601DateTime!
|
创建时间 |
creator -
Member!
|
创建人 |
deletedAt -
ISO8601DateTime
|
删除时间 |
editedAt -
ISO8601DateTime!
|
更新时间 |
id -
String!
|
备注 id |
resource - object |
文件资源 |
uuid -
String!
|
备注 uuid |
示例
{
"content": "xyz789",
"createdAt": ISO8601DateTime,
"creator": Member,
"deletedAt": ISO8601DateTime,
"editedAt": ISO8601DateTime,
"id": "xyz789",
"uuid": "xyz789"
}
Repetition
循环任务设置
字段名 | 描述 |
---|---|
category -
String!
|
循环类型,固定两个选项:system 系统、custom 自定义 |
creator -
Member!
|
创建人 |
deletedAt -
ISO8601DateTime
|
删除时间 |
endDate -
ISO8601Date
|
循环停止日期 |
step -
Int!
|
循环步长 |
targets -
[Int!]
|
对自定义设置循环的具体描述,对不同「单位」,该值的取值范围会有不同目标选项
|
unit -
String!
|
循环单位,固定四个选项:day 天、week 周、month 月、year 年 |
uuid -
String!
|
循环设置的 uuid |
示例
{
"category": "xyz789",
"creator": Member,
"deletedAt": ISO8601DateTime,
"endDate": ISO8601Date,
"step": 987,
"targets": [987],
"unit": "abc123",
"uuid": "abc123"
}
Search
搜索
字段名 | 描述 |
---|---|
category -
String!
|
类型 |
creator -
Member!
|
创建人 |
keyword -
String
|
搜索关键字 |
name -
String
|
|
sgid -
String!
|
搜索记录 sgid |
tasksViews -
[TasksView!]!
|
任务视图 |
uuid -
String!
|
搜索记录 uuid |
示例
{
"category": "xyz789",
"creator": Member,
"keyword": "abc123",
"name": "xyz789",
"sgid": "abc123",
"tasksViews": [TasksView],
"uuid": "abc123"
}
Searcher
搜索人
字段名 | 描述 |
---|---|
fields -
[Field!]
|
字段值 |
fieldsColumns -
[FieldsColumn!]!
|
字段值所在列 |
id -
String!
|
搜索人 id |
示例
{
"fields": [Field],
"fieldsColumns": [FieldsColumn],
"id": "abc123"
}
State
任务流程状态
字段名 | 描述 |
---|---|
canRemoved -
Boolean
|
是否可删除 |
color -
String
|
状态颜色 |
completeStatus -
String!
|
完成状态,固定三个状态值,pending 待处理、 in_progress 进行中、 completed 已完成 |
default -
Boolean!
|
是否为默认状态 |
key -
String!
|
状态 key |
name -
String!
|
状态名称 |
position -
Float
|
位置 |
sgid -
String!
|
状态 sgid |
tasksCount -
Int!
|
任务数 |
uuid -
String!
|
状态 uuid |
workflow -
Workflow!
|
任务流程 |
示例
{
"canRemoved": true,
"color": "abc123",
"completeStatus": "xyz789",
"default": false,
"key": "xyz789",
"name": "abc123",
"position": 987.65,
"sgid": "xyz789",
"tasksCount": 987,
"uuid": "xyz789",
"workflow": Workflow
}
Task
任务
字段名 | 描述 |
---|---|
ancestors -
[Task!]!
|
层级父任务 |
assignee -
Member
|
负责人 |
category -
String!
|
任务类型,milestone 为里程碑, normal 为任务 |
collaborators -
[VisibilityScopeIdentityInterface!]!
|
协作者 |
completeStatus -
String!
|
任务完成状态,pending 待处理、 in_progress 进行中、 completed 已完成 |
completedAt -
ISO8601DateTime
|
完成时间 |
completer -
Member
|
完成人 |
coverImageAttachment -
Attachment
|
|
createdAt -
ISO8601DateTime
|
创建时间 |
creator -
Member
|
创建人 |
customFields -
[FieldInterface!]!
|
用户自定义字段 |
deletedAt -
ISO8601DateTime
|
删除时间 |
dependencies -
[TasksDependency!]!
|
前置任务 |
description -
String
|
任务描述 |
dueDate -
ISO8601DateTime
|
截止日期 |
dueTime -
ISO8601DateTime
|
截止时间 |
editor -
Member
|
最近编辑人 |
followUpDependencies -
[TasksDependency!]!
|
后续任务 |
followUpDescendants -
[Task!]
|
|
id -
String!
|
任务 id |
isAssigneeRead -
Boolean!
|
负责人是否已读 |
isCollaborator -
Boolean!
|
是否为协作者 |
keyMarks -
JSON
|
关键属性标识 |
larkChat -
LarkChat
|
飞书群聊 |
larkFiles -
[LarkFile!]!
|
飞书文档 |
metaFields -
[MetaField!]
|
任务展示字段 |
parent -
Task
|
父任务 |
persisted -
Boolean!
|
|
projects -
[Project!]
|
|
reactions -
[Reaction!]!
|
影响 |
reactors -
[Member!]!
|
影响人 |
repetition -
Repetition
|
循环任务设置 |
role -
String
|
权限,edit 可编辑, remark 仅可讨论 |
scenes -
[ProjectScene!]
|
所属场景 |
sections -
[Section!]
|
|
sgid -
String!
|
任务 sgid |
startDate -
ISO8601DateTime
|
开始日期 |
startTime -
ISO8601DateTime
|
开始时间 |
state -
State!
|
自定义任务状态 |
storyFeeds - object[] |
任务动态 |
subtasks -
[Task!]!
|
子任务 |
tasksProjects -
[ProjectTask!]!
|
所属项目 |
title -
String!
|
任务标题 |
uniqueId -
Int!
|
任务ID |
updatedAt -
ISO8601DateTime
|
最近更新时间 |
uuid -
String!
|
任务 uuid |
workflow -
Workflow!
|
任务流程 |
示例
{
"ancestors": [Task],
"assignee": Member,
"category": "abc123",
"collaborators": [VisibilityScopeIdentityInterface],
"completeStatus": "abc123",
"completedAt": ISO8601DateTime,
"completer": Member,
"coverImageAttachment": Attachment,
"createdAt": ISO8601DateTime,
"creator": Member,
"customFields": [FieldInterface],
"deletedAt": ISO8601DateTime,
"dependencies": [TasksDependency],
"description": "abc123",
"dueDate": ISO8601DateTime,
"dueTime": ISO8601DateTime,
"editor": Member,
"followUpDependencies": [TasksDependency],
"followUpDescendants": [Task],
"id": "abc123",
"isAssigneeRead": true,
"isCollaborator": false,
"keyMarks": {},
"larkChat": LarkChat,
"larkFiles": [LarkFile],
"metaFields": [MetaField],
"parent": Task,
"persisted": false,
"projects": [Project],
"reactions": [Reaction],
"reactors": [Member],
"repetition": Repetition,
"role": "xyz789",
"scenes": [ProjectScene],
"sections": [Section],
"sgid": "abc123",
"startDate": ISO8601DateTime,
"startTime": ISO8601DateTime,
"state": State,
"storyFeeds": [null],
"subtasks": [Task],
"tasksProjects": [ProjectTask],
"title": "xyz789",
"uniqueId": 987,
"updatedAt": ISO8601DateTime,
"uuid": "abc123",
"workflow": Workflow
}
TasksDependency
任务依赖
字段名 | 描述 |
---|---|
deletedAt -
ISO8601DateTime
|
删除时间 |
dependentTask -
Task!
|
前置任务 |
task -
Task!
|
当前任务 |
uuid -
String!
|
依赖 uuid |
示例
{
"deletedAt": ISO8601DateTime,
"dependentTask": Task,
"task": Task,
"uuid": "xyz789"
}
TasksView
任务视图
字段名 | 描述 |
---|---|
category -
String!
|
|
creator -
Member!
|
|
deletedAt -
ISO8601DateTime
|
删除时间 |
displayMode -
String!
|
展示方式, list 列表视图, board 看板视图, gantt 甘特视图 |
fieldsColumns -
[FieldsColumn!]!
|
字段列 |
filterBuilder -
FilterBuilder!
|
筛选器 |
name -
String!
|
视图名称 |
persisted -
Boolean!
|
是否存在 |
selected -
Boolean!
|
是否被选中 |
sgid -
String
|
视图 sgid |
uuid -
String!
|
视图 uuid |
示例
{
"category": "xyz789",
"creator": Member,
"deletedAt": ISO8601DateTime,
"displayMode": "xyz789",
"fieldsColumns": [FieldsColumn],
"filterBuilder": FilterBuilder,
"name": "xyz789",
"persisted": true,
"selected": true,
"sgid": "xyz789",
"uuid": "abc123"
}
Team
项目组
字段名 | 描述 |
---|---|
createdAt -
ISO8601DateTime!
|
创建时间 |
creator -
Member!
|
创建人 |
deletedAt -
ISO8601DateTime
|
删除时间 |
fields -
[Field!]!
|
自定义字段值 |
filterBuilder -
FilterBuilder
|
筛选器 |
leader -
Member!
|
负责人 |
name -
String!
|
项目组名称 |
organization -
Organization!
|
组织 |
permitLeave -
Boolean
|
是否允许退出项目组 |
position -
Float
|
位置 |
projects -
[Project!]!
|
项目 |
Arguments |
|
public -
Boolean!
|
是否公开 |
sgid -
String!
|
项目组 sgid |
teammates -
[VisibilityScopeIdentityInterface!]!
|
项目组成员 |
uuid -
String!
|
项目组 uuid |
示例
{
"createdAt": ISO8601DateTime,
"creator": Member,
"deletedAt": ISO8601DateTime,
"fields": [Field],
"filterBuilder": FilterBuilder,
"leader": Member,
"name": "abc123",
"organization": Organization,
"permitLeave": false,
"position": 987.65,
"projects": [Project],
"public": false,
"sgid": "xyz789",
"teammates": [VisibilityScopeIdentityInterface],
"uuid": "xyz789"
}
TextField
字段名 | 描述 |
---|---|
inputType -
String!
|
字段类型 |
key -
String!
|
字段 key |
metaField -
MetaField!
|
基础字段 |
sgid -
String!
|
字段 sgid |
value -
String
|
示例
{
"inputType": "xyz789",
"key": "xyz789",
"metaField": MetaField,
"sgid": "abc123",
"value": "abc123"
}
Workflow
任务流程
字段名 | 描述 |
---|---|
asTemplate -
Boolean!
|
是否为模版 |
category -
String!
|
任务流程类型,system 系统、custom 自定义 |
default -
Boolean!
|
是否为默认 |
deletedAt -
ISO8601DateTime
|
删除时间 |
key -
String!
|
任务流程 key |
name -
String!
|
任务流程名称 |
projects -
[Project!]!
|
项目 |
sgid -
String!
|
任务流程 sgid |
states -
[State!]!
|
任务流程状态 |
templateKey -
String
|
模版 key |
uuid -
String!
|
任务流程 uuid |
示例
{
"asTemplate": false,
"category": "xyz789",
"default": false,
"deletedAt": ISO8601DateTime,
"key": "abc123",
"name": "abc123",
"projects": [Project],
"sgid": "abc123",
"states": [State],
"templateKey": "xyz789",
"uuid": "xyz789"
}
WorkloadConnection
The connection type for Workload.
字段名 | 描述 |
---|---|
edges -
[WorkloadEdge]
|
A list of edges. |
nodes -
[Workload]
|
A list of nodes. |
pageInfo -
PageInfo!
|
Information to aid in pagination. |
variables -
JSON
|
变量 |
示例
{
"edges": [WorkloadEdge],
"nodes": [Workload],
"pageInfo": PageInfo,
"variables": {}
}
AddDashboardAccessesMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
dashboard -
Dashboard!
|
|
errors -
[BaseError!]
|
示例
{
"dashboard": Dashboard,
"errors": [BaseError]
}
AddProjectAccessesMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
project -
Project!
|
示例
{
"errors": [BaseError],
"project": Project
}
AddTaskDependencyMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksDependency -
TasksDependency!
|
示例
{
"errors": [BaseError],
"tasksDependency": TasksDependency
}
AddTaskToSceneMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
conflictScene -
ConflictScene
|
|
errors -
[BaseError!]
|
|
task -
Task
|
示例
{
"conflictScene": ConflictScene,
"errors": [BaseError],
"task": Task
}
AddTeamProjectsMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
team -
Team!
|
示例
{
"errors": [BaseError],
"team": Team
}
AddTeammatesMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
team -
Team!
|
示例
{
"errors": [BaseError],
"team": Team
}
CreateChartMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
chart -
Chart!
|
|
errors -
[BaseError!]
|
示例
{
"chart": Chart,
"errors": [BaseError]
}
CreateDashboardMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
dashboard -
Dashboard!
|
|
errors -
[BaseError!]
|
示例
{
"dashboard": Dashboard,
"errors": [BaseError]
}
CreateFieldMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
field -
Field!
|
示例
{
"errors": [BaseError],
"field": Field
}
CreateLarkCalendarEventMutationPayload
创建飞书日程 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
larkCalendarEvent -
LarkCalendarEvent
|
示例
{
"errors": [BaseError],
"larkCalendarEvent": LarkCalendarEvent
}
CreateLarkCalendarMutationPayload
创建飞书日历 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
larkCalendar -
LarkCalendar!
|
示例
{
"errors": [BaseError],
"larkCalendar": LarkCalendar
}
CreateLarkFileMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
larkFile -
LarkFile!
|
|
task -
Task
|
示例
{
"errors": [BaseError],
"larkFile": LarkFile,
"task": Task
}
CreateMemberTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
conflictScenes -
[ProjectScene!]
|
|
errors -
[BaseError!]
|
|
section -
Section
|
|
task -
Task
|
示例
{
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"section": Section,
"task": Task
}
CreateProjectMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
projectCreation -
ProjectCreation
|
示例
{
"errors": [BaseError],
"projectCreation": ProjectCreation
}
CreateProjectSceneMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
projectScene -
ProjectScene!
|
示例
{
"errors": [BaseError],
"projectScene": ProjectScene
}
CreateProjectSceneTaskGroupMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
group -
ListTaskGroup!
|
示例
{
"errors": [BaseError],
"group": ListTaskGroup
}
CreateProjectTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
conflictScenes -
[ProjectScene!]
|
|
errors -
[BaseError!]
|
|
section -
Section
|
|
task -
Task
|
示例
{
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"section": Section,
"task": Task
}
CreateProjectsStatusReportMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
statusReport -
ProjectsStatusReport!
|
示例
{
"errors": [BaseError],
"statusReport": ProjectsStatusReport
}
CreateReactionMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
reactable -
ReactableInterface!
|
示例
{
"errors": [BaseError],
"reactable": ReactableInterface
}
CreateRemarkMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
remark -
Remark!
|
|
resource - object |
示例
{
"errors": [BaseError],
"remark": Remark
}
CreateSearchMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
search -
Search!
|
示例
{
"errors": [BaseError],
"search": Search
}
CreateTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
conflictScenes -
[ProjectScene!]
|
|
errors -
[BaseError!]
|
|
section -
Section
|
|
task -
Task
|
示例
{
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"section": Section,
"task": Task
}
CreateTaskRepetitionMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
taskRepetition -
Repetition
|
示例
{
"errors": [BaseError],
"taskRepetition": Repetition
}
CreateTasksStateMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksState -
State!
|
示例
{
"errors": [BaseError],
"tasksState": State
}
CreateTasksViewMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksView -
TasksView!
|
示例
{
"errors": [BaseError],
"tasksView": TasksView
}
CreateTasksWorkflowMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksWorkflow -
Workflow!
|
示例
{
"errors": [BaseError],
"tasksWorkflow": Workflow
}
CreateTeamMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
team -
Team
|
示例
{
"errors": [BaseError],
"team": Team
}
DestroyChartMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
chart -
Chart!
|
|
errors -
[BaseError!]
|
示例
{
"chart": Chart,
"errors": [BaseError]
}
DestroyDashboardMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
dashboard -
Dashboard!
|
|
errors -
[BaseError!]
|
示例
{
"dashboard": Dashboard,
"errors": [BaseError]
}
DestroyFieldMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
field -
Field
|
示例
{
"errors": [BaseError],
"field": Field
}
DestroyProjectMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
project -
Project
|
示例
{
"errors": [BaseError],
"project": Project
}
DestroyProjectSceneMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
projectScene -
ProjectScene
|
示例
{
"errors": [BaseError],
"projectScene": ProjectScene
}
DestroyReactionMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
reactable -
ReactableInterface!
|
示例
{
"errors": [BaseError],
"reactable": ReactableInterface
}
DestroyRemarkMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
remark -
Remark
|
示例
{
"errors": [BaseError],
"remark": Remark
}
DestroySectionMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
section -
Section
|
示例
{
"errors": [BaseError],
"section": Section
}
DestroyTaskLarkFileMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
DestroyTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task
|
示例
{
"errors": [BaseError],
"task": Task
}
DestroyTaskRepetitionMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
taskRepetition -
Repetition
|
示例
{
"errors": [BaseError],
"taskRepetition": Repetition
}
DestroyTasksStateMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksState -
State!
|
示例
{
"errors": [BaseError],
"tasksState": State
}
DestroyTasksViewMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksView -
TasksView!
|
示例
{
"errors": [BaseError],
"tasksView": TasksView
}
DestroyTasksWorkflowMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksWorkflow -
Workflow!
|
示例
{
"errors": [BaseError],
"tasksWorkflow": Workflow
}
DestroyTeamMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
team -
Team
|
示例
{
"errors": [BaseError],
"team": Team
}
DuplicateDashboardMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
dashboard -
Dashboard!
|
|
errors -
[BaseError!]
|
示例
{
"dashboard": Dashboard,
"errors": [BaseError]
}
JoinTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
LeaveTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
MoveChartMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
chart -
Chart!
|
|
errors -
[BaseError!]
|
示例
{
"chart": Chart,
"errors": [BaseError]
}
MoveTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
conflictScene -
ConflictScene
|
|
errors -
[BaseError!]
|
|
task -
Task
|
示例
{
"conflictScene": ConflictScene,
"errors": [BaseError],
"task": Task
}
RemindTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
RemoveDashboardAccessesMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
dashboard -
Dashboard!
|
|
errors -
[BaseError!]
|
示例
{
"dashboard": Dashboard,
"errors": [BaseError]
}
RemoveTaskCollaboratorsMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
RemoveTaskDependencyMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksDependency -
TasksDependency!
|
示例
{
"errors": [BaseError],
"tasksDependency": TasksDependency
}
RemoveTaskFromSceneMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
UpdateChartMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
chart -
Chart!
|
|
errors -
[BaseError!]
|
示例
{
"chart": Chart,
"errors": [BaseError]
}
UpdateDashboardMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
dashboard -
Dashboard!
|
|
errors -
[BaseError!]
|
示例
{
"dashboard": Dashboard,
"errors": [BaseError]
}
UpdateFieldMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
field -
Field!
|
示例
{
"errors": [BaseError],
"field": Field
}
UpdatePositionMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
success -
Boolean!
|
示例
{"errors": [BaseError], "success": false}
UpdateProjectAccessesMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
project -
Project!
|
示例
{
"errors": [BaseError],
"project": Project
}
UpdateProjectMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
hasAccess -
Boolean
|
|
project -
Project
|
示例
{
"errors": [BaseError],
"hasAccess": false,
"project": Project
}
UpdateProjectSceneMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
conflictScenes -
[ProjectScene!]
|
|
errors -
[BaseError!]
|
|
projectScene -
ProjectScene
|
示例
{
"conflictScenes": [ProjectScene],
"errors": [BaseError],
"projectScene": ProjectScene
}
UpdateProjectStatusMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
project -
Project
|
示例
{
"errors": [BaseError],
"project": Project
}
UpdateProjectsStatusReportMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
statusReport -
ProjectsStatusReport!
|
示例
{
"errors": [BaseError],
"statusReport": ProjectsStatusReport
}
UpdateRemarkMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
remark -
Remark
|
|
resource - object |
示例
{
"errors": [BaseError],
"remark": Remark
}
UpdateSectionMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
section -
Section
|
示例
{
"errors": [BaseError],
"section": Section
}
UpdateTaskCategoryMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
UpdateTaskCollaboratorsMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task!
|
示例
{
"errors": [BaseError],
"task": Task
}
UpdateTaskMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
task -
Task
|
示例
{
"errors": [BaseError],
"task": Task
}
UpdateTaskParentMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
conflictScene -
ConflictScene
|
|
errors -
[BaseError!]
|
|
task -
Task
|
示例
{
"conflictScene": ConflictScene,
"errors": [BaseError],
"task": Task
}
UpdateTasksStateMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksState -
State!
|
示例
{
"errors": [BaseError],
"tasksState": State
}
UpdateTasksViewFieldMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
column -
FieldsColumn!
|
|
errors -
[BaseError!]
|
|
field -
Field!
|
示例
{
"column": FieldsColumn,
"errors": [BaseError],
"field": Field
}
UpdateTasksViewFilterFormMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
filterBuilder -
FilterBuilder!
|
示例
{
"errors": [BaseError],
"filterBuilder": FilterBuilder
}
UpdateTasksViewMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksView -
TasksView!
|
示例
{
"errors": [BaseError],
"tasksView": TasksView
}
UpdateTasksWorkflowMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
tasksWorkflow -
Workflow!
|
示例
{
"errors": [BaseError],
"tasksWorkflow": Workflow
}
UpdateTeamMutationPayload
数据变更 Payload
字段名 | 描述 |
---|---|
errors -
[BaseError!]
|
|
team -
Team
|
示例
{
"errors": [BaseError],
"team": Team
}