APIを利用する

■API概要

APIを活用することで、業務で利用しているサービスとBYARDのシステム間で連携することができます。システム間で連携することで、例えば以下の様なことができるようになります。
  • 業務で利用しているシステム上で特定の操作をした際に、BYARD上でメンバーの招待を自動で行う
  • 業務で利用しているシステム上で特定の操作をした際に、BYARD上でテンプレートから案件を自動で開始する
⚠️
APIは「Standardプラン」「Expertプラン」のお客様のみ利用可能です。

■使用上の注意

  • API連携を行うためには、 Standardプランのお客様のみ契約可能な「API連携オプション」のご契約が必要です。
    • API連携オプションについてのお問い合わせは、BYARDサービス内のチャット、お問い合わせ窓口、もしくはカスタマーサクセス担当者にお問い合わせください。
      💡
      Expertプランのお客様は、オプションではなく標準仕様として利用可能です。
  • APIを使用するためには、専用のアカウントを一つ用意いただき、そのアカウントにAPIキーを取得できる機能を弊社にて付与いたします。そのため、APIを使用する際には、一度お問い合わせいただけますようお願いいたします。
  • コードの記述方法等に関するサポートは対応致しかねますので、予めご了承くださいませ。

■APIリファレンス

以下のURLからリファレンスを確認することができます。

■エンドポイント

※httpsのみ有効
 
上記のURLに各機能のリソース(パス)を続けて記入いただくことで、機能を利用することが可能です。
例)メンバー招待する
※リクエスト、レスポンスともにJSON形式をサポートしています。

■認証

APIを使用する際は、APIキー認証により認証を行います。APIキーは以下の手順で取得が可能です。
  1. [個人設定]をクリックします。
    1.  
  1. [API KEY]タブをクリックします。
    1. API KEYの画面はAPI連携オプションをご契約後に、指定された特定のアカウント環境のみに表示されます。(画面の表示対応は弊社にて実施いたします。) また、API KEYのタブは既に利用中のアカウントには表示することができず、API KEYを確認するための専用のアカウントを一つご用意頂く必要がございます。
 
  1. [API KEYをコピーする]をクリックすることで、API KEYの取得ができます。
    1. APIキーを取得する際に使用したアカウントが、APIを実行した際の実行ユーザーとなります。
       
      ⚠️
      APIキーの有効期限は半年となっています。有効期限が切れる前にAPIキーの更新が必要となります。

■各機能の詳細

メンバーの招待

リファレンス
 
基本情報
機能概要メンバーを招待します。 外部システムの処理をトリガーとしてBYARD内でメンバーの招待ができます。
メソッドPOST
リソース/v1/organizations/{organizationId}/invitations
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
 
Paramaters(body)
InviteMembersRequestModel 招待するメンバー情報
キー名タイプ必須説明
emailsstring必須メールアドレス
membershipTypestring必須ユーザー種別 指定できるユーザー種別には以下の5つの値があります。 ユーザー種別の意味については「用語一覧」をご確認ください。 Enum:[ OWNER, ADMINISTRATOR, EDITOR, OPERATOR, GUEST ] OWNER:エディター(組織オーナー) ADMINISTRATOR:エディター(管理者) EDITOR:エディター OPERATOR:オペレーター GUEST:ゲスト
 
サンプルコード
 
レスポンス
Code:201
キー名タイプ説明
emailsstringメールアドレス
membershipTypestringユーザー種別 ユーザー種別には以下の5つの値があります。 ユーザー種別の意味については「用語一覧」をご確認ください。 Enum:[ OWNER, ADMINISTRATOR, EDITOR, OPERATOR, GUEST ] OWNER:エディター(組織オーナー) ADMINISTRATOR:エディター(管理者) EDITOR:エディター OPERATOR:オペレーター GUEST:ゲスト

メンバー一覧の取得

リファレンス
 
基本情報
機能概要メンバー一覧の情報を取得します。 メンバーの情報をリストで取得することができます。
メソッドGET
リソース/v1/organizations/{organizationId}/members
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
 
レスポンス
Code:200
キー名タイプ説明
displayNamestringメンバーの表示名
biostring所属
activebooleanメンバーの利用ステータス true:有効 false:無効
membershipIdstringユーザー種別のID Enum:[ 1, 2, 3, 4, 5 ] 1:エディター(組織オーナー) 2:エディター(管理者) 3:エディター 4:オペレーター 5:ゲスト
membershipユーザー種別 以下の配列(type)があります。
└ typestringEnum:[ owner, administrator, editor, operator, guest ] owner:エディター(組織オーナー) administrator:エディター(管理者) editor:エディター operator:オペレーター guest:ゲスト
organizationIdstring組織ID
accountIdstringアカウントID BYARDでは作成した一つのアカウントで複数の組織に参加することが可能です。このアカウントIDは、最初に作成した一意のアカウントのIDを指します。
createdAtstring($date-time)作成日
namestringユーザーの名前 ※現在は使用しておおらず、すべてnullの状態で返ってきます。今後の機能拡張において、使用する可能性のあるキーとなります。
idstringメンバーID 組織に参加しているメンバーのIDです。一つのアカウントIDで複数の組織に参加している場合、同じアカウントであっても参加する組織ごとに異なるメンバーIDが割り当てられます。
accountstringメンバー情報 以下の配列(email)があります。
└ emailstringメールアドレス
primarybooleanアカウント新規作成後に初回ログインで使われたか否か true:この組織で初回ログインしたアカウント false:他の組織で初回ログインしたアカウント
updatedAtstring($date-time)最終更新日

メンバー詳細の取得(ID単位)

リファレンス
 
基本情報
機能概要指定したIDのメンバー情報を取得します。
メソッドGET
リソース/v1/organizations/{organizationId}/members/{memberId}
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
memberId メンバーID
タイプ必須説明
string必須メンバーIDを指定します。 メンバーIDは「メンバー一覧の取得」のエンドポイントより取得することができます。
 
レスポンス
Code:200
キー名タイプ説明
displayNamestringメンバーの表示名
biostring所属
activebooleanメンバーの利用ステータス true:有効 false:停止
membershipIdstringユーザー種別のID Enum:[ 1, 2, 3, 4, 5 ] 1:エディター(組織オーナー) 2:エディター(管理者) 3:エディター 4:オペレーター 5:ゲスト
membershipユーザー種別 以下の配列(type)があります。
└ typestringEnum:[ owner, administrator, editor, operator, guest ] owner:エディター(組織オーナー) administrator:エディター(管理者) editor:エディター operator:オペレーター guest:ゲスト
organizationIdstring組織ID
accountIdstringアカウントID BYARDでは作成した一つのアカウントで複数の組織に参加することが可能です。このアカウントIDは、最初に作成した一意のアカウントのIDを指します。
createdAtstring($date-time)作成日
namestringユーザーの名前 ※現在は使用しておおらず、すべてnullの状態で返ってきます。今後の機能拡張において、使用する可能性のあるキーとなります。
idstringメンバーID 組織に参加しているメンバーのIDです。一つのアカウントIDで複数の組織に参加している場合、同じアカウントであっても参加する組織ごとに異なるメンバーIDが割り当てられます。
accountメンバー情報 以下の配列(email)があります。
└ emailstringメールアドレス
primarybooleanアカウント新規作成後に初回ログインで使われたか否か true:この組織で初回ログインしたアカウント false:他の組織で初回ログインしたアカウント
updatedAtstring($date-time)最終更新日

メンバーステータスの更新

リファレンス
 
基本情報
機能概要メンバーのステータスを変更します。 現在はメンバーのステータスを停止にすることができます。
メソッドPUT
リソース/v1/organizations/{organizationId}/members/{memberId}/status
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
memberId メンバーID
タイプ必須説明
string必須メンバーIDを指定します。 メンバーIDは「メンバー一覧の取得」のエンドポイントより取得することができます。
 
Paramaters(body)
UpdateMemberStatusRequestModel メンバーステータス
キー名タイプ必須説明
statusstring必須ステータス ステータスには以下の値を指定することができます。 Enum:[ INACTIVE ] INACTIVE:停止
 
サンプルコード
 
レスポンス
Code:200
キー名タイプ説明
memberIdstringメンバーID
statusstringステータス ステータスには以下の値があります。 Enum:[ INACTIVE ] INACTIVE:停止
 

テンプレート一覧の取得

リファレンス
 
基本情報
機能概要テンプレート一覧の情報を取得します。 テンプレートの情報をリストで取得することができます。
メソッドGET
リソース/v1/organizations/{organizationId}/stream-templates
 
Paramaters(query)
ownerMemberId オーナーのメンバーID
タイプ必須説明
stringテンプレートのオーナーのメンバーIDを指定します。 指定したメンバーがオーナーとなっているテンプレートのリストを取得することができます。 メンバーIDは「メンバー一覧の取得」のエンドポイントより取得することができます。
collaboratorMemberId 共有者のメンバーID
タイプ必須説明
stringテンプレートの共有者のメンバーIDを指定します。 指定したメンバーが共有者となっているテンプレートのリストを取得することができます。 メンバーIDは「メンバー一覧の取得」のエンドポイントより取得することができます。
name テンプレート名
タイプ必須説明
stringテンプレート名を指定します。 指定した名前を含むテンプレートのリストを取得することができます。
archived アーカイブ
タイプ必須説明
stringテンプレートのアーカイブを指定します。 アーカイブを指定する際は、以下の値を指定します。 true・false true:アーカイブされている false:アーカイブされていない
 
Paramaters(path) 
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
 
レスポンス
Code:200
キー名タイプ説明
archivedstringアーカイブ true:アーカイブされている false:アーカイブされていない
namestringテンプレート名
idstringテンプレートID
confidentialbooleanコンフィデンシャルのステータス true:コンフィデンシャルが有効 false:コンフィデンシャルが無効
tagsタグの情報 以下の配列(items)があります。
└ itemsタグの情報 以下の配列(tag)があります。
 └ tagタグの詳細情報 以下の配列(name,id)があります。
  └ namestringタグ名
  └ idstringタグID

テンプレート詳細の取得(ID単位)

リファレンス
 
基本情報
機能概要指定したテンプレートIDのテンプレート情報を取得します。
メソッドGET
リソース/v1/organizations/{organizationId}/stream-templates/{streamTemplateId}
 
Paramaters(path) 
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
streamTemplateId テンプレートID
タイプ必須説明
string必須テンプレートIDを指定します。 テンプレートIDはBYARDのURL内のパラメータ(s=XX)が該当します。 https://app.byard.io/organization/streamTemplate/workgroupTemplate?o=組織ID&s=テンプレートID&wg=ワークグループID テンプレートIDは「テンプレート一覧の取得」のエンドポイントより取得することも可能です。
 
レスポンス
Code:200
キー名タイプ説明
templatebaseDatePlaceholderstring基準日のプレースホルダ プレースホルダに関する詳細はこちら
temporaryMembersテンポラリユーザーの情報 以下の配列(items)があります。
└ itemsテンポラリユーザーの情報 以下の配列(name,id)があります。
  └ namestringテンポラリユーザー名
  └ idstringテンポラリユーザーID
archivedMemberテンプレートをアーカイブしたユーザー情報 以下の配列(id)があります。
└ idstringメンバーID
slackChannelIdsstringテンプレートと連携しているSlackチャンネルのID
ownersテンプレートのオーナー情報 以下の配列(items)があります。
└ itemsテンプレートのオーナー情報 以下の配列(member)があります。
 └ memberテンプレートのオーナーの詳細情報 以下の配列(id)があります。
  └ idstringメンバーID
currentEditor現在のテンプレートの編集者情報 現在編集作業中の編集者情報を指します
└ member現在のテンプレートの編集者情報 以下の配列(id)があります。
  └ idstringメンバーID 編集中のメンバーのID
tagsタグの情報 以下の配列(items)があります。
└ itemsタグの情報 以下の配列(tag)があります。
 └ tagタグの詳細情報 以下の配列(name,id)があります。
  └ namestringタグ名
  └ idstringタグID
organizationIdstring組織ID
archivedbooleanアーカイブ true:アーカイブされている false:アーカイブされていない
createdAtstring($date-time)案件の作成日
namingRulestring案件タイトル 案件タイトルに関する詳細はこちら
namestringテンプレート名
collaboratorsテンプレートの共有者情報 以下の配列(items)があります。
└ itemsテンプレートの共有者情報 以下の配列(member)があります。
 └ memberテンプレートの共有者の詳細情報 以下の配列(id)があります。
  └ idstringメンバーID
idstringテンプレートID
baseDateDescriptionstring基準日の説明 基準日の説明に関する詳細はこちら
strictboolean「着手可能のみ」のステータス 着手可能なワークのみ実行できる制限機能のステータスを指します。本機能の詳細はこちら。 true:ストリクトモードが有効 false:ストリクトモードが無効
confidentialbooleanコンフィデンシャルのステータス true:コンフィデンシャルが有効 false:コンフィデンシャルが無効
updatedAtstring($date)テンプレートの更新日

テンプレートから案件を作成

リファレンス
 
基本情報
機能概要テンプレートから案件を作成します。 外部システムの処理をトリガーとして指定のテンプレートから案件を開始することができます。
メソッドPOST
リソース/v1/organizations/{organizationId}/stream-templates/{streamTemplateId}/generate
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
streamTemplateId テンプレートID
タイプ必須説明
string必須テンプレートIDを指定します。 テンプレートIDはBYARDのURL内のパラメータ(s=XX)が該当します。 https://app.byard.io/organization/streamTemplate/workgroupTemplate?o=組織ID&s=テンプレートID&wg=ワークグループID テンプレートIDは「テンプレート一覧の取得」のエンドポイントより取得することも可能です。
 
Paramaters(body)
CreateEntireStreamFromTemplateRequestModel 作成する案件の情報
キー名タイプ必須説明
temporaryMemberIdsテンポラリユーザーの情報 以下の配列(id, memberId)があります。
idstringテンポラリユーザーID ※「テンプレート詳細の取得(ID単位)」のエンドポイントより取得できる予定です(エンドポイントは現在開発中です)
memberIdstringメンバーID テンポラリユーザーに指定するメンバーのメンバーIDを指定します。
baseDatestring($date)必須基準日 案件開始時の基準日を指定します。
dueDatestring($date)必須期限日 案件の期限日を指定します。
streamNamestring必須ストリーム名 作成する案件の名前を指定します。
startDatestring($date)必須開始日 案件の開始日を指定します。
 
サンプルコード
 
レスポンス
Code:201
キー名タイプ説明
streamIdstringストリームID 作成された案件のIDです。

案件一覧の取得

リファレンス
 
基本情報
機能概要案件一覧の情報を取得します。 案件の情報をリストで取得することができます。
メソッドGET
リソース/v1/organizations/{organizationId}/streams
留意点APIを実行するユーザーが関与していないコンフィデンシャル案件の情報は取得することができません。コンフィデンシャル案件の情報を取得したい場合は、APIを実行するユーザーをコンフィデンシャル案件のオーナーや共有者などに追加することで、関係者として扱われ情報を取得することが可能です。
 
Paramaters(query)
name 案件名
タイプ必須説明
string案件名を指定します。 指定した名前を含む案件のリストを取得することができます。
stakeholderMemberId 関係者のメンバーID
タイプ必須説明
stringメンバーIDを指定します。 指定したメンバーが関係する案件のリストを取得することができます。 メンバーIDは「メンバー一覧の取得」のエンドポイントより取得することができます。
status ステータス
タイプ必須説明
string案件のステータスを指定します。 ステータスを指定する際は、以下の値を指定します。 EXECUTED・OPEN EXECUTED:完了 OPEN:未完了
 
Paramaters(path) 
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
 
レスポンス
Code:200
キー名タイプ説明
template案件に紐づくテンプレート情報 以下の配列(displayType,name,id,confidential)があります。
└ displayTypeテンプレートの閲覧制限のステータス Enum:[ ALLOWED, NOT_ALLOWED, FETCH_FAILED ] ALLOWED:閲覧可能 NOT_ALLOWED:閲覧不可 FETCH_FAILED:情報取得失敗
└ namestringテンプレート名
└ idstringテンプレートID
└ confidentialbooleanコンフィデンシャルのステータス(テンプレート) true:コンフィデンシャルが有効 false:コンフィデンシャルが無効
dueDatestring($date)期限日
namestring案件名
executionDatestring($date)完了日(実行日)
idstring案件ID
startDatestring($date)開始日
confidentialbooleanコンフィデンシャルのステータス(案件) true:コンフィデンシャルが有効 false:コンフィデンシャルが無効
statusstringステータス executed:完了
open:未完了
tagsタグの情報 以下の配列(items)があります。
└ itemsタグの情報 以下の配列(tag)があります。
 └ tagタグの詳細情報 以下の配列(name,id)があります。
  └ namestringタグ名
  └ idstringタグID

案件詳細の取得(ID単位)

リファレンス
 
基本情報
機能概要指定した案件IDの案件情報を取得します。
メソッドGET
リソース/v1/organizations/{organizationId}/streams/{streamId}
 
Paramaters(path) 
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
streamId 案件ID
タイプ必須説明
string必須案件IDを指定します。 案件IDはBYARDのURL内のパラメータ(s=XX)が該当します。 https://app.byard.io/organization/streamTemplate/workgroupTemplate?o=組織ID&s=案件ID&wg=ワークグループID 案件IDは「案件一覧の取得」のエンドポイントより取得するも可能です。
 
レスポンス
Code:200
キー名タイプ説明
template案件に紐づくテンプレート情報 以下の配列(id)があります。
└ idstringテンプレートID
dueDatestring($date)案件の期限日
executionDatestring($date)案件の完了日
descriptionstring紐づくテンプレート側で設定されているテンプレートの説明文
slackChannelIdsstring案件と連携しているSlackチャンネルのID
owners案件のオーナー情報 以下の配列(items)があります。
└ items案件のオーナー情報 以下の配列(member)があります。
 └ member案件のオーナーの詳細情報 以下の配列(id)があります。
  └ idstringメンバーID
createdTypestring案件の作成方法 Enum:[ MANUAL, SCHEDULE, EXTERNAL ] MANUAL:通常の作成 SCHEDULE:自動作成機能による自動作成 EXTERNAL:APIによる自動作成
tagsタグの情報 以下の配列(items)があります。
└ itemsタグの情報 以下の配列(tag)があります。
 └ tagタグの詳細情報 以下の配列(name,id)があります。
  └ namestringタグ名
  └ idstringタグID
organizationIdstring組織ID
createdAtstring($date-time)案件の作成日
executor案件の完了者 以下の配列(id)があります。
└ idstringメンバーID 案件を完了したメンバーのID
namestring案件名
collaborators案件の共有者情報 以下の配列(items)があります。
└ items案件の共有者情報 以下の配列(member)があります。
 └ member案件の共有者の詳細情報 以下の配列(id)があります。
  └ idstringメンバーID
idstring案件ID
strictboolean「着手可能のみ」のステータス 着手可能なワークのみ実行できる制限機能のステータスを指します。本機能の詳細はこちら。 true:ストリクトモードが有効 false:ストリクトモードが無効
startDatestring($date)案件の開始日
confidentialbooleanコンフィデンシャルのステータス true:コンフィデンシャルが有効 false:コンフィデンシャルが無効
statusstringステータス executed:完了
open:未完了
updatedAtstring($date)案件の更新日

案件ステータスの更新

リファレンス
 
基本情報
機能概要案件のステータスを変更します。 案件のステータスを「未完了」「完了」のいずれかに変更することが可能です。
メソッドPUT
リソース/v1/organizations/{organizationId}/streams/{streamId}/status
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
streamId 案件ID
タイプ必須説明
string必須案件IDを指定します。 案件IDはBYARDのURL内のパラメータ(s=XX)が該当します。 https://app.byard.io/organization/streamTemplate/workgroupTemplate?o=組織ID&s=案件ID&wg=ワークグループID 案件IDは「案件一覧の取得」のエンドポイントより取得するも可能です。
 
Paramaters(body)
UpdateStreamStatusRequestModel 案件ステータス
キー名タイプ必須説明
forceboolean未完了のワークがある際に案件を完了にするか否かの確認 true:完了にする false:完了にしない trueの場合、案件が完了になると同時に、未完了のワークは自動的にスキップとなります。 falseの場合、400エラーが返り案件は完了されません。
statusstring必須ステータス ステータスには以下の値を指定することができます。 Enum:[ OPEN, EXECUTED ] OPEN:未完了 EXECUTED:完了
 
サンプルコード
 
レスポンス
Code:200
キー名タイプ説明
streamIdstring案件ID
statusstringステータス ステータスには以下の値があります。 Enum:[ OPEN, EXECUTED ] OPEN:未完了 EXECUTED:完了
 

Todo一覧の取得

リファレンス
 
基本情報
機能概要ワークカード内にあるTodoの情報をリストで取得します。
メソッドGET
リソース/v1/organizations/{organizationId}/todos
 
Paramaters(query)
WorkId ワークID
タイプ必須説明
string必須ワークIDを指定します。 ワークIDはBYARDのURL内のパラメータ(w=XX)が該当します。 https://app.byard.io/organization/streamTemplate/workgroupTemplate?o=組織ID&s=案件ID&wg=ワークグループID&w=ワークID ワークIDは「ワーク一覧の取得」のエンドポイントより取得するも可能です。
 
Paramaters(path) 
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
 
レスポンス
Code:200
キー名タイプ説明
executionDatestring($date)完了日(実行日)
executorTodoの完了者 以下の配列(id)があります。
└ idstringメンバーID Todoを完了したメンバーのID
indexintegerTodoのインデックス番号
memostringメモの内容
idstringTodoのID
contentstringTodoの内容
statusstringステータス executed:完了 skip:スキップ
open:未完了

Todoステータスの更新

リファレンス
 
基本情報
機能概要Todoのステータスを変更します。 Todoのステータスを「未完了」「完了」「スキップ」のいずれかに変更することが可能です。
メソッドPUT
リソース/v1/organizations/{organizationId}/todos/{todoId}/status
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
todoId ワークID
タイプ必須説明
string必須todoIDを指定します。 todoIDはTodoの[リンクをコピー]から取得できるURL内のパラメータ(td=XX)が該当します。 https://app.byard.io/organization/stream/workgroup?o=組織ID&s=案件ID&wg=ワークグループID&w=ワークID&td=todoID todoIDは「Todo一覧の取得」のエンドポイントより取得するも可能です。
 
Paramaters(body)
UpdateTodoStatusRequestModel Todoステータス
キー名タイプ必須説明
forceExecuteStreamboolean案件内のワークを全て完了もしくはスキップした際に案件を完了にするか否かの確認 true:完了にする false:完了にしない trueの場合、全てのワークが完了もしくはスキップされると同時に案件も完了となります。 falseの場合、全てのワークが完了もしくはスキップされても案件は完了になりません。
statusstring必須ステータス ステータスには以下の値を指定することができます。 Enum:[ OPEN, EXECUTED, SKIP ] OPEN:未完了 EXECUTED:完了 SKIP:スキップ
 
サンプルコード
 
レスポンス
Code:200
キー名タイプ説明
idstringtodoID
statusstringステータス ステータスには以下の値があります。 Enum:[ OPEN, EXECUTED, SKIP ] OPEN:未完了 EXECUTED:完了 SKIP:スキップ
 

ワーク一覧の取得

リファレンス
 
基本情報
機能概要案件内にあるワークの情報をリストで取得します。
メソッドGET
リソース/v1/organizations/{organizationId}/works
 
Paramaters(query)
streamId 案件ID
タイプ必須説明
string必須案件IDを指定します。 案件IDはBYARDのURL内のパラメータ(s=XX)が該当します。 https://app.byard.io/organization/streamTemplate/workgroupTemplate?o=組織ID&s=案件ID&wg=ワークグループID 案件IDは「案件一覧の取得」のエンドポイントより取得するも可能です。
 
Paramaters(path) 
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
 
レスポンス
Code:200
キー名タイプ説明
estimatedMinutesinteger予定工数(分) ワークカードの予定工数です。 予定工数の詳細は「【案件】予定工数と実績を設定する」をご確認ください。
dueDatestring($date)期限日
namestringワーク名
executionDatestring($date)完了日(実行日)
actualMinutesinteger実績(分) ワークカードの実績工数です。 実績の詳細は「【案件】予定工数と実績を設定する」をご確認ください。
links連携カードの情報 以下の配列(id,type)があります。
└ idstring連携カードID
└ typestringワークカードのタイプ Enum:[ STREAM ] STREAM:連携カード
idstringワークID
startDatestring($date)開始日
statusstringステータス executed:完了 skip:スキップ
open:未完了

ワークステータスの更新

リファレンス
 
基本情報
機能概要ワークカードのステータスを変更します。 ワークカードのステータスを「未完了」「完了」「スキップ」のいずれかに変更することが可能です。
メソッドPUT
リソース/v1/organizations/{organizationId}/works/{workId}/status
 
Paramaters(path)
organizationId 組織ID
タイプ必須説明
string必須組織IDを指定します。 組織IDはBYARDのURL内のパラメータ(o=XX)が該当します。 https://app.byard.io/organization/member/work?o=組織ID
workId ワークID
タイプ必須説明
string必須ワークIDを指定します。 ワークIDはBYARDのURL内のパラメータ(w=XX)が該当します。 https://app.byard.io/organization/streamTemplate/workgroupTemplate?o=組織ID&s=案件ID&wg=ワークグループID&w=ワークID ワークIDは「ワーク一覧の取得」のエンドポイントより取得するも可能です。
 
Paramaters(body)
UpdateWorkStatusRequestModel ワークステータス
キー名タイプ必須説明
forceSkipTodobooleanワークを完了した際に未完了のTodoをスキップするか否かの確認 true:スキップする false:スキップしない trueの場合、ワークが完了になると同時に、未完了のTodoは自動的にスキップとなります。 falseの場合、400エラーが返りワークは完了されません。
forceExecuteStreamboolean案件内のワークを全て完了もしくはスキップした際に案件を完了にするか否かの確認 true:完了にする false:完了にしない trueの場合、全てのワークが完了もしくはスキップされると同時に案件も完了となります。 falseの場合、全てのワークが完了もしくはスキップされても案件は完了になりません。
statusstring必須ステータス ステータスには以下の値を指定することができます。 Enum:[ OPEN, EXECUTED, SKIP ] OPEN:未完了 EXECUTED:完了 SKIP:スキップ
 
サンプルコード
 
レスポンス
Code:200
キー名タイプ説明
idstringワークID
statusstringステータス ステータスには以下の値があります。 Enum:[ OPEN, EXECUTED, SKIP ] OPEN:未完了 EXECUTED:完了 SKIP:スキップ