backlog全体データを取得するAPI
ここからスタートすることで、すべてつながっていく
backlog全体なので、api_keyだけで、情報が取得できる。
urlパラメータやリクエストパラメータが不要で、backlogのAPIを使ってみるには最適です。
プロジェクト一覧の取得
スペース(backlogの契約単位)内のプロジェクトの一覧を取得します。
backlogでは、業務や用途別に1つのプロジェクトとして運用されていきます。 そのプロジェクトに、必要なユーザ(メンバー)を追加して、運用を開始します。
プロジェクトのアーカイブは、完了したプロジェクトを非表示にする機能になります。
backlog API
GET:/api/v2/projects
リクエストパラメーター
archived | 真偽値 | 省略された場合は全てのプロジェクト、falseの場合はアーカイブされていないプロジェクト、trueの場合はアーカイブされたプロジェクトを返します。 |
all | 真偽値 | ユーザが管理者権限の場合のみ有効なパラメータです。初期値はfalse。trueの場合はすべてのプロジェクト、falseの場合は参加しているプロジェクトのみを返します。 |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 12345(プロジェクトID)APIで使う
[projectKey] => XXXXXX(プロジェクトキー)APIで使う
[name] => XXXXX (プロジェクト名)
[chartEnabled] => 1
[subtaskingEnabled] =>
[projectLeaderCanEditProjectLeader] =>
[useWikiTreeView] =>
[textFormattingRule] => backlog
[archived] =>
[displayOrder] => 11
[useDevAttributes] => 1
)
ユーザー一覧の取得
backlogに登録されているすべてのユーザを取得することができます。
過去利用していたユーザも含めて取得します。
backlog API
GET:/api/v2/users
レスポンスボディ php配列形式
[0] => Array
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => Array(ヌーラボアカウントが設定されている場合)
(
[nulabId] => XXXXXXXXXXXXXXXXXXXXXXXXXXXX(ヌーラボID)
[name] => XXXXX(ハンドルネーム)
[uniqueId] => oda17(ヌーラボアカウント)
)
[keyword] => XXXXX
)
スペース情報の取得
スペースの情報を取得します。
スペースは、backlogの契約単位で、スペースごとに1つのurlが設定されます。
データベースで無理やり例えると、スペースがDATABASE名で、プロジェクトがtableみたいな感じです。
backlog API
GET:/api/v2/space
レスポンスボディ php配列形式
(
[spaceKey] => xxxxx(backlogのurlになっている、APIのurlでも使う)
[name] => XXXX (スペース名)
[ownerId] => 12345 (オーナID)
[lang] => ja (言語)
[timezone] => Asia/Tokyo
[reportSendTime] => 09:00:00 (レポート送信時間)
[textFormattingRule] => backlog
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
)
backlog API
GET:/api/v2/space/activities
リクエストパラメーター
activityTypeId[] | 数値(1-26) | 最近の更新の種別 |
minId | 数値 | 最小ID |
maxId | 数値 | 最大ID |
count | 数値 | 取得上限(1-100) デフォルトは20 |
order | 文字列 | ascまたはdesc デフォルトはdesc |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 184911098
[project] => Array (プロジェクト情報)
(
[id] => 12345(プロジェクトID)APIで使う
[projectKey] => XXXXXX(プロジェクトキー)APIで使う
[name] => XXXXX (プロジェクト名)
[chartEnabled] => 1
[subtaskingEnabled] =>
[projectLeaderCanEditProjectLeader] =>
[useWikiTreeView] =>
[textFormattingRule] => backlog
[archived] =>
[displayOrder] => 11
[useDevAttributes] => 1
)
[type] => 2(最近の更新の種別 1-26の数字で管理されている)
[content] => Array
(
[id] => 12345(課題のID)APIで使う
[key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
[summary] => 【課題タイトル】
[description] => 【課題概要コンテンツ】
[comment] => Array
(
[id] => 123456(コメントID)APIで使う
[content] => 【コメント内容】
)
[changes] => Array(変更内容)
(
[0] => Array
(
[field] => assigner(変更された属性)
[field_text] => lbl.changelog.assigner(変更された属性)
[new_value] => XXX(変更後の値)
[old_value] => XXX(変更前の値)
[type] => standard (属性のタイプ、デフォルト属性)
)
)
[attachments] => Array(添付ファイル)
(
)
[shared_files] => Array(共有ファイル)
(
)
)
[notifications] => Array(お知らせ通知)
(
[0] => Array
(
[id] => 123456789(お知らせのID)APIで使う
[alreadyRead] => (既読未読)
[reason] => 4 (お知らせ通知種別)
[user] => Array
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[resourceAlreadyRead] =>
)
[1] => Array
(
[id] => 123456789(お知らせのID)APIで使う
[alreadyRead] => (既読未読)
[reason] => 4 (お知らせ通知種別)
[user] => Array(ユーザ情報)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[resourceAlreadyRead] =>
)
)
[createdUser] => Array(登録者)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
)
レスポンス説明
type | 数値(1-26) |
最近の更新の種別(activityTypeId): 課題関連1:課題の追加,2:課題の更新,3:課題にコメント,4:課題の削除,14:課題をまとめて更新,17:コメントにお知らせを追加 wiki関連 5:Wikiを追加,6:Wikiを更新,7:Wikiを削除, ファイル関連 8:共有ファイルを追加,9:共有ファイルを更新,10:共有ファイルを削除, Subversion関連 11:Subversionコミット ユーザ関連 15:ユーザーがプロジェクトに参加,16:ユーザーがプロジェクトから脱退, git関連 12:GITプッシュ,13:GITリポジトリ作成,18:プルリクエストの追加,19:プルリクエストの更新,20:プルリクエストにコメント,21:プルリクエストの削除, マイルストーン関連 22:マイルストーンの追加,23:マイルストーンの更新,24:マイルストーンの削除, プロジェクト関連 25:グループがプロジェクトに参加,26:グループがプロジェクトから脱退 |
reason | 数値(1-13) |
お知らせ通知の種別: 課題関連 1:課題の担当者に設定,2:課題にコメント,3:課題の追加,4:課題の更新,5:ファイルを追加, プロジェクト関連 6:プロジェクトユーザーの追加,9:その他, git関連 10:プルリクエストの担当者に設定,11:プルリクエストにコメント,12:プルリクエストの追加,13:プルリクエストの更新 |
お知らせ一覧の取得
自分の受け取ったお知らせの一覧を取得します。
全プロジェクト横断してお知らせを受け取れるのが便利なところです。
お知らせ通知はメールのCCと同じなので、backlogに変えることでメールからも解放されます。
backlogで既読、未読管理もされています。
backlog API
GET:/api/v2/notifications
リクエストパラメーター
minId | 数値 | 最小ID |
maxId | 数値 | 最大ID |
count | 数値 | 取得上限(1-100) デフォルトは20 |
order | 文字列 | ascまたはdesc デフォルトはdesc |
senderId | 数値 | 送信者ID |
レスポンスボディ php配列形式
[0] => Array
(
[id] => 12345678(お知らせ通知のID)APIで使う
[alreadyRead] => 1(既読未読)
[reason] => 4 (お知らせ通知種別)
[resourceAlreadyRead] =>
[project] => Array
(
[id] => 12345(プロジェクトID)APIで使う
[projectKey] => XXXXXX(プロジェクトキー)APIで使う
[name] => XXXXX (プロジェクト名)
[chartEnabled] => 1
[subtaskingEnabled] =>
[projectLeaderCanEditProjectLeader] =>
[useWikiTreeView] =>
[textFormattingRule] => backlog
[archived] =>
[displayOrder] => 11
[useDevAttributes] => 1
)
[issue] => Array(課題)
(
[id] => 12345(課題ID)APIで使う
[projectId] => 12345 (プロジェクトID) APIで使う
[issueKey] => XXXXX (プロジェクトkey) APIで使う
[key_id] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される)
[issueType] => Array
(
[id] => 12345 (種別ID)
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => XXXX(種別名)
[color] => #7ea800
[displayOrder] => 0
)
[summary] => 【課題タイトル】
[description] => 【課題概要コンテンツ】
[resolution] =>
[priority] => Array(優先度)
(
[id] => 3 (優先度ID)
[name] => 中(優先度名称)
)
[status] => Array(ステータス)
(
[id] => 1(ステータスID)
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => 未対応 (ステータス名称)
[color] => #ed8077
[displayOrder] => 1000
)
[assignee] => Array(アサイン情報、中身はユーザ情報)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[category] => Array(カテゴリ情報)
(
[0] => Array
(
[id] => 12345 (カテゴリID)
[name] => XXXX (カテゴリ名称)
[displayOrder] => 2147483646
)
)
[versions] => Array
(
)
[milestone] => Array
(
)
[startDate] => 2021-05-19T00:00:00Z (開始日)
[dueDate] => (終了日)
[estimatedHours] => (予定稼働時間)
[actualHours] => (実働時間)
[parentIssueId] => (親課題ID,親課題があるとその課題IDが表示される)
[createdUser] => Array (作成者)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updatedUser] => Array(更新者情報、中身はユーザ情報)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
[customFields] => Array
(
)
[attachments] => Array(課題の添付ファイル情報)
(
[0] => Array
(
[id] => 2222222(ファイルID)APIで使う
[name] => XXXX.xlsx(ファイル名)
[size] => 71791 (ファイルサイズ)
[createdUser] => Array(ファイル作成者、中身はユーザ情報)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
)
[1] => Array
(
[id] => 2222222(ファイルID)APIで使う
[name] => XXXX.xlsx(ファイル名)
[size] => 71791 (ファイルサイズ)
[createdUser] => Array
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
)
)
[sharedFiles] => Array(共有ファイル)
(
)
[stars] => Array(スター)
(
)
)
[comment] => Array
(
[id] => 123456(コメントID)APIで使う
[content] => 【コメント内容】
[changeLog] => Array (変更内容)
(
[0] => Array
(
[field] => assigner (変更された属性)
[newValue] => XXXX (変更後の値)
[originalValue] => XXXX (変更前の値)
[attachmentInfo] =>
[attributeInfo] =>
[notificationInfo] =>
)
[1] => Array
(
[field] => attachment (変更された属性)
[newValue] => XXXX (変更後の値)
[originalValue] => XXXX (変更前の値)
[attachmentInfo] => Array
(
[id] => 2222222(添付ファイルID)APIで使う
[name] => XXXX.xlsx(ファイル名)
)
[attributeInfo] =>
[notificationInfo] =>
)
)
[createdUser] => Array(作成者)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
[stars] => Array
(
)
[notifications] => Array(お知らせ情報、お知らせした人分表示される)
(
[0] => Array
(
[id] => 12345678(お知らせ通知のID)APIで使う
[alreadyRead] => 1(既読未読)
[reason] => 4 (お知らせ通知種別)
[user] => Array(ユーザ情報)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[resourceAlreadyRead] => 1 (既読、未読)
)
[1] => Array
(
[id] => 12345678(お知らせ通知のID)APIで使う
[alreadyRead] => 1(既読未読)
[reason] => 4 (お知らせ通知種別)
[user] => Array
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[resourceAlreadyRead] =>
)
)
)
[pullRequest] =>
[pullRequestComment] =>
[sender] => Array (送信者)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
)
レスポンス説明
reason | 数値 | お知らせ通知の種別 |
課題一覧の取得
課題の一覧を取得します。
リクエストパラメータは、絞り込む条件で、全プロジェクトを横断的に課題を抜き出すこともできます。
APIのレスポンスは、課題だけで、コメントの情報まではありません。
backlog API
GET:/api/v2/issues
リクエストパラメーター
projectId[] | 数値 | プロジェクトのID(プロジェクトで絞り込み) |
issueTypeId[] | 数値 | 最近の更新の種別種別のID(課題で絞り込み) |
categoryId[] | 数値 | カテゴリーのID |
versionId[] | 数値 | 発生バージョンのID |
milestoneId[] | 数値 | マイルストーンのID |
statusId[] | 数値 | 状態のID,プロジェクト毎の状態一覧のAPI |
priorityId[] | 数値 | 優先度のID |
assigneeId[] | 数値 | 担当者のID |
createdUserId[] | 数値 | 登録者のID(登録者で絞り込み) |
resolutionId[] | 数値 | 完了理由のID |
parentChild | 数値 | 親子課題の条件 0: すべて,1: 子課題以外,2: 子課題,3: 親課題でも子課題でもない課題,4: 親課題 |
attachment | 真偽値 | 添付ファイルを含む場合はtrue |
sharedFile | 真偽値 | 共有ファイルを含む場合はtrue |
sort | 文字列 |
課題一覧のソートに使用する属性名 issueType, category, version, milestone, summary, status, priority, attachment, sharedFile, created, createdUser, updated, updatedUser, assignee, startDate, dueDate, estimatedHours, actualHours, childIssue, customField_${id} |
order | 文字列 | ascまたはdesc デフォルトはdesc |
offset | 数値 | |
count | 数値 | 取得上限(1-100) デフォルトは20 |
createdSince | 文字列 | 登録日 (yyyy-MM-dd)から |
createdUntil | 文字列 | 登録日 (yyyy-MM-dd)まで |
updatedSince | 文字列 | 更新日 (yyyy-MM-dd)から |
updatedUntil | 文字列 | 更新日 (yyyy-MM-dd)まで |
startDateSince | 文字列 | 開始日 (yyyy-MM-dd) |
startDateUntil | 文字列 | 開始日 (yyyy-MM-dd) |
dueDateSince | 文字列 | 期限日 (yyyy-MM-dd) |
dueDateUntil | 文字列 | 期限日 (yyyy-MM-dd) |
id[] | 数値 | 課題のID |
parentIssueId[] | 数値 | 親課題のID |
keyword | 文字列 | 検索キーワード |
カスタム属性を指定した検索 (テキスト属性) | ||
---|---|---|
customField_${id} | 文字列 | 検索キーワード |
カスタム属性を指定した検索 (数値属性) | ||
customField_${id}_min | 数値 | 最小値 |
customField_${id}_max | 数値 | 最大値 |
カスタム属性を指定した検索 (日付属性) | ||
customField_${id}_min | 文字列 | 最小値 |
customField_${id}_max | 文字列 | 最大値 |
カスタム属性を指定した検索 (リスト属性) | ||
customField_${id}[] | 数値 | 値のID |
レスポンスボディ php配列形式
(
[0] => Array
(
[id] => 12345(課題のID)APIで使う
[projectId] => 12345 (プロジェクトID) APIで使う
[issueKey] => XXXXX (プロジェクトkey) APIで使う
[keyId] => 123 (プロジェクトの後ろに[-ハイフン]IDで付与される、プロジェクト内のIDに近い、URLで表示される) //key_id違う?
[issueType] => Array (種別)
(
[id] => 12345 (種別ID)
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => XXXX (種別名)
[color] => #7ea800
[displayOrder] => 0
)
[summary] => 【課題タイトル】
[description] => 【課題概要コンテンツ】
[resolution] =>
[priority] => Array
(
[id] => 3
[name] => 中
)
[status] => Array
(
[id] => 123 (ステータスID)
[projectId] => 12345 (プロジェクトID) APIで使う
[name] => 処理中 (スタータス名)
[color] => #4488c5
[displayOrder] => 2000
)
[assignee] => Array
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[category] => Array
(
)
[versions] => Array
(
)
[milestone] => Array
(
)
[startDate] =>
[dueDate] =>
[estimatedHours] =>
[actualHours] =>
[parentIssueId] =>
[createdUser] => Array(登録者)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
[updatedUser] => Array(更新者)
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[updated] => 2020-03-03T03:03:03Z (日付はISO 8601 形式)
[customFields] => Array
(
)
[attachments] => Array(課題添付ファイル、複数あり)
(
[0] => Array
(
[id] => 2222222(ファイルID)APIで使う
[name] => XXXX.xlsx(ファイル名)
[size] => 71791 (ファイルサイズ)
[createdUser] => Array
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
)
[1] => Array
(
[id] => 2222222(ファイルID)APIで使う
[name] => XXXX.xlsx(ファイル名)
[size] => 71791 (ファイルサイズ)
[createdUser] => Array
(
[id] => 12345(ユーザID)APIで使う
[userId] => XXXXX(ログイン名、お知らせにも使う)
[name] => XXXXX(ハンドルネーム、お知らせにも使う)
[roleType] => 1 (役割、数値固定定義)
[lang] => (言語設定、指定がない場合はnull)
[mailAddress] => xxx@xxxx.xx.xx
[nulabAccount] => (ヌーラボのアカウント/追加されている)
[keyword] => XXXXX (検索キーワード)
)
[created] => 2020-02-02T02:02:02Z (日付はISO 8601 形式)
)
)
[sharedFiles] => Array
(
)
[stars] => Array
(
)
)
レート制限情報の取得
短時間に高頻度でAPIにアクセスした場合に、APIアクセスを制限するものです
現在設定されているレート制限に関する情報を取得します。
有料プランだと、読み込みは600回/分、更新は150回/分
1分単位でリセットされます。(UNIXタイムスタンプ=1620790586)
backlog API
GET:/api/v2/rateLimit
レスポンスボディ php配列形式
(
[rateLimit] => Array
(
[read] => Array(読み込み)
(
[limit] => 600(1分間のAPI数の制限)
[remaining] => 593(残りAPI数)
[reset] => 1621137870(リセットのUNIXタイムスタンプ)
)
[update] => Array
(
[limit] => 150
[remaining] => 150
[reset] => 1621137813
)
[search] => Array
(
[limit] => 150
[remaining] => 149
[reset] => 1621137870
)
[icon] => Array
(
[limit] => 60
[remaining] => 60
[reset] => 1621137813
)
)
)
スペースの容量使用状況の取得
スペースの容量使用状況の情報を取得します。
全体とプロジェクト別のファイルサイズ等が取得できます。(全プロジェクトが出る)
backlog画面から確認できます
backlog API
GET:/api/v2/space/diskUsage
レスポンスボディ php配列形式
(
[capacity] => 322122547200 (契約ディスク容量)
[issue] => 122062097557 (課題使用)
[wiki] => 85573285 (wiki使用)
[file] => 100567393541 (添付ファイル使用)
[subversion] => 0
[git] => 0
[gitLFS] => 0
[pullRequest] => 0
[details] => Array
(
[0] => Array
(
[projectId] => 12345 (プロジェクトID) APIで使う
[issue] => 1568725021
[wiki] => 54710
[file] => 1142399875
[subversion] => 0
[git] => 0
[gitLFS] => 0
[pullRequest] => 0
)
[1] => Array
(
[projectId] => 12345 (プロジェクトID) APIで使う
[issue] => 263026579
[wiki] => 653702
[file] => 149594877
[subversion] => 0
[git] => 0
[gitLFS] => 0
[pullRequest] => 0
)