Add item to user owned project | Sample

2 parameters · 5 body fields

usernamestringrequired

The handle for the GitHub user account.

project_numberintegerrequired

The project's number.

Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.

typestringrequired

The type of item to add to the project. Must be either Issue or PullRequest.

Allowed:IssuePullRequest

idintegeroptional

The unique identifier of the issue or pull request to add to the project.

ownerstringoptional

The repository owner login.

repostringoptional

The repository name.

numberintegeroptional

The issue or pull request number.

4 status codes

201Response

idnumberrequired

The unique identifier of the project item.

node_idstringoptional

The node ID of the project item.

contentobjectoptional

The content represented by the item.

content_typestringrequired

The type of content tracked in a project item

Allowed:IssuePullRequestDraftIssue

creatorobjectoptional

A GitHub user.

created_atstringrequired

The time when the item was created.

updated_atstringrequired

The time when the item was last updated.

archived_atstringrequired

The time when the item was archived.

project_urlstringoptional

The URL of the project this item belongs to.

item_urlstringoptional

The URL of the item in the project.

304Not modified

401Requires authentication

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.items.create({
  username: "octocat",
  projectNumber: "example",
  type: "example",
  id: 4355,
  owner: "octocat",
});

{
  "value": {
    "id": 17,
    "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI",
    "content": {
      "id": 38,
      "node_id": "I_kwDOANN5s85FtLts",
      "title": "Example Draft Issue",
      "body": "This is a draft issue in the project.",
      "created_at": "2022-04-28T12:00:00Z",
      "updated_at": "2022-04-28T12:00:00Z",
      "user": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      }
    },
    "content_type": "DraftIssue",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2022-04-28T12:00:00Z",
    "updated_at": "2022-04-28T12:00:00Z",
    "archived_at": null,
    "project_url": "https://api.github.com/users/octocat/projectsV2/1",
    "item_url": "https://api.github.com/users/octocat/projectsV2/items/17"
  }
}

Was this helpful?

Request

Response

Errors