Reference documentation for GraphQL schema types in the Projects category.

在本文中

Mutations

addProjectV2DraftIssue

Mutation

Creates a new draft issue and add it to a Project.

输入 addProjectV2DraftIssue 字段

返回 addProjectV2DraftIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectItem (ProjectV2Item)

The draft issue added to the project.

addProjectV2ItemById

Mutation

Links an existing content instance to a Project.

输入 addProjectV2ItemById 字段

返回 addProjectV2ItemById 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item added to the project.

archiveProjectV2Item

Mutation

Archives a ProjectV2Item.

输入 archiveProjectV2Item 字段

返回 archiveProjectV2Item 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item archived from the project.

clearProjectV2ItemFieldValue

Mutation

This mutation clears the value of a field for an item in a Project. Currently only text, number, date, assignees, labels, single-select, iteration and milestone fields are supported.

输入 clearProjectV2ItemFieldValue 字段

返回 clearProjectV2ItemFieldValue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

convertProjectV2DraftIssueItemToIssue

Mutation

Converts a projectV2 draft issue item to an issue.

输入 convertProjectV2DraftIssueItemToIssue 字段

返回 convertProjectV2DraftIssueItemToIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The updated project item.

copyProjectV2

Mutation

Copy a project.

输入 copyProjectV2 字段

返回 copyProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The copied project.

createProjectV2

Mutation

Creates a new project.

输入 createProjectV2 字段

返回 createProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The new project.

createProjectV2Field

Mutation

Create a new project field.

输入 createProjectV2Field 字段

返回 createProjectV2Field 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The new field.

createProjectV2IssueField

Mutation

Create a new project issue field.

输入 createProjectV2IssueField 字段

返回 createProjectV2IssueField 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The new field.

createProjectV2StatusUpdate

Mutation

Creates a status update within a Project.

输入 createProjectV2StatusUpdate 字段

返回 createProjectV2StatusUpdate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

statusUpdate (ProjectV2StatusUpdate)

The status update updated in the project.

deleteProjectV2

Mutation

Delete a project.

输入 deleteProjectV2 字段

返回 deleteProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The deleted Project.

deleteProjectV2Field

Mutation

Delete a project field.

输入 deleteProjectV2Field 字段

返回 deleteProjectV2Field 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The deleted field.

deleteProjectV2Item

Mutation

Deletes an item from a Project.

输入 deleteProjectV2Item 字段

返回 deleteProjectV2Item 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedItemId (ID)

The ID of the deleted item.

deleteProjectV2StatusUpdate

Mutation

Deletes a project status update.

输入 deleteProjectV2StatusUpdate 字段

返回 deleteProjectV2StatusUpdate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedStatusUpdateId (ID)

The ID of the deleted status update.

projectV2 (ProjectV2)

The project the deleted status update was in.

deleteProjectV2Workflow

Mutation

Deletes a project workflow.

输入 deleteProjectV2Workflow 字段

返回 deleteProjectV2Workflow 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedWorkflowId (ID)

The ID of the deleted workflow.

projectV2 (ProjectV2)

The project the deleted workflow was in.

linkProjectV2ToRepository

Mutation

Links a project to a repository.

输入 linkProjectV2ToRepository 字段

返回 linkProjectV2ToRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is linked to.

linkProjectV2ToTeam

Mutation

Links a project to a team.

输入 linkProjectV2ToTeam 字段

返回 linkProjectV2ToTeam 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is linked to.

markProjectV2AsTemplate

Mutation

Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template.

输入 markProjectV2AsTemplate 字段

返回 markProjectV2AsTemplate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

unarchiveProjectV2Item

Mutation

Unarchives a ProjectV2Item.

输入 unarchiveProjectV2Item 字段

返回 unarchiveProjectV2Item 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item unarchived from the project.

unlinkProjectV2FromRepository

Mutation

Unlinks a project from a repository.

输入 unlinkProjectV2FromRepository 字段

返回 unlinkProjectV2FromRepository 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is no longer linked to.

unlinkProjectV2FromTeam

Mutation

Unlinks a project to a team.

输入 unlinkProjectV2FromTeam 字段

返回 unlinkProjectV2FromTeam 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is unlinked from.

unmarkProjectV2AsTemplate

Mutation

Unmark a project as a template.

输入 unmarkProjectV2AsTemplate 字段

返回 unmarkProjectV2AsTemplate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

updateProjectV2

Mutation

Updates an existing project.

输入 updateProjectV2 字段

返回 updateProjectV2 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The updated Project.

updateProjectV2Collaborators

Mutation

Update the collaborators on a team or a project.

输入 updateProjectV2Collaborators 字段

返回 updateProjectV2Collaborators 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

collaborators (ProjectV2ActorConnection)

The collaborators granted a role.

updateProjectV2DraftIssue

Mutation

Updates a draft issue within a Project.

输入 updateProjectV2DraftIssue 字段

返回 updateProjectV2DraftIssue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssue (DraftIssue)

The draft issue updated in the project.

updateProjectV2Field

Mutation

Update a project field.

输入 updateProjectV2Field 字段

返回 updateProjectV2Field 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The updated field.

updateProjectV2ItemFieldValue

Mutation

This mutation updates the value of a field for an item in a Project. Currently only single-select, text, number, date, and iteration fields are supported.

输入 updateProjectV2ItemFieldValue 字段

返回 updateProjectV2ItemFieldValue 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

updateProjectV2ItemPosition

Mutation

This mutation updates the position of the item in the project, where the position represents the priority of an item.

输入 updateProjectV2ItemPosition 字段

返回 updateProjectV2ItemPosition 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

items (ProjectV2ItemConnection)

The items in the new order.

updateProjectV2StatusUpdate

Mutation

Updates a status update within a Project.

输入 updateProjectV2StatusUpdate 字段

返回 updateProjectV2StatusUpdate 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

statusUpdate (ProjectV2StatusUpdate)

The status update updated in the project.

Objects

AddedToProjectV2Event

Object

Represents aadded_to_project_v2event on a given issue or pull request.

AddedToProjectV2Event 实现

AddedToProjectV2Event 字段

名称说明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AddedToProjectV2Event object.

project (ProjectV2)

Project referenced by event.

wasAutomated (Boolean!)

Did this event result from workflow automation?.

DraftIssue

Object

A draft issue within a project.

DraftIssue 实现

DraftIssue 字段

名称说明

assignees (UserConnection!)

A list of users to assigned to this draft issue.

assignees 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

body (String!)

The body of the draft issue.

bodyHTML (HTML!)

The body of the draft issue rendered to HTML.

bodyText (String!)

The body of the draft issue rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created this draft issue.

id (ID!)

The Node ID of the DraftIssue object.

projectV2Items (ProjectV2ItemConnection!)

List of items linked with the draft issue (currently draft issue can be linked to only one item).

projectV2Items 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

projectsV2 (ProjectV2Connection!)

Projects that link to this draft issue (currently draft issue can be linked to only one project).

projectsV2 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

title (String!)

The title of the draft issue.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2

Object

New projects that manage issues, pull requests and drafts using tables and boards.

ProjectV2 实现

ProjectV2 字段

名称说明

closed (Boolean!)

Returns true if the project is closed.

closedAt (DateTime)

Identifies the date and time when the object was closed.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who originally created the project.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.

field (ProjectV2FieldConfiguration)

A field of the project.

field 的参数

  • name (String!)

    The name of the field.

fields (ProjectV2FieldConfigurationConnection!)

List of fields and their constraints in the project.

fields 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2FieldOrder)

    Ordering options for project v2 fields returned from the connection.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

id (ID!)

The Node ID of the ProjectV2 object.

items (ProjectV2ItemConnection!)

List of items in the project.

items 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2ItemOrder)

    Ordering options for project v2 items returned from the connection.

  • query (String)

    Search query for filtering items.

    The default value is .

number (Int!)

The project's number.

owner (ProjectV2Owner!)

The project's owner. Currently limited to organizations and users.

public (Boolean!)

Returns true if the project is public.

readme (String)

The project's readme.

repositories (RepositoryConnection!)

The repositories the project is linked to.

repositories 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (RepositoryOrder)

    Ordering options for repositories returned from the connection.

resourcePath (URI!)

The HTTP path for this project.

shortDescription (String)

The project's short description.

statusUpdates (ProjectV2StatusUpdateConnection!)

List of the status updates in the project.

statusUpdates 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

teams (TeamConnection!)

The teams the project is linked to.

teams 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (TeamOrder)

    Ordering options for teams returned from this connection.

template (Boolean!)

Returns true if this project is a template.

title (String!)

The project's name.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this project.

view (ProjectV2View)

A view of the project.

view 的参数

  • number (Int!)

    The number of a view belonging to the project.

viewerCanClose (Boolean!)

Indicates if the object can be closed by the viewer.

viewerCanReopen (Boolean!)

Indicates if the object can be reopened by the viewer.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

views (ProjectV2ViewConnection!)

List of views in the project.

views 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2ViewOrder)

    Ordering options for project v2 views returned from the connection.

workflow (ProjectV2Workflow)

A workflow of the project.

workflow 的参数

  • number (Int!)

    The number of a workflow belonging to the project.

workflows (ProjectV2WorkflowConnection!)

List of the workflows in the project.

workflows 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

ProjectV2ActorConnection

Object

The connection type for ProjectV2Actor.

ProjectV2ActorConnection 字段

名称说明

edges ([ProjectV2ActorEdge])

A list of edges.

nodes ([ProjectV2Actor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2ActorEdge

Object

An edge in a connection.

ProjectV2ActorEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2Actor)

The item at the end of the edge.

ProjectV2Connection

Object

The connection type for ProjectV2.

ProjectV2Connection 字段

名称说明

edges ([ProjectV2Edge])

A list of edges.

nodes ([ProjectV2])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2Edge

Object

An edge in a connection.

ProjectV2Edge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2)

The item at the end of the edge.

ProjectV2Field

Object

A field inside a project.

ProjectV2Field 实现

ProjectV2Field 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

dataType (ProjectV2FieldType!)

The field's type.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ProjectV2Field object.

name (String!)

The project field's name.

project (ProjectV2!)

The project that contains this field.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2FieldConfigurationConnection

Object

The connection type for ProjectV2FieldConfiguration.

ProjectV2FieldConfigurationConnection 字段

名称说明

edges ([ProjectV2FieldConfigurationEdge])

A list of edges.

nodes ([ProjectV2FieldConfiguration])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2FieldConfigurationEdge

Object

An edge in a connection.

ProjectV2FieldConfigurationEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2FieldConfiguration)

The item at the end of the edge.

ProjectV2FieldConnection

Object

The connection type for ProjectV2Field.

ProjectV2FieldConnection 字段

名称说明

edges ([ProjectV2FieldEdge])

A list of edges.

nodes ([ProjectV2Field])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2FieldEdge

Object

An edge in a connection.

ProjectV2FieldEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2Field)

The item at the end of the edge.

ProjectV2Item

Object

An item within a Project.

ProjectV2Item 实现

ProjectV2Item 字段

名称说明

content (ProjectV2ItemContent)

The content of the referenced draft issue, issue, pull request.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the item.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.

fieldValueByName (ProjectV2ItemFieldValue)

The field value of the first project field which matches thenameargument that is set on the item.

fieldValueByName 的参数

  • name (String!)

    The name of the field to return the field value of.

fieldValues (ProjectV2ItemFieldValueConnection!)

The field values that are set on the item.

fieldValues 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

id (ID!)

The Node ID of the ProjectV2Item object.

isArchived (Boolean!)

Whether the item is archived.

project (ProjectV2!)

The project that contains this item.

type (ProjectV2ItemType!)

The type of the item.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2ItemConnection

Object

The connection type for ProjectV2Item.

ProjectV2ItemConnection 字段

名称说明

edges ([ProjectV2ItemEdge])

A list of edges.

nodes ([ProjectV2Item])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2ItemEdge

Object

An edge in a connection.

ProjectV2ItemEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2Item)

The item at the end of the edge.

ProjectV2ItemFieldDateValue

Object

The value of a date field in a Project item.

ProjectV2ItemFieldDateValue 实现

ProjectV2ItemFieldDateValue 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the item.

databaseId (Int)

Identifies the primary key from the database.

date (Date)

Date value for the field.

field (ProjectV2FieldConfiguration!)

The project field that contains this value.

id (ID!)

The Node ID of the ProjectV2ItemFieldDateValue object.

item (ProjectV2Item!)

The project item that contains this value.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2ItemFieldIterationValue

Object

The value of an iteration field in a Project item.

ProjectV2ItemFieldIterationValue 实现

ProjectV2ItemFieldIterationValue 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the item.

databaseId (Int)

Identifies the primary key from the database.

duration (Int!)

The duration of the iteration in days.

field (ProjectV2FieldConfiguration!)

The project field that contains this value.

id (ID!)

The Node ID of the ProjectV2ItemFieldIterationValue object.

item (ProjectV2Item!)

The project item that contains this value.

iterationId (String!)

The ID of the iteration.

startDate (Date!)

The start date of the iteration.

title (String!)

The title of the iteration.

titleHTML (String!)

The title of the iteration, with HTML.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2ItemFieldLabelValue

Object

The value of the labels field in a Project item.

ProjectV2ItemFieldLabelValue 字段

名称说明

field (ProjectV2FieldConfiguration!)

The field that contains this value.

labels (LabelConnection)

Labels value of a field.

labels 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

ProjectV2ItemFieldMilestoneValue

Object

The value of a milestone field in a Project item.

ProjectV2ItemFieldMilestoneValue 字段

名称说明

field (ProjectV2FieldConfiguration!)

The field that contains this value.

milestone (Milestone)

Milestone value of a field.

ProjectV2ItemFieldNumberValue

Object

The value of a number field in a Project item.

ProjectV2ItemFieldNumberValue 实现

ProjectV2ItemFieldNumberValue 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the item.

databaseId (Int)

Identifies the primary key from the database.

field (ProjectV2FieldConfiguration!)

The project field that contains this value.

id (ID!)

The Node ID of the ProjectV2ItemFieldNumberValue object.

item (ProjectV2Item!)

The project item that contains this value.

number (Float)

Number as a float(8).

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2ItemFieldPullRequestValue

Object

The value of a pull request field in a Project item.

ProjectV2ItemFieldPullRequestValue 字段

名称说明

field (ProjectV2FieldConfiguration!)

The field that contains this value.

pullRequests (PullRequestConnection)

The pull requests for this field.

pullRequests 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

ProjectV2ItemFieldRepositoryValue

Object

The value of a repository field in a Project item.

ProjectV2ItemFieldRepositoryValue 字段

名称说明

field (ProjectV2FieldConfiguration!)

The field that contains this value.

repository (Repository)

The repository for this field.

ProjectV2ItemFieldReviewerValue

Object

The value of a reviewers field in a Project item.

ProjectV2ItemFieldReviewerValue 字段

名称说明

field (ProjectV2FieldConfiguration!)

The field that contains this value.

reviewers (RequestedReviewerConnection)

The reviewers for this field.

reviewers 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

ProjectV2ItemFieldSingleSelectValue

Object

The value of a single select field in a Project item.

ProjectV2ItemFieldSingleSelectValue 实现

ProjectV2ItemFieldSingleSelectValue 字段

名称说明

color (ProjectV2SingleSelectFieldOptionColor!)

The color applied to the selected single-select option.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the item.

databaseId (Int)

Identifies the primary key from the database.

description (String)

A plain-text description of the selected single-select option, such as what the option means.

descriptionHTML (String)

The description of the selected single-select option, including HTML tags.

field (ProjectV2FieldConfiguration!)

The project field that contains this value.

id (ID!)

The Node ID of the ProjectV2ItemFieldSingleSelectValue object.

item (ProjectV2Item!)

The project item that contains this value.

name (String)

The name of the selected single select option.

nameHTML (String)

The html name of the selected single select option.

optionId (String)

The id of the selected single select option.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2ItemFieldTextValue

Object

The value of a text field in a Project item.

ProjectV2ItemFieldTextValue 实现

ProjectV2ItemFieldTextValue 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the item.

databaseId (Int)

Identifies the primary key from the database.

field (ProjectV2FieldConfiguration!)

The project field that contains this value.

id (ID!)

The Node ID of the ProjectV2ItemFieldTextValue object.

item (ProjectV2Item!)

The project item that contains this value.

text (String)

Text value of a field.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2ItemFieldUserValue

Object

The value of a user field in a Project item.

ProjectV2ItemFieldUserValue 字段

名称说明

field (ProjectV2FieldConfiguration!)

The field that contains this value.

users (UserConnection)

The users for this field.

users 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

ProjectV2ItemFieldValueConnection

Object

The connection type for ProjectV2ItemFieldValue.

ProjectV2ItemFieldValueConnection 字段

名称说明

edges ([ProjectV2ItemFieldValueEdge])

A list of edges.

nodes ([ProjectV2ItemFieldValue])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2ItemFieldValueEdge

Object

An edge in a connection.

ProjectV2ItemFieldValueEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2ItemFieldValue)

The item at the end of the edge.

ProjectV2ItemIssueFieldValue

Object

The value of an issue field in a Project item.

ProjectV2ItemIssueFieldValue 字段

名称说明

field (ProjectV2FieldConfiguration!)

Field that contains this value.

issueFieldValue (ProjectV2IssueFieldValues)

Value of the Issue Field.

ProjectV2ItemStatusChangedEvent

Object

Represents aproject_v2_item_status_changedevent on a given issue or pull request.

ProjectV2ItemStatusChangedEvent 实现

ProjectV2ItemStatusChangedEvent 字段

名称说明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the ProjectV2ItemStatusChangedEvent object.

previousStatus (String!)

The previous status of the project item.

project (ProjectV2)

Project referenced by event.

status (String!)

The new status of the project item.

wasAutomated (Boolean!)

Did this event result from workflow automation?.

ProjectV2IterationField

Object

An iteration field inside a project.

ProjectV2IterationField 实现

ProjectV2IterationField 字段

名称说明

configuration (ProjectV2IterationFieldConfiguration!)

Iteration configuration settings.

createdAt (DateTime!)

Identifies the date and time when the object was created.

dataType (ProjectV2FieldType!)

The field's type.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ProjectV2IterationField object.

name (String!)

The project field's name.

project (ProjectV2!)

The project that contains this field.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2IterationFieldConfiguration

Object

Iteration field configuration for a project.

ProjectV2IterationFieldConfiguration 字段

名称说明

completedIterations ([ProjectV2IterationFieldIteration!]!)

The iteration's completed iterations.

duration (Int!)

The iteration's duration in days.

iterations ([ProjectV2IterationFieldIteration!]!)

The iteration's iterations.

startDay (Int!)

The iteration's start day of the week.

ProjectV2IterationFieldIteration

Object

Iteration field iteration settings for a project.

ProjectV2IterationFieldIteration 字段

名称说明

duration (Int!)

The iteration's duration in days.

id (String!)

The iteration's ID.

startDate (Date!)

The iteration's start date.

title (String!)

The iteration's title.

titleHTML (String!)

The iteration's html title.

ProjectV2SingleSelectField

Object

A single select field inside a project.

ProjectV2SingleSelectField 实现

ProjectV2SingleSelectField 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

dataType (ProjectV2FieldType!)

The field's type.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ProjectV2SingleSelectField object.

name (String!)

The project field's name.

options ([ProjectV2SingleSelectFieldOption!]!)

Options for the single select field.

options 的参数

  • names ([String!])

    Filter returned options to only those matching these names, case insensitive.

project (ProjectV2!)

The project that contains this field.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2SingleSelectFieldOption

Object

Single select field option for a configuration for a project.

ProjectV2SingleSelectFieldOption 字段

名称说明

color (ProjectV2SingleSelectFieldOptionColor!)

The option's display color.

description (String!)

The option's plain-text description.

descriptionHTML (String!)

The option's description, possibly containing HTML.

id (String!)

The option's ID.

name (String!)

The option's name.

nameHTML (String!)

The option's html name.

ProjectV2SortBy

Object

Represents a sort by field and direction.

ProjectV2SortBy 字段

名称说明

direction (OrderDirection!)

The direction of the sorting. Possible values are ASC and DESC.

field (ProjectV2Field!)

The field by which items are sorted.

ProjectV2SortByConnection

Object

The connection type for ProjectV2SortBy.

ProjectV2SortByConnection 字段

名称说明

edges ([ProjectV2SortByEdge])

A list of edges.

nodes ([ProjectV2SortBy])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2SortByEdge

Object

An edge in a connection.

ProjectV2SortByEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2SortBy)

The item at the end of the edge.

ProjectV2SortByField

Object

Represents a sort by field and direction.

ProjectV2SortByField 字段

名称说明

direction (OrderDirection!)

The direction of the sorting. Possible values are ASC and DESC.

field (ProjectV2FieldConfiguration!)

The field by which items are sorted.

ProjectV2SortByFieldConnection

Object

The connection type for ProjectV2SortByField.

ProjectV2SortByFieldConnection 字段

名称说明

edges ([ProjectV2SortByFieldEdge])

A list of edges.

nodes ([ProjectV2SortByField])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2SortByFieldEdge

Object

An edge in a connection.

ProjectV2SortByFieldEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2SortByField)

The item at the end of the edge.

ProjectV2StatusUpdate

Object

A status update within a project.

ProjectV2StatusUpdate 实现

ProjectV2StatusUpdate 字段

名称说明

body (String)

The body of the status update.

bodyHTML (HTML)

The body of the status update rendered to HTML.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the status update.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

id (ID!)

The Node ID of the ProjectV2StatusUpdate object.

project (ProjectV2!)

The project that contains this status update.

startDate (Date)

The start date of the status update.

status (ProjectV2StatusUpdateStatus)

The status of the status update.

targetDate (Date)

The target date of the status update.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2StatusUpdateConnection

Object

The connection type for ProjectV2StatusUpdate.

ProjectV2StatusUpdateConnection 字段

名称说明

edges ([ProjectV2StatusUpdateEdge])

A list of edges.

nodes ([ProjectV2StatusUpdate])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2StatusUpdateEdge

Object

An edge in a connection.

ProjectV2StatusUpdateEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2StatusUpdate)

The item at the end of the edge.

ProjectV2View

Object

A view within a ProjectV2.

ProjectV2View 实现

ProjectV2View 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.

fields (ProjectV2FieldConfigurationConnection)

The view's visible fields.

fields 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2FieldOrder)

    Ordering options for the project v2 fields returned from the connection.

filter (String)

The project view's filter.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

groupBy (ProjectV2FieldConnection)

The view's group-by field.

警告

groupBy is deprecated.

The ProjectV2View#order_by API is deprecated in favour of the more capable ProjectV2View#group_by_field API. Check out the ProjectV2View#group_by_fields API as an example for the more capable alternative. Removal on 2023-04-01 UTC.

groupBy 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2FieldOrder)

    Ordering options for the project v2 fields returned from the connection.

groupByFields (ProjectV2FieldConfigurationConnection)

The view's group-by field.

groupByFields 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2FieldOrder)

    Ordering options for the project v2 fields returned from the connection.

id (ID!)

The Node ID of the ProjectV2View object.

layout (ProjectV2ViewLayout!)

The project view's layout.

name (String!)

The project view's name.

number (Int!)

The project view's number.

project (ProjectV2!)

The project that contains this view.

sortBy (ProjectV2SortByConnection)

The view's sort-by config.

警告

sortBy is deprecated.

The ProjectV2View#sort_by API is deprecated in favour of the more capable ProjectV2View#sort_by_fields API. Check out the ProjectV2View#sort_by_fields API as an example for the more capable alternative. Removal on 2023-04-01 UTC.

sortBy 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

sortByFields (ProjectV2SortByFieldConnection)

The view's sort-by config.

sortByFields 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

verticalGroupBy (ProjectV2FieldConnection)

The view's vertical-group-by field.

警告

verticalGroupBy is deprecated.

The ProjectV2View#vertical_group_by API is deprecated in favour of the more capable ProjectV2View#vertical_group_by_fields API. Check out the ProjectV2View#vertical_group_by_fields API as an example for the more capable alternative. Removal on 2023-04-01 UTC.

verticalGroupBy 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2FieldOrder)

    Ordering options for the project v2 fields returned from the connection.

verticalGroupByFields (ProjectV2FieldConfigurationConnection)

The view's vertical-group-by field.

verticalGroupByFields 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2FieldOrder)

    Ordering options for the project v2 fields returned from the connection.

visibleFields (ProjectV2FieldConnection)

The view's visible fields.

警告

visibleFields is deprecated.

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API. Check out the ProjectV2View#fields API as an example for the more capable alternative. Removal on 2023-01-01 UTC.

visibleFields 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • orderBy (ProjectV2FieldOrder)

    Ordering options for the project v2 fields returned from the connection.

ProjectV2ViewConnection

Object

The connection type for ProjectV2View.

ProjectV2ViewConnection 字段

名称说明

edges ([ProjectV2ViewEdge])

A list of edges.

nodes ([ProjectV2View])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2ViewEdge

Object

An edge in a connection.

ProjectV2ViewEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2View)

The item at the end of the edge.

ProjectV2Workflow

Object

A workflow inside a project.

ProjectV2Workflow 实现

ProjectV2Workflow 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

警告

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.

enabled (Boolean!)

Whether the workflow is enabled.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

id (ID!)

The Node ID of the ProjectV2Workflow object.

name (String!)

The name of the workflow.

number (Int!)

The number of the workflow.

project (ProjectV2!)

The project that contains this workflow.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2WorkflowConnection

Object

The connection type for ProjectV2Workflow.

ProjectV2WorkflowConnection 字段

名称说明

edges ([ProjectV2WorkflowEdge])

A list of edges.

nodes ([ProjectV2Workflow])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2WorkflowEdge

Object

An edge in a connection.

ProjectV2WorkflowEdge 字段

名称说明

cursor (String!)

A cursor for use in pagination.

node (ProjectV2Workflow)

The item at the end of the edge.

RemovedFromProjectV2Event

Object

Represents aremoved_from_project_v2event on a given issue or pull request.

RemovedFromProjectV2Event 实现

RemovedFromProjectV2Event 字段

名称说明

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the RemovedFromProjectV2Event object.

project (ProjectV2)

Project referenced by event.

wasAutomated (Boolean!)

Did this event result from workflow automation?.

Interfaces

ProjectV2Event

Interface

Represents an event related to a project on the timeline of an issue or pull request.

ProjectV2Event 的实现方式

ProjectV2Event 字段

名称说明

project (ProjectV2)

Project referenced by event.

wasAutomated (Boolean!)

Did this event result from workflow automation?.

ProjectV2FieldCommon

Interface

Common fields across different project field types.

ProjectV2FieldCommon 的实现方式

ProjectV2FieldCommon 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

dataType (ProjectV2FieldType!)

The field's type.

databaseId (Int)

Identifies the primary key from the database.

id (ID!)

The Node ID of the ProjectV2FieldCommon object.

name (String!)

The project field's name.

project (ProjectV2!)

The project that contains this field.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2ItemFieldValueCommon

Interface

Common fields across different project field value types.

ProjectV2ItemFieldValueCommon 的实现方式

ProjectV2ItemFieldValueCommon 字段

名称说明

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created the item.

databaseId (Int)

Identifies the primary key from the database.

field (ProjectV2FieldConfiguration!)

The project field that contains this value.

id (ID!)

The Node ID of the ProjectV2ItemFieldValueCommon object.

item (ProjectV2Item!)

The project item that contains this value.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

ProjectV2Owner

Interface

Represents an owner of a project.

ProjectV2Owner 的实现方式

ProjectV2Owner 字段

名称说明

id (ID!)

The Node ID of the ProjectV2Owner object.

projectV2 (ProjectV2)

Find a project by number.

projectV2 的参数

  • number (Int!)

    The project number.

projectsV2 (ProjectV2Connection!)

A list of projects under the owner.

projectsV2 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • query (String)

    A project to search for under the owner.

ProjectV2Recent

Interface

Recent projects for the owner.

ProjectV2Recent 的实现方式

ProjectV2Recent 字段

名称说明

recentProjects (ProjectV2Connection!)

Recent projects that this user has modified in the context of the owner.

recentProjects 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

Enums

ProjectV2CustomFieldType

Enum

The type of a project field.

ProjectV2CustomFieldType 的值

名称说明
DATE

Date.

ITERATION

Iteration.

NUMBER

Number.

SINGLE_SELECT

Single Select.

TEXT

Text.

ProjectV2FieldOrderField

Enum

Properties by which project v2 field connections can be ordered.

ProjectV2FieldOrderField 的值

名称说明
CREATED_AT

Order project v2 fields by creation time.

NAME

Order project v2 fields by name.

POSITION

Order project v2 fields by position.

ProjectV2FieldType

Enum

The type of a project field.

ProjectV2FieldType 的值

名称说明
ASSIGNEES

Assignees.

CLOSED

Closed.

CREATED

Created.

DATE

Date.

ISSUE_TYPE

Issue type.

ITERATION

Iteration.

LABELS

Labels.

LINKED_PULL_REQUESTS

Linked Pull Requests.

MILESTONE

Milestone.

NUMBER

Number.

PARENT_ISSUE

Parent issue.

REPOSITORY

Repository.

REVIEWERS

Reviewers.

SINGLE_SELECT

Single Select.

SUB_ISSUES_PROGRESS

Sub-issues progress.

TEXT

Text.

TITLE

Title.

TRACKED_BY

Tracked by.

TRACKS

Tracks.

UPDATED

Updated.

ProjectV2ItemFieldValueOrderField

Enum

Properties by which project v2 item field value connections can be ordered.

ProjectV2ItemFieldValueOrderField 的值

名称说明
POSITION

Order project v2 item field values by the their position in the project.

ProjectV2ItemOrderField

Enum

Properties by which project v2 item connections can be ordered.

ProjectV2ItemOrderField 的值

名称说明
POSITION

Order project v2 items by the their position in the project.

ProjectV2ItemType

Enum

The type of a project item.

ProjectV2ItemType 的值

名称说明
DRAFT_ISSUE

Draft Issue.

ISSUE

Issue.

PULL_REQUEST

Pull Request.

REDACTED

Redacted Item.

ProjectV2OrderField

Enum

Properties by which projects can be ordered.

ProjectV2OrderField 的值

名称说明
CREATED_AT

The project's date and time of creation.

NUMBER

The project's number.

TITLE

The project's title.

UPDATED_AT

The project's date and time of update.

ProjectV2PermissionLevel

Enum

The possible roles of a collaborator on a project.

ProjectV2PermissionLevel 的值

名称说明
ADMIN

The collaborator can view, edit, and maange the settings of the project.

READ

The collaborator can view the project.

WRITE

The collaborator can view and edit the project.

ProjectV2Roles

Enum

The possible roles of a collaborator on a project.

ProjectV2Roles 的值

名称说明
ADMIN

The collaborator can view, edit, and maange the settings of the project.

NONE

The collaborator has no direct access to the project.

READER

The collaborator can view the project.

WRITER

The collaborator can view and edit the project.

ProjectV2SingleSelectFieldOptionColor

Enum

The display color of a single-select field option.

ProjectV2SingleSelectFieldOptionColor 的值

名称说明
BLUE

BLUE.

GRAY

GRAY.

GREEN

GREEN.

ORANGE

ORANGE.

PINK

PINK.

PURPLE

PURPLE.

RED

RED.

YELLOW

YELLOW.

ProjectV2State

Enum

The possible states of a project v2.

ProjectV2State 的值

名称说明
CLOSED

A project v2 that has been closed.

OPEN

A project v2 that is still open.

ProjectV2StatusUpdateOrderField

Enum

Properties by which project v2 status updates can be ordered.

ProjectV2StatusUpdateOrderField 的值

名称说明
CREATED_AT

Allows chronological ordering of project v2 status updates.

ProjectV2StatusUpdateStatus

Enum

The possible statuses of a project v2.

ProjectV2StatusUpdateStatus 的值

名称说明
AT_RISK

A project v2 that is at risk and encountering some challenges.

COMPLETE

A project v2 that is complete.

INACTIVE

A project v2 that is inactive.

OFF_TRACK

A project v2 that is off track and needs attention.

ON_TRACK

A project v2 that is on track with no risks.

ProjectV2ViewLayout

Enum

The layout of a project v2 view.

ProjectV2ViewLayout 的值

名称说明
BOARD_LAYOUT

Board layout.

ROADMAP_LAYOUT

Roadmap layout.

TABLE_LAYOUT

Table layout.

ProjectV2ViewOrderField

Enum

Properties by which project v2 view connections can be ordered.

ProjectV2ViewOrderField 的值

名称说明
CREATED_AT

Order project v2 views by creation time.

NAME

Order project v2 views by name.

POSITION

Order project v2 views by position.

ProjectV2WorkflowsOrderField

Enum

Properties by which project workflows can be ordered.

ProjectV2WorkflowsOrderField 的值

名称说明
CREATED_AT

The date and time of the workflow creation.

NAME

The name of the workflow.

NUMBER

The number of the workflow.

UPDATED_AT

The date and time of the workflow update.

Unions

OrganizationOrUser

Union

Used for argument of CreateProjectV2 mutation.

OrganizationOrUser 可能类型

ProjectV2Actor

Union

Possible collaborators for a project.

ProjectV2Actor 可能类型

ProjectV2FieldConfiguration

Union

Configurations for project fields.

ProjectV2FieldConfiguration 可能类型

ProjectV2IssueFieldValues

Union

Possible issue field values for a Project item.

ProjectV2IssueFieldValues 可能类型

ProjectV2ItemContent

Union

Types that can be inside Project Items.

ProjectV2ItemContent 可能类型

ProjectV2ItemFieldValue

Union

Project field values.

ProjectV2ItemFieldValue 可能类型

Input objects

AddProjectV2DraftIssueInput

Input object

Autogenerated input type of AddProjectV2DraftIssue.

输入 AddProjectV2DraftIssueInput 字段

名称说明

assigneeIds ([ID!])

The IDs of the assignees of the draft issue.

body (String)

The body of the draft issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to add the draft issue to.

title (String!)

The title of the draft issue. A project item can also be created by providing the URL of an Issue or Pull Request if you have access.

AddProjectV2ItemByIdInput

Input object

Autogenerated input type of AddProjectV2ItemById.

输入 AddProjectV2ItemByIdInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID!)

The id of the Issue or Pull Request to add.

projectId (ID!)

The ID of the Project to add the item to.

ArchiveProjectV2ItemInput

Input object

Autogenerated input type of ArchiveProjectV2Item.

输入 ArchiveProjectV2ItemInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the ProjectV2Item to archive.

projectId (ID!)

The ID of the Project to archive the item from.

ClearProjectV2ItemFieldValueInput

Input object

Autogenerated input type of ClearProjectV2ItemFieldValue.

输入 ClearProjectV2ItemFieldValueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to be cleared.

itemId (ID!)

The ID of the item to be cleared.

projectId (ID!)

The ID of the Project.

ConvertProjectV2DraftIssueItemToIssueInput

Input object

Autogenerated input type of ConvertProjectV2DraftIssueItemToIssue.

输入 ConvertProjectV2DraftIssueItemToIssueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the draft issue ProjectV2Item to convert.

repositoryId (ID!)

The ID of the repository to create the issue in.

CopyProjectV2Input

Input object

Autogenerated input type of CopyProjectV2.

输入 CopyProjectV2Input 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeDraftIssues (Boolean)

Include draft issues in the new project.

ownerId (ID!)

The owner ID of the new project.

projectId (ID!)

The ID of the source Project to copy.

title (String!)

The title of the project.

CreateProjectV2FieldInput

Input object

Autogenerated input type of CreateProjectV2Field.

输入 CreateProjectV2FieldInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

dataType (ProjectV2CustomFieldType!)

The data type of the field.

iterationConfiguration (ProjectV2IterationFieldConfigurationInput)

Configuration for an iteration field.

name (String!)

The name of the field.

projectId (ID!)

The ID of the Project to create the field in.

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

Options for a single select field. At least one value is required if data_type is SINGLE_SELECT.

CreateProjectV2Input

Input object

Autogenerated input type of CreateProjectV2.

输入 CreateProjectV2Input 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The owner ID to create the project under.

repositoryId (ID)

The repository to link the project to.

teamId (ID)

The team to link the project to. The team will be granted read permissions.

title (String!)

The title of the project.

CreateProjectV2IssueFieldInput

Input object

Autogenerated input type of CreateProjectV2IssueField.

输入 CreateProjectV2IssueFieldInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

issueFieldId (ID!)

The ID of the IssueField to create the field for.

projectId (ID!)

The ID of the Project to create the field in.

CreateProjectV2StatusUpdateInput

Input object

Autogenerated input type of CreateProjectV2StatusUpdate.

输入 CreateProjectV2StatusUpdateInput 字段

名称说明

body (String)

The body of the status update.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to create the status update in.

startDate (Date)

The start date of the status update.

status (ProjectV2StatusUpdateStatus)

The status of the status update.

targetDate (Date)

The target date of the status update.

DeleteProjectV2FieldInput

Input object

Autogenerated input type of DeleteProjectV2Field.

输入 DeleteProjectV2FieldInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to delete.

DeleteProjectV2Input

Input object

Autogenerated input type of DeleteProjectV2.

输入 DeleteProjectV2Input 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to delete.

DeleteProjectV2ItemInput

Input object

Autogenerated input type of DeleteProjectV2Item.

输入 DeleteProjectV2ItemInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the item to be removed.

projectId (ID!)

The ID of the Project from which the item should be removed.

DeleteProjectV2StatusUpdateInput

Input object

Autogenerated input type of DeleteProjectV2StatusUpdate.

输入 DeleteProjectV2StatusUpdateInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

statusUpdateId (ID!)

The ID of the status update to be removed.

DeleteProjectV2WorkflowInput

Input object

Autogenerated input type of DeleteProjectV2Workflow.

输入 DeleteProjectV2WorkflowInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

workflowId (ID!)

The ID of the workflow to be removed.

LinkProjectV2ToRepositoryInput

Input object

Autogenerated input type of LinkProjectV2ToRepository.

输入 LinkProjectV2ToRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to link to the repository.

repositoryId (ID!)

The ID of the repository to link to the project.

LinkProjectV2ToTeamInput

Input object

Autogenerated input type of LinkProjectV2ToTeam.

输入 LinkProjectV2ToTeamInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to link to the team.

teamId (ID!)

The ID of the team to link to the project.

MarkProjectV2AsTemplateInput

Input object

Autogenerated input type of MarkProjectV2AsTemplate.

输入 MarkProjectV2AsTemplateInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to mark as a template.

ProjectV2Collaborator

Input object

A collaborator to update on a project. Only one of the userId or teamId should be provided.

输入 ProjectV2Collaborator 字段

名称说明

role (ProjectV2Roles!)

The role to grant the collaborator.

teamId (ID)

The ID of the team as a collaborator.

userId (ID)

The ID of the user as a collaborator.

ProjectV2FieldOrder

Input object

Ordering options for project v2 field connections.

输入 ProjectV2FieldOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2FieldOrderField!)

The field to order the project v2 fields by.

ProjectV2FieldValue

Input object

The values that can be used to update a field of an item inside a Project. Only 1 value can be updated at a time.

输入 ProjectV2FieldValue 字段

名称说明

date (Date)

The ISO 8601 date to set on the field.

iterationId (String)

The id of the iteration to set on the field.

number (Float)

The number to set on the field.

singleSelectOptionId (String)

The id of the single select option to set on the field.

text (String)

The text to set on the field.

ProjectV2Filters

Input object

Ways in which to filter lists of projects.

输入 ProjectV2Filters 字段

名称说明

state (ProjectV2State)

List project v2 filtered by the state given.

ProjectV2ItemFieldValueOrder

Input object

Ordering options for project v2 item field value connections.

输入 ProjectV2ItemFieldValueOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ItemFieldValueOrderField!)

The field to order the project v2 item field values by.

ProjectV2ItemOrder

Input object

Ordering options for project v2 item connections.

输入 ProjectV2ItemOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ItemOrderField!)

The field to order the project v2 items by.

ProjectV2Iteration

Input object

Represents an iteration.

输入 ProjectV2Iteration 字段

名称说明

duration (Int!)

The duration of the iteration, in days.

startDate (Date!)

The start date for the iteration.

title (String!)

The title for the iteration.

ProjectV2IterationFieldConfigurationInput

Input object

Represents an iteration field configuration.

输入 ProjectV2IterationFieldConfigurationInput 字段

名称说明

duration (Int!)

The duration of each iteration, in days.

iterations ([ProjectV2Iteration!]!)

Zero or more iterations for the field.

startDate (Date!)

The start date for the first iteration.

ProjectV2Order

Input object

Ways in which lists of projects can be ordered upon return.

输入 ProjectV2Order 字段

名称说明

direction (OrderDirection!)

The direction in which to order projects by the specified field.

field (ProjectV2OrderField!)

The field in which to order projects by.

ProjectV2SingleSelectFieldOptionInput

Input object

Represents a single select field option.

输入 ProjectV2SingleSelectFieldOptionInput 字段

名称说明

color (ProjectV2SingleSelectFieldOptionColor!)

The display color of the option.

description (String!)

The description text of the option.

id (String)

The ID of an existing single select option. Include this to preserve the option's identity during updates, preventing item field values from being cleared.

name (String!)

The name of the option.

ProjectV2StatusOrder

Input object

Ways in which project v2 status updates can be ordered.

输入 ProjectV2StatusOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order nodes.

field (ProjectV2StatusUpdateOrderField!)

The field by which to order nodes.

ProjectV2ViewOrder

Input object

Ordering options for project v2 view connections.

输入 ProjectV2ViewOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2ViewOrderField!)

The field to order the project v2 views by.

ProjectV2WorkflowOrder

Input object

Ordering options for project v2 workflows connections.

输入 ProjectV2WorkflowOrder 字段

名称说明

direction (OrderDirection!)

The ordering direction.

field (ProjectV2WorkflowsOrderField!)

The field to order the project v2 workflows by.

UnarchiveProjectV2ItemInput

Input object

Autogenerated input type of UnarchiveProjectV2Item.

输入 UnarchiveProjectV2ItemInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the ProjectV2Item to unarchive.

projectId (ID!)

The ID of the Project to archive the item from.

UnlinkProjectV2FromRepositoryInput

Input object

Autogenerated input type of UnlinkProjectV2FromRepository.

输入 UnlinkProjectV2FromRepositoryInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to unlink from the repository.

repositoryId (ID!)

The ID of the repository to unlink from the project.

UnlinkProjectV2FromTeamInput

Input object

Autogenerated input type of UnlinkProjectV2FromTeam.

输入 UnlinkProjectV2FromTeamInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the project to unlink from the team.

teamId (ID!)

The ID of the team to unlink from the project.

UnmarkProjectV2AsTemplateInput

Input object

Autogenerated input type of UnmarkProjectV2AsTemplate.

输入 UnmarkProjectV2AsTemplateInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to unmark as a template.

UpdateProjectV2CollaboratorsInput

Input object

Autogenerated input type of UpdateProjectV2Collaborators.

输入 UpdateProjectV2CollaboratorsInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

collaborators ([ProjectV2Collaborator!]!)

The collaborators to update.

projectId (ID!)

The ID of the project to update the collaborators for.

UpdateProjectV2DraftIssueInput

Input object

Autogenerated input type of UpdateProjectV2DraftIssue.

输入 UpdateProjectV2DraftIssueInput 字段

名称说明

assigneeIds ([ID!])

The IDs of the assignees of the draft issue.

body (String)

The body of the draft issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssueId (ID!)

The ID of the draft issue to update.

title (String)

The title of the draft issue.

UpdateProjectV2FieldInput

Input object

Autogenerated input type of UpdateProjectV2Field.

输入 UpdateProjectV2FieldInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to update.

iterationConfiguration (ProjectV2IterationFieldConfigurationInput)

Configuration for a field of type ITERATION. Empty input is ignored, provided values overwrite the existing configuration, and existing configuration should be fetched for partial updates.

name (String)

The name to update.

singleSelectOptions ([ProjectV2SingleSelectFieldOptionInput!])

Options for a field of type SINGLE_SELECT. Empty input is ignored, provided values overwrite existing options, and existing options should be fetched for partial updates.

UpdateProjectV2Input

Input object

Autogenerated input type of UpdateProjectV2.

输入 UpdateProjectV2Input 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

closed (Boolean)

Set the project to closed or open.

projectId (ID!)

The ID of the Project to update.

public (Boolean)

Set the project to public or private.

readme (String)

Set the readme description of the project.

shortDescription (String)

Set the short description of the project.

title (String)

Set the title of the project.

UpdateProjectV2ItemFieldValueInput

Input object

Autogenerated input type of UpdateProjectV2ItemFieldValue.

输入 UpdateProjectV2ItemFieldValueInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to be updated.

itemId (ID!)

The ID of the item to be updated.

projectId (ID!)

The ID of the Project.

value (ProjectV2FieldValue!)

The value which will be set on the field.

UpdateProjectV2ItemPositionInput

Input object

Autogenerated input type of UpdateProjectV2ItemPosition.

输入 UpdateProjectV2ItemPositionInput 字段

名称说明

afterId (ID)

The ID of the item to position this item after. If omitted or set to null the item will be moved to top.

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the item to be moved.

projectId (ID!)

The ID of the Project.

UpdateProjectV2StatusUpdateInput

Input object

Autogenerated input type of UpdateProjectV2StatusUpdate.

输入 UpdateProjectV2StatusUpdateInput 字段

名称说明

body (String)

The body of the status update.

clientMutationId (String)

A unique identifier for the client performing the mutation.

startDate (Date)

The start date of the status update.

status (ProjectV2StatusUpdateStatus)

The status of the status update.

statusUpdateId (ID!)

The ID of the status update to be updated.

targetDate (Date)

The target date of the status update.