StaffCircle (プレビュー)
StaffCircle は、分散した作業環境でも業績が高いチームを作成するために、会社文化とパフォーマンス管理を組み合わせた従業員の成功プラットフォームです。 StafffCircle には、コンピテンシー フレームワークにリンクされた目的、レビュー、値、フィードバックが含まれています。 深い分析情報でエンゲージメントとパフォーマンスを促進します。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | StaffCircle サポート |
| [URL] | https://www.staffcircle.com/contact-us/ |
| メール | support@staffcircle.com |
| Connector Metadata | |
|---|---|
| 発行者 | StaffCircle |
| Web サイト | https://www.staffcircle.com/ |
| プライバシー ポリシー | https://www.staffcircle.com/privacy-policy/ |
| カテゴリ | コミュニケーション; 人事 |
StaffCircle は、パフォーマンス管理、コミュニケーション、およびカルチャを改善することにより、組織がリモートの従業員を管理するのに役立ちます。 StaffCircle に接続して、one2one のレビュー、パフォーマンス目標、okrs、リアルタイムのフィードバック、賞、表彰を管理できます。 パフォーマンス目標の作成または更新、賞の割り当て、記事と通知の作成、ユーザー情報の更新など、さまざまなアクションを実行できます。
前提条件
このコネクタを使用するには、StaffCircle アカウントにアクセスできる必要があります。 StaffCircle は有料のサブスクリプション プランです。 StaffCircle アカウントにアクセスできない場合は、詳細をここ で参照できます。
資格情報の入手方法
StaffCircle アカウントにアクセスできる場合は、このコネクタの使用を開始するために必要な資格情報をすでに持っています。 StaffCircle コネクタの接続を作成するときに、ユーザー名とパスワードの入力を求められます。 ここでは、StaffCircle アカウントの資格情報を使用できます。 コネクタは、提供された資格情報のコンテキストで実行されることに注意してください。これには、セキュリティ アクセス許可の考慮も含まれます。 つまり、使用する StaffCircle アカウントに、コネクタでトリガーするアクションを実行するための正しいアクセス許可があることを確認する必要があります。
コネクタの使用を開始する
StaffCircle コネクタの使用を開始するのは簡単です。必要なのは StaffCircle アカウントだけです。 ユーザーの資格情報を使用して、StaffCircle コネクタへの接続を作成できます。 完了したら、コネクタで定義されているトリガーの 1 つを使用して、StaffCircle インスタンス内で発生するイベントから自動化されたワークフローのトリガーを開始できます。
ワークフローの例を次に示します
- 記事が StaffCircle で公開されたときにワークフローをトリガーし、記事に関する通知を Slack などのチャット アプリケーションに送信します。
- 新しいスタッフ メンバーが StaffCircle に追加されたときにワークフローをトリガーし、新しいスタッフ メンバーへの電子メールなどの通信を含む可能性のあるオンボード プロセスを推進します。
StaffCircle には多くの webhook がありますが、それらはすべてトリガーとしてコネクタに公開されているわけではありません。 必要に応じたトリガーが見つからない場合は、webhook の表示を検討してください。 webhook は、StaffCircle Web アプリケーション内の設定の統合セクションにあります。 フロー トリガー「HTTP 要求を受信したとき」を使用して、ワークフローをトリガーするために StaffCircle webhook に指定できる URL を生成できます。
このようなワークフローの例は次のとおりです
- スタッフ メンバーに休日の要求があった場合は、Outlook カレンダー イベントを作成します。
StaffCircle は、ビジネス内のコミュニケーションと客観的な管理を改善するのに役立つ一連のアクションを使用できるようにしました。 「新しい通知の作成」などのアクションを使用して、StaffCircle がサポートする電子メール、SMS、MS Teams、アプリ内通知、プッシュ Notifications など複数のチャネルでメッセージの送信をトリガーできます。 これにより、他のアプリケーションで発生する重要なイベントをチームに通知できます。
客観的アクションは、KPI の追跡を自動化するために使用できます。 機会を獲得するなど、他のアプリケーションでイベントが発生すると、StaffCircle で設定されている目標を取引の値で更新できます。
StaffCircle は、「電子メールで人を取得」などの便利なアクションを提供して、スタッフ メンバーを「新しいタスクを作成」などの他のアクションに簡単にリンクできる
サポート
StaffCircle コネクタの設定で問題が発生した場合、またはビジネス ニーズを満たすための機能が必要な場合は、support@staffcircle.com までご連絡ください
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| テンプレートで新しい目的を作成する |
目的テンプレートを使用して新しい目的を作成する |
| メールで人を取得する |
メールで個人レコードを検索しようとする |
| 新しいアラートの作成 |
複数の通信チャネルを介して StaffCircle ユーザーに配布できる新しい通知を作する |
| 新しいタスクを作成する |
新しいタスクを作成し、それをユーザーに割り当てる |
| 新しい個人を作成する |
個人を作成する |
| 新しい目的の作成 |
新しい目的の作成 |
| 新しい記事を作成する |
複数の通信チャネルを介して StaffCircle ユーザーに配布できる新しい記事を作成する |
| 目的のスコアを更新する |
新しいスコアと説明で目的を更新する |
| 目的の検索 |
目的の検索 |
テンプレートで新しい目的を作成する
目的テンプレートを使用して新しい目的を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
目的テンプレート
|
objectiveTemplateId | True | integer |
目的テンプレートから新しい目的を作成する |
|
開始日
|
startDate | True | date-time |
目的が測定されているときから |
|
終了日
|
endDate | True | date-time |
目的の期限 |
|
個人のメール
|
personEmail | string |
目的の個人のメール アドレス。 個人的な目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
個人 ID
|
personId | integer |
目的の個人の ID。 個人的な目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
部署名
|
departmentName | string |
目的の部署の名前。 部署の目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
部署 ID
|
departmentId | integer |
目的の部署の ID。 部署の目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
マネージャーのメール
|
managerEmail | string |
目的の追跡を担当するマネージャーのメール。 自動的に既定で個人または部署のマネージャーになります。 個人または部署にマネージャーがいない場合、または目的が会社の目的である場合に必要です。 マネージャー ID が提供されていない場合に使用される |
|
|
敬称
|
title | string |
新しい目的の名前を上書きします。 |
|
|
内容
|
description | string |
新しい目的の説明を上書きします。 |
|
|
マネージャー ID
|
managerId | integer |
目的の追跡を担当するマネージャー。 自動的に既定で個人または部署のマネージャーになります。 個人または部署にマネージャーがいない場合、または目的が会社の目的である場合に必要です。 マネージャーのメールが提供されていない場合に使用される |
|
|
会社の目的 ID
|
companyObjectiveId | integer |
新しく作成された目的が関連する会社の目的へのオプションのリンク |
|
|
部署の目的 ID
|
departmentObjectiveId | integer |
新しく作成された目的が関連する部署へのオプションのリンク |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
目的 ID
|
id | integer |
作成された目的の識別子 |
メールで人を取得する
メールで個人レコードを検索しようとする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メールを検索
|
SearchEmail | True | string |
メールで検索 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
結果
|
results | array of object |
結果 |
|
ID
|
results.id | integer |
個人の ID |
|
名
|
results.firstName | string |
個人の名 |
|
姓
|
results.secondName | string |
ユーザーの姓 |
|
として知られている
|
results.knownAs | string |
個人が好む名前 |
|
電子メール
|
results.email | string |
個人のメール アドレス |
|
ダイヤル コード
|
results.dialingCode | string |
個人の電話番号のダイヤル コード |
|
携帯電話番号
|
results.mobile | string |
個人の携帯電話番号 |
|
メイン サイト ID
|
results.mainSite.id | integer |
個人が関連付けられているメイン サイトの ID |
|
メイン サイト名
|
results.mainSite.name | string |
メイン サイトに付けられた名前 |
|
説明
|
results.mainSite.description | string |
説明 |
|
マネージャー
|
results.mainSite.manager | string |
マネージャー |
|
マネージャー ID
|
results.manager.id | integer |
マネージャー ID |
|
マネージャーの名
|
results.manager.firstName | string |
マネージャーの名 |
|
マネージャーのミドル ネーム
|
results.manager.secondName | string |
マネージャーのミドル ネーム |
|
アクティブです
|
results.active | boolean |
その人が現在アクティブであるかどうか |
|
部署 ID
|
results.department.id | integer |
その人に関連付けられている部署の ID |
|
部署名
|
results.department.name | string |
部署に付けられた名前 |
|
タグ
|
results.tag | string |
個人を表すタグ |
|
ロール ID
|
results.role.id | integer |
ロール ID |
|
ロール名
|
results.role.name | string |
ロール名 |
|
プロフィール画像
|
results.avatarURL | string |
個人のプロフィール写真への URL |
|
状態 ID
|
results.status.id | integer |
レコードの状態 ID |
|
状態の名前
|
results.status.name | string |
レコードの状態名 |
|
個人の状態 ID
|
results.personStatus.id | integer |
個人の状態 ID |
|
個人の状態名
|
results.personStatus.name | string |
個人の状態名 |
|
開始日
|
results.startDate | string |
その人が最初に組織で働き始めたとき |
新しいアラートの作成
複数の通信チャネルを介して StaffCircle ユーザーに配布できる新しい通知を作する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
敬称
|
title | True | string |
通知のタイトル |
|
優先順位
|
priority | True | string |
通知の優先度 |
|
サマリー
|
summary | string |
通知のメイン コンテンツ |
|
|
すべてのユーザーに送信
|
everyone | boolean |
この通知を会社内のすべてのユーザーに送信する必要がある |
|
|
部署タグに送信
|
departmentTags | string |
通知を受信する必要がある部署タグのコンマ区切りリスト。 すべてのユーザーに送信が True に設定されている場合は使用しない |
|
|
ユーザー タグに送信
|
peopleTags | string |
通知を受信する必要があるユーザー タグのコンマ区切りリスト。 すべてのユーザーに送信が True に設定されている場合は使用しない |
|
|
グループ タグに送信
|
groupTags | string |
通知を受信する必要があるグループ タグのコンマ区切りリスト。 すべてのユーザーに送信が True に設定されている場合は使用しない |
|
|
サイト タグに送信
|
siteTags | string |
通知を受信する必要があるサイト タグのコンマ区切りリスト。 すべてのユーザーに送信が True に設定されている場合は使用しない |
|
|
プッシュ Notifications を送信する
|
push | boolean |
プッシュ通知を介してユーザーに通知するかどうか |
|
|
SMS Notifications を送信する
|
sms | boolean |
SMS 通知を介してユーザーに通知するかどうか |
|
|
電子メール通知の送信
|
boolean |
アラート通知を電子メールで送信するかどうか |
||
|
アプリ内通知を送信
|
inApp | boolean |
アプリ内通知を介してユーザーに通知するかどうか |
|
|
Microsoft Teams 通知の送信
|
teams | boolean |
Microsoft Teams 通知を介してユーザーに通知するかどうか |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
通知を表す識別子 |
新しいタスクを作成する
新しいタスクを作成し、それをユーザーに割り当てる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
敬称
|
title | True | string |
タスクのタイトル |
|
優先順位 ID
|
priorityId | integer |
タスクの優先度です。 タスク グループから派生していない場合は必須 |
|
|
内容
|
description | string |
タスクに与えられた説明 |
|
|
Worksheet
|
formId | True | integer |
タスクで使用されるワークシート |
|
期日
|
dueDate | date-time |
タスクの完了予定日 |
|
|
ID に割り当て済み
|
assignedToId | integer |
タスクは誰に割り当てられましたか。 メールに割り当てを渡す場合は使用できない |
|
|
マネージャー ID
|
managerId | integer |
タスクを管理しているのは誰ですか。 マネージャーのメールを渡す場合は使用できない |
|
|
タスク グループ ID
|
taskGroupId | True | integer |
タスクが割り当てられているタスク |
|
メールに割り当て済み
|
assignedToEmail | string |
タスクが割り当てられた人のメール。 割り当て ID を渡す場合は使用できない |
|
|
マネージャーのメール
|
managerEmail | string |
タスクを管理している人のメール。 マネージャー ID が渡された場合は割り当てられない |
|
|
タスク間隔 ID
|
taskIntervalId | integer |
タスク間隔の ID。 タスクが繰り返す場合に必要 |
|
|
プッシュ Notifications を送信する
|
push | boolean |
タスクに関するプッシュ通知を送信する |
|
|
SMS Notifications を送信する
|
sms | boolean |
タスクに関する SMS 通知を送信する |
|
|
電子メール通知の送信
|
boolean |
タスクに関するメール通知を送信する |
||
|
Microsoft Teams Notifications を送信する
|
teams | boolean |
タスクに関する Microsoft Teams 通知を送信する |
|
|
アプリ内 Notifications を送信
|
inApp | boolean |
タスクに関するアプリ内通知を送信する |
|
|
いいね! を許可する
|
allowLikes | boolean |
ユーザーがタスクに "いいね!" を付けることができるようにする |
|
|
コメントを許可する
|
allowComments | boolean |
タスクへのコメントを許可する |
|
|
コメントでイメージを許可する
|
allowImagesInComments | boolean |
コメントに添付するすべての画像 |
|
|
ドキュメントを許可する
|
allowDocuments | boolean |
コメントに添付するすべてのドキュメント |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
タスクの識別子 |
新しい個人を作成する
個人を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名
|
firstName | True | string |
個人の名 |
|
ミドル ネーム
|
secondName | True | string |
個人のミドル ネーム |
|
電子メール
|
True | string |
個人の仕事用メール アドレス |
|
|
携帯電話
|
mobile | True | string |
個人の携帯電話番号 |
|
誕生日
|
dateOfBirth | True | date |
個人の生年月日 |
|
開始日
|
startDate | True | string |
個人の雇用が開始したとき |
|
住所 1
|
addressLine1 | string |
個人の自宅の住所の最初の行 |
|
|
住所 2
|
addressLine2 | string |
個人の自宅の住所の 2 行目 |
|
|
町
|
town | string |
個人の居住地の町 |
|
|
郵便番号
|
postCode | string |
個人の郵便番号 |
|
|
市区郡の名前
|
countyName | string |
個人の居住する郡 |
|
|
国名
|
countryName | string |
個人の居住国 |
|
|
タイトル名
|
titleName | string |
個人のタイトル |
|
|
ミドルネーム
|
middleName | string |
個人のミドル ネーム |
|
|
個人的なメール
|
homeEmail | string |
その人の個人的なメール アドレス |
|
|
自宅電話
|
homeTelephone | string |
個人の自宅電話番号 |
|
|
タグ
|
tag | string |
StaffCircle プラットフォーム全体担当者を参照するために使用できるタグ |
|
|
マネージャーのメール
|
managerEmail | string |
個人のマネージャー メール アドレス。 これは、マネージャーを個人にリンクするために使用できる |
|
|
部署名
|
departmentName | string |
個人が属する部署の名前 |
|
|
ロール名
|
roleName | string |
個人のロール。 これは、ロールを個人にリンクするために使用できる |
|
|
知られている
|
knownAs | string |
個人が好む名前 |
|
|
プロファイル画像 URL
|
avatarURL | string |
個人のプロファイル画像 |
|
|
タイトル ID
|
titleId | integer |
個人のタイトル |
|
|
市区郡 ID
|
countyId | integer |
個人の居住する郡 |
|
|
国 ID
|
countryId | integer |
個人の居住国 |
|
|
性別 ID
|
genderId | integer |
個人の性別識別子 |
|
|
国籍 ID
|
nationalityId | integer |
個人の国籍 |
|
|
民族 ID
|
ethnicityId | integer |
個人の民族 |
|
|
婚姻区分 ID
|
maritalStatusId | integer |
個人の婚姻区分 |
|
|
マネージャー ID
|
managerId | integer |
個人のマネージャー識別子 (マネージャー ID またはマネージャーのメールのみを入力できる) |
|
|
部署 ID
|
departmentId | integer |
個人の部署識別子 (部署 ID または部署名のみを入力できる) |
|
|
ロール ID
|
roleId | integer |
個人の雇用ロール識別子 (ロール ID またはロール名のみを入力できる) |
|
|
サイト ID
|
mainSiteId | integer |
個人が属するサイト識別子 |
|
|
緊急連絡先の同意
|
emergencyContactConsent | boolean |
緊急連絡先が詳細を保存することに同意したかどうか |
|
|
緊急連絡先名
|
emergencyContactName | string |
個人の緊急連絡先の名前 |
|
|
緊急連絡先の関係 ID
|
emergencyRelationshipId | integer |
緊急連絡先と個人の関係 |
|
|
緊急連絡先電話
|
emergencyContactTelephone | string |
個人の緊急連絡先の電話番号 |
|
|
緊急アドレス
|
emergencyAddress | string |
個人の緊急アドレス |
|
|
近親者名
|
nextOfKinName | string |
個人の近親者の名前 |
|
|
近親者関係 ID
|
nextOfKinRelationshipId | integer |
近親者と個人の関係 |
|
|
近親者の電話
|
nextOfKinTelephone | string |
個人の近親者の電話番号 |
|
|
ダイヤル コード
|
dialingCode | string |
個人の電話番号の国際ダイヤル コード |
|
|
勤務先内線
|
workExtension | string |
個人の勤務先内線番号 |
|
|
勤務先電話
|
telephone | string |
個人の勤務先電話番号 |
|
|
個人用携帯電話
|
personalMobile | string |
個人の個人用携帯電話番号 |
|
|
状態 ID
|
statusId | integer |
個人の StaffCircle アカウントの状態 |
|
|
雇用の種類 ID
|
employmentTypeId | integer |
個人の雇用の種類 |
|
|
契約の種類 ID
|
contractTypeId | integer |
個人の契約 |
|
|
契約満了
|
contractExpiry | date |
人々の雇用契約が満了する日 |
|
|
雇用状況
|
employmentStatusId | integer |
個人の雇用状況 |
|
|
二次雇用状況
|
secondaryEmploymentStatusId | integer |
リンクされた二次雇用状況 |
|
|
雇用ノート
|
employmentNotes | string |
個人に関する雇用ノート |
|
|
医療ノート
|
medicalNotes | string |
個人に関連する重要な医療ノート |
|
|
個人データは有効か
|
isPersonalDataEnabled | boolean |
個人データ が有効かどうか |
|
|
連絡先データは有効ですか
|
isContactDataEnabled | boolean |
連絡先データが有効かどうか |
|
|
タイム ゾーン
|
timeZone | string |
個人が住んでいるタイム ゾーン |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
個人 ID
|
id | integer |
個人の識別子 |
新しい目的の作成
新しい目的の作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンピテンシー
|
categoryId | True | integer |
リンクされた目的コンピテンシー |
|
敬称
|
title | True | string |
新しい目的の名前。 |
|
内容
|
description | True | string |
新しい目的の説明。 |
|
開始日
|
startDate | True | date-time |
目的が測定されているときから |
|
終了日
|
endDate | True | date-time |
目的の期限 |
|
値の種類
|
valueType | True | string |
目的の測定方法を定義する |
|
タグ
|
tag | string |
検索とレポートで使用するためのテキスト タグ。 |
|
|
マネージャーのメール
|
managerEmail | string |
目的の追跡を担当するマネージャーのメール。 自動的に既定で個人または部署のマネージャーになります。 個人または部署にマネージャーがいない場合、または目的が会社の目的である場合に必要です。 マネージャー ID が提供されていない場合に使用される |
|
|
マネージャー ID
|
managerId | integer |
目的の追跡を担当するマネージャー。 自動的に既定で個人または部署のマネージャーになります。 個人または部署にマネージャーがいない場合、または目的が会社の目的である場合に必要です。 マネージャーのメールが提供されていない場合に使用される |
|
|
個人のメール
|
personEmail | string |
目的の個人のメール アドレス。 個人的な目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
個人 ID
|
personId | integer |
目的の個人の ID。 個人的な目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
部署名
|
departmentName | string |
目的の部署の名前。 部署の目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
部署 ID
|
departmentId | integer |
目的の部署の ID。 部署の目的を作成するために必要です。 部署または個人が提供されていない場合、目的は会社の目的であると見なされる |
|
|
会社の目的 ID
|
companyObjectiveId | integer |
新しく作成された目的が関連する会社の目的へのオプションのリンク |
|
|
部署の目的 ID
|
departmentObjectiveId | integer |
新しく作成された目的が関連する部署へのオプションのリンク |
|
|
開始値
|
startValue | double |
目的の測定方法を定義する |
|
|
目標
|
target | double |
目標を正常に完了するために達した対象値 |
|
|
追加の進行状況を許可する
|
allowAddProgress | boolean |
True の場合、人は自分で進行状況を追加できます。それ以外の場合は、指定されたマネージャーのみが目的を更新できます。 既定: false。 |
|
|
繰り返しタイプ
|
recurType | string |
提供された場合、目的は繰り返し発生します。 繰り返しの時間の単位を定義します。 |
|
|
繰り返し間隔
|
recurInterval | integer |
目標が何日/週/月/年繰り返されますか。 目的が繰り返す場合に必要です。 |
|
|
累積的な進行状況
|
cumulativeProgress | boolean |
StaffCircle フロント エンドから進行状況を追加する場合に、進行状況を増分値として追加するかどうかを指定します。 |
|
|
プッシュ通知を送信する
|
push | boolean |
プッシュ通知を送信します。 |
|
|
SMS 通知を送信する
|
sms | boolean |
SMS 通知を送信する |
|
|
電子メール通知の送信
|
boolean |
メールの更新を送信する |
||
|
Teams 通知を送信する
|
teams | boolean |
チーム統合が有効になっている場合、Microsoft Teams を介して更新を送信する |
|
|
アプリ内通知を送信
|
inApp | boolean |
InApp 通知を送信する |
|
|
いいね! を許可する
|
allowLikes | boolean |
ユーザーが目的に "いいね!" を付けることができるようにする |
|
|
コメントを許可する
|
allowComments | boolean |
目的に関するコメントを許可する |
|
|
コメントでイメージを許可する
|
allowImagesInComments | boolean |
コメントに添付するすべての画像。 |
|
|
ドキュメントを許可する
|
allowDocuments | boolean |
コメントに添付するすべてのドキュメント |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
目的 ID
|
id | integer |
目的の識別子 |
新しい記事を作成する
複数の通信チャネルを介して StaffCircle ユーザーに配布できる新しい記事を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
敬称
|
title | True | string |
記事のタイトル。 最大文字数 250 文字 |
|
優先順位
|
priority | True | string |
記事の優先度は何か |
|
記事の種類
|
articleType | True | string |
作成される記事の種類 |
|
HTML コンテンツ
|
htmlContent | True | string |
記事のメイン HTML コンテンツ。 |
|
記事イメージ URL
|
mainImageUrl | string |
フィードの記事のメイン イメージとして使用されるイメージへの URL。 |
|
|
サマリー
|
summary | string |
記事の概要。 指定しない場合、既定で HTML コンテンツの最初の 500 文字。 |
|
|
タグ
|
tag | True | string |
記事に関連付けられているタグ。 最大文字 250 |
|
チャネル ID
|
channelId | integer |
記事はどのチャネルに公開されますか。 空白のままにすると、既定のフィードに設定される |
|
|
プッシュ Notifications を送信する
|
push | boolean |
プッシュ通知で記事についてユーザーに通知するかどうか |
|
|
SMS Notifications を送信する
|
sms | boolean |
SMS 通知で記事についてユーザーに通知するかどうか |
|
|
電子メール通知の送信
|
boolean |
電子メール通知で記事についてユーザーに通知するかどうか |
||
|
アプリ内 Notifications を送信
|
inApp | boolean |
アプリ通知で記事についてユーザーに通知するかどうか |
|
|
Teams Notifications の送信
|
teams | boolean |
Microsoft Teams 通知で記事についてユーザーに通知するかどうか |
|
|
いいね! を許可する
|
allowLikes | boolean |
ユーザーは記事に "いいね!" を付けることができますか。 既定値 True |
|
|
コメントを許可する
|
allowComments | boolean |
ユーザーは記事にコメントできますか。 既定値 True。 |
|
|
コメントでイメージを許可する
|
allowImagesInComments | boolean |
コメントでイメージ許可するかどうか |
|
|
日付からのピン留め
|
pinFromDate | date-time |
記事をピン留めする必要がありますか。 その場合、日付を与えます。 ピン留め継続時間が提供されている場合は必須 |
|
|
ピン留め継続時間
|
pinDurationHours | integer |
日付からのピン留めから何時間後に記事をピン留めにしたままにする必要がありますか。 日付からのピン留めが提供されている場合は必須です。 |
|
|
公開スケジュールの日時
|
scheduledDateTime | string |
この記事は将来公開される予定ですか。 |
|
|
公開即時
|
publishImmediately | boolean |
この記事をすぐに公開する必要があるか |
|
|
ユーザー ID を公開する
|
publishAsUserId | integer |
そうでない場合、API 呼び出しを行うユーザーは、これを代わりに行う必要があります。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
作成された記事の識別子 |
目的のスコアを更新する
新しいスコアと説明で目的を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
目的 ID
|
objectiveId | True | string |
進行状況スコアを更新する目的 |
|
値
|
value | True | double |
現在の総進行状況 |
|
増分
|
isIncrement | boolean |
False の場合、渡される値は目的の現在の値です。 True の場合、値は既存の合計に追加する必要がある |
|
|
内容
|
description | True | string |
進行状況の簡単な説明 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
目的の進行状況の記録の識別子 |
目的の検索
目的の検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索タイトル
|
SearchTitle | string |
タイトルに基づいて検索する文字列の一致が緩い |
|
|
個人のメール
|
PersonEmail | string |
目的が割り当てられている人のメール |
|
|
タグ
|
Tag | string |
目的に割り当てられたタグ |
|
|
終了
|
Closed | string |
目的が閉じている場合。 閉じている場合は True 、それ以外は False |
|
|
目的の種類
|
ObjectiveType | string |
目的の種類 |
|
|
From
|
From | date-time |
目的はこの時からアクティブ |
|
|
発信先
|
To | date-time |
目的はこの時からアクティブ |
|
|
アクティブ
|
ActiveAt | date-time |
目的はこの時点でアクティブ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
結果
|
results | array of object |
結果 |
|
目的 ID
|
results.id | integer |
目的の識別子 |
|
敬称
|
results.title | string |
目的に与えられたタイトル |
|
内容
|
results.description | string |
目的に与えられた説明 |
|
タグ
|
results.tag | string |
目的に関連付けられたタグ |
|
目的の種類
|
results.objectiveType | string |
目的の種類 |
|
終了
|
results.closed | boolean |
目的が閉じているかどうか |
|
閉じられた理由
|
results.closedReason | string |
目的が閉じられた理由 |
|
個人 ID
|
results.person.id | integer |
目的の対象となる人の識別子 |
|
人の名
|
results.person.firstName | string |
目的の対象となる人の名 |
|
個人の家族名
|
results.person.secondName | string |
目的の対象となる人の家族名 |
|
マネージャー ID
|
results.manager.id | integer |
マネージャーの識別子 |
|
マネージャーの名
|
results.manager.firstName | string |
マネージャーの名 |
|
マネージャーの家族名
|
results.manager.secondName | string |
マネージャーの家族名 |
|
個人 ID で作成
|
results.createdBy.id | integer |
目的を作成した人の識別子 |
|
個人名で作成
|
results.createdBy.firstName | string |
目的を作成した人の名 |
|
個人の家族名で作成
|
results.createdBy.secondName | string |
目的を作成した人の家族名 |
|
部署 ID
|
results.department.id | integer |
目的にリンクされた部署識別子 |
|
部署名
|
results.department.name | string |
目的にリンクされた部署の名前 |
|
部署の目的 ID
|
results.departmentObjective.id | integer |
部署目的の識別子 |
|
部署の目的のタイトル
|
results.departmentObjective.title | string |
部署の目的のタイトル |
|
部署の目的の説明
|
results.departmentObjective.description | string |
部署の目的の説明 |
|
会社の目的 ID
|
results.companyObjective.id | integer |
会社の目的識別子 |
|
会社の目的タイトル
|
results.companyObjective.title | string |
会社の目的タイトル |
|
会社の目的の説明
|
results.companyObjective.description | string |
会社の目的の説明 |
|
現在の進行状況
|
results.currentProgress | double |
目標の現在の進行状況 |
|
開始日
|
results.startDate | string |
目的が測定されているときから |
|
終了日
|
results.endDate | string |
目的の期限 |
トリガー
| 新しいタスクが追加されたとき |
新しいタスクが追加されたときにトリガーされる |
| 新しいレビューが追加されたとき |
新しいレビューが追加されたときにトリガーされる |
| 新しい人が追加されたとき |
新しい人が追加されたときにトリガーされる |
| 新しい休暇が追加されたとき |
新しい休暇が追加されたときにトリガーされる |
| 新しい目的が追加されたとき |
新しい目的が追加されたときにトリガーされる |
| 新しい記事が公開されたとき |
新しい記事が公開されたときにトリガーします |
| 目標が更新されたとき |
目標が更新されたときにトリガーされる |
新しいタスクが追加されたとき
新しいタスクが追加されたときにトリガーされる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
webhook に付けられた名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
記録 URL
|
subjectFrontEndUrl | string |
StaffCircle のレコードへの URL |
|
ID
|
data.id | integer |
タスクを表す一意の識別子 |
|
敬称
|
data.title | string |
タスクのタイトル |
|
内容
|
data.description | string |
タスクの説明 |
|
優先順位
|
data.priority | string |
タスクの優先度 |
|
タスク グループ ID
|
data.groupId | integer |
タスク グループを表す一意の識別子 |
|
タスク グループ タイトル
|
data.groupTitle | string |
タスク グループのタイトル |
|
アドホック
|
data.isAdhoc | boolean |
これがアドホック タスクかどうか |
|
個人 ID で作成
|
data.createdByPerson.PersonId | integer |
タスクを作成した人の識別子 |
|
名で作成
|
data.createdByPerson.FirstName | string |
タスクを作成した人の名 |
|
家族名で作成
|
data.createdByPerson.FamilyName | string |
タスクを作成した人の家族名 |
|
メールで作成
|
data.createdByPerson.Email | string |
タスクを作成した人のメール |
|
個人 ID
|
data.person.PersonId | integer |
タスクの対象となる人の識別子 |
|
人の名
|
data.person.FirstName | string |
タスクの対象となる人の名 |
|
個人の家族名
|
data.person.FamilyName | string |
タスクの対象となる人の家族名 |
|
個人のメール
|
data.person.Email | string |
タスクの対象となる人のメール |
|
マネージャー ID
|
data.manager.PersonId | integer |
タスクのマネージャーを表す一意の識別子 |
|
マネージャーの名
|
data.manager.FirstName | string |
タスクのマネージャーの名 |
|
マネージャーの家族名
|
data.manager.FamilyName | string |
タスクのマネージャーの家族名 |
|
マネージャーのメール
|
data.manager.Email | string |
タスクのマネージャーのメール |
|
期日
|
data.dueDate | date |
タスクの期日 |
|
作成日
|
data.createdOn | date-time |
タスクが作成された日時 |
|
フォーム ID
|
data.form.id | integer |
タスクの記入に使用されるフォームの識別子 |
|
フォームのタイトル
|
data.form.title | string |
タスクの記入に使用されるフォームのタイトル |
|
プッシュ通知
|
data.notificationSettings.push | boolean |
タスクのプッシュ通知を送信するかどうか |
|
SMS Notifications
|
data.notificationSettings.sms | boolean |
SMS の通知を送信するかどうか |
|
電子メール通知
|
data.notificationSettings.email | boolean |
タスクのメール通知を送信するかどうか |
|
Microsoft Teams Notifications
|
data.notificationSettings.microsoftTeams | boolean |
Microsoft Teams の通知を送信するかどうか |
|
アプリ内 Notifications
|
data.notificationSettings.inApp | boolean |
アプリ内の通知を送信するかどうか |
|
いいね! を許可する
|
data.contentSettings.allowLikes | boolean |
タスクがいいねを許可するかどうか |
|
コメントを許可する
|
data.contentSettings.allowComments | boolean |
コメントがいいねを許可するかどうか |
|
コメントでイメージを許可する
|
data.contentSettings.allowImagesInComments | boolean |
タスクがコメントでイメージを許可するかどうか |
|
ドキュメントを許可する
|
data.contentSettings.allowDocuments | boolean |
ドキュメントがタスクを許可するかどうか |
新しいレビューが追加されたとき
新しいレビューが追加されたときにトリガーされる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
webhook に付けられた名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
記録 URL
|
subjectFrontEndUrl | string |
StaffCircle のレコードの URL |
|
ID
|
data.id | integer |
レビューの識別子 |
|
以前のレビュー ID
|
data.previousReviewId | integer |
このレビュー対象者の以前のレビューの識別子 |
|
マネージャー ID
|
data.manager.PersonId | integer |
レビューに関連付けられているマネージャーを表す識別子 |
|
マネージャーの名
|
data.manager.FirstName | string |
レビューに関連付けられているマネージャーの名 |
|
マネージャーの家族名
|
data.manager.FamilyName | string |
レビューに関連付けられているマネージャーの家族名 |
|
マネージャーのメール
|
data.manager.Email | string |
レビューに関連付けられているマネージャーのメール アドレス |
|
internalReviewerPersonIds
|
data.internalReviewerPersonIds | array of integer |
internalReviewerPersonIds |
|
レビュー対象者 ID
|
data.person.PersonId | integer |
レビュー対象者の識別子 |
|
レビュー対象者の名
|
data.person.FirstName | string |
レビュー対象者の名 |
|
レビュー対象者の家族名
|
data.person.FamilyName | string |
レビュー対象者の家族名 |
|
レビュー対象者のメール
|
data.person.Email | string |
レビュー対象者のメール アドレス |
|
敬称
|
data.title | string |
レビューに付けられたタイトル |
|
内容
|
data.description | string |
レビューに与えられた説明 |
|
レビューの種類
|
data.reviewType | string |
レビューの種類 |
|
期限
|
data.dueOn | date-time |
レビューの期日 |
|
attachedDocumentIds
|
data.attachedDocumentIds | array of integer |
attachedDocumentIds |
|
linkedObjectives
|
data.linkedObjectives | array of integer |
linkedObjectives |
|
評定テンプレート ID
|
data.appraisalSummary.personAppraisalTemplateId | integer |
評定の作成に使用する評定テンプレート |
|
現在のスコア
|
data.scores.currentScore | double |
レビューの現在のスコア |
|
作成日
|
data.createdAt | date-time |
レビューが作成された日時 |
|
作成者 ID
|
data.createdByPerson.PersonId | integer |
レビューを作成した人の識別子 |
|
名で作成
|
data.createdByPerson.FirstName | string |
レビューを作成した人の名 |
|
家族名で作成
|
data.createdByPerson.FamilyName | string |
レビューを作成した人の家族名 |
|
メールで作成
|
data.createdByPerson.Email | string |
レビューを作成した人のメール アドレス |
|
いいね! を許可する
|
data.contentSettings.allowLikes | boolean |
いいねが許可されるかどうか |
|
コメントを許可する
|
data.contentSettings.allowComments | boolean |
レビューへのコメントを許可するかどうか |
|
コメントでイメージを許可する
|
data.contentSettings.allowImagesInComments | boolean |
コメントでイメージ許可するかどうか |
|
ドキュメントを許可する
|
data.contentSettings.allowDocuments | boolean |
レビューにドキュメントを添付できるかどうか |
|
プッシュ通知
|
data.notificationSettings.push | boolean |
プッシュ通知を送信するかどうか |
|
SMS Notifications
|
data.notificationSettings.sms | boolean |
SMS 通知を送信するかどうか |
|
メール通知
|
data.notificationSettings.email | boolean |
メール通知を送信するかどうか |
|
Microsoft Teams Notifications
|
data.notificationSettings.microsoftTeams | boolean |
Microsoft Teams 通知を送信するかどうか |
|
アプリ内 Notifications
|
data.notificationSettings.inApp | boolean |
アプリ内通知を送信するかどうか |
新しい人が追加されたとき
新しい人が追加されたときにトリガーされる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
webhook に付けられた名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
記録 URL
|
subjectFrontEndUrl | string |
StaffCircle のレコードへの URL |
|
個人 ID
|
data.id | integer |
人を表す識別子 |
|
名
|
data.givenName | string |
個人の名 |
|
ミドルネーム
|
data.middleName | string |
個人のミドル ネーム |
|
姓
|
data.familyName | string |
その人の家族名 |
|
として知られている
|
data.knownAs | string |
個人が好む名前 |
|
誕生日
|
data.dateOfBirth | date |
個人の生年月日 |
|
個人的なメール
|
data.contactDetails.personalEmail | string |
その人の個人的なメール アドレス |
|
勤務先メール
|
data.contactDetails.workEmail | string |
個人の仕事用メール アドレス |
|
仕事用携帯電話
|
data.contactDetails.workMobile | string |
個人の仕事用携帯電話番号 |
|
個人用携帯電話
|
data.contactDetails.personalMobile | string |
個人の個人用携帯電話番号 |
|
自宅の電話
|
data.contactDetails.homeTelephone | string |
個人の自宅の電話番号 |
|
勤務先電話
|
data.contactDetails.workTelephone | string |
個人の勤務先電話番号 |
|
勤務先電話
|
data.contactDetails.workExtension | string |
個人の勤務先内線番号 |
|
住所 1
|
data.address.addressLine1 | string |
個人の自宅の住所の最初の行 |
|
住所 2
|
data.address.addressLine2 | string |
個人の自宅の住所の最初の行 |
|
町
|
data.address.town | string |
個人の居住地の町 |
|
郵便番号
|
data.address.postCode | string |
個人の郵便番号 |
|
緊急連絡先名
|
data.emergencyContact.emergencyContactName | string |
個人の緊急連絡先の名前 |
|
緊急連絡先電話
|
data.emergencyContact.emergencyContactTelephone | string |
個人の緊急連絡先の電話番号 |
|
緊急連絡先の関係 ID
|
data.emergencyContact.emergencyRelationshipId | integer |
緊急連絡先と個人の関係 |
|
緊急連絡先の同意
|
data.emergencyContact.emergencyContactConsent | boolean |
緊急連絡先が詳細を保存することに同意したかどうか |
|
緊急連絡先住所
|
data.emergencyContact.emergencyAddress | string |
個人の緊急連絡先住所 |
|
医療ノート
|
data.emergencyContact.emergencyMedicalNotes | string |
個人に関連する重要な医療ノート |
|
近親者名
|
data.nextOfKin.Name | string |
個人の近親者 |
|
近親者の電話
|
data.nextOfKin.Telephone | string |
個人の近親者の電話番号 |
|
近親者関係 ID
|
data.nextOfKin.RelationshipId | string |
近親者と個人の関係 |
|
雇用ノート
|
data.employeeDetails.employmentNotes | string |
個人に関する雇用ノート |
|
タグ
|
data.employeeDetails.tag | string |
StaffCircle プラットフォーム全体担当者を参照するために使用できるタグ |
|
開始日
|
data.employeeDetails.startDate | string |
個人の雇用が開始したとき |
|
サイト ID
|
data.employeeDetails.siteId | integer |
個人が属するサイト識別子 |
|
グループ ID
|
data.employeeDetails.groupId | integer |
個人が属するグループ |
|
部署 ID
|
data.employeeDetails.departmentId | integer |
個人が属する部署 |
|
マネージャー ID
|
data.employeeDetails.manager.PersonId | integer |
個人のマネージャーの識別子 |
|
マネージャーの名
|
data.employeeDetails.manager.FirstName | string |
個人のマネージャーの名 |
|
マネージャーの家族名
|
data.employeeDetails.manager.FamilyName | string |
個人のマネージャーの家族名 |
|
マネージャーのメール
|
data.employeeDetails.manager.Email | string |
その人のマネージャーのメール アドレス |
|
アカウントの状態
|
data.accountStatus | integer |
個人の StaffCircle アカウントの状態 |
新しい休暇が追加されたとき
新しい休暇が追加されたときにトリガーされる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
webhook に付けられた名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
記録 URL
|
subjectFrontEndUrl | string |
StaffCircle のレコードの URL |
|
ID
|
data.id | integer |
休暇の識別子 |
|
個人 ID
|
data.requestedForPerson.PersonId | integer |
欠勤申請の対象となる人の識別子 |
|
人の名
|
data.requestedForPerson.FirstName | string |
欠勤申請の対象となる人の名 |
|
個人の家族名
|
data.requestedForPerson.FamilyName | string |
欠勤申請の対象となる人の家族名 |
|
個人のメール
|
data.requestedForPerson.Email | string |
欠勤申請の対象となる人のメール アドレス |
|
単位の種類
|
data.unitType | string |
欠勤申請単位タイプ (時間、日) |
|
時間数
|
data.numberOfHours | double |
申請オフされた時間数 |
|
部分日
|
data.partialDay | string |
部分日が申請オフされたかどうか (午前、午後) |
|
開始日
|
data.start | date-time |
欠勤が開始するとき |
|
終了日
|
data.end | date-time |
欠勤が終了するとき |
|
種類 ID
|
data.typeId | integer |
要求されている欠勤の種類の識別子 |
|
タイプ
|
data.type | string |
要求されている欠勤の種類 |
|
サブ種類 ID
|
data.subTypeId | integer |
要求されている欠勤のサブ種類の識別子 |
|
ポリシー ID
|
data.policyId | integer |
スタッフ メンバーが適用している欠勤ポリシーの識別子 |
|
理由
|
data.reason | string |
欠勤申請の理由 |
|
作成日
|
data.createdAt | date-time |
欠席依頼があったとき |
|
作成者 ID
|
data.createdByPerson.PersonId | integer |
欠勤申請を作成した人の識別子 |
|
名で作成
|
data.createdByPerson.FirstName | string |
欠勤申請を作成した人の名 |
|
家族名で作成
|
data.createdByPerson.FamilyName | string |
欠勤申請を作成した人の家族名 |
|
メールで作成
|
data.createdByPerson.Email | string |
欠勤申請のを作成した人のメール アドレス |
|
承認の状態
|
data.approvalDetails.status | string |
承認の状態 (保留中、承認済み、拒否済み) |
|
承認日
|
data.approvalDetails.approvedAt | date-time |
欠勤が承認されたとき |
|
承認応答
|
data.approvalDetails.response | string |
承認者からの応答 |
|
ID による承認
|
data.approvalDetails.approvedByPerson.PersonId | integer |
欠勤を承認した人の識別子 |
|
名で承認
|
data.approvalDetails.approvedByPerson.FirstName | string |
欠勤を承認した人の名 |
|
家族名で承認
|
data.approvalDetails.approvedByPerson.FamilyName | string |
欠勤を承認した人の家族名 |
|
メールで承認
|
data.approvalDetails.approvedByPerson.Email | string |
欠勤を承認した人のメール アドレス |
|
マネージャー ID
|
data.manager.PersonId | integer |
欠勤申請に関与したマネージャーの識別子 |
|
マネージャーの名
|
data.manager.FirstName | string |
欠勤申請に関与したマネージャーの名 |
|
マネージャーの家族名
|
data.manager.FamilyName | string |
欠勤申請に関与したマネージャーの家族名 |
|
マネージャーのメール
|
data.manager.Email | string |
欠勤申請に関与したマネージャーのメール アドレス |
新しい目的が追加されたとき
新しい目的が追加されたときにトリガーされる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
webhook に付けられた名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
記録 URL
|
subjectFrontEndUrl | string |
StaffCircle のレコードへの URL |
|
目的 ID
|
data.id | integer |
目的の識別子 |
|
目的テンプレート
|
data.templateId | integer |
目的テンプレートから新しい目的を作成する |
|
マネージャー ID
|
data.manager.PersonId | integer |
その人のマネージャーの識別子 |
|
マネージャーの名
|
data.manager.FirstName | string |
その人のマネージャーの名 |
|
マネージャーの家族名
|
data.manager.FamilyName | string |
その人のマネージャーの家族名 |
|
マネージャーのメール
|
data.manager.Email | string |
その人のマネージャーのメール アドレス |
|
個人識別子
|
data.person.PersonId | integer |
目的にリンクされた個人の識別子 |
|
人の名
|
data.person.FirstName | string |
目的にリンクされた個人の名 |
|
個人の家族名
|
data.person.FamilyName | string |
目的にリンクされた個人の家族名 |
|
個人のメール
|
data.person.Email | string |
目的にリンクされた個人のメール アドレス |
|
敬称
|
data.title | string |
新しい目的の名前 |
|
内容
|
data.description | string |
新しい目的の説明 |
|
値の種類
|
data.valueType | string |
目的の測定方法を定義する |
|
タグ
|
data.tag | string |
検索とレポートで使用するためのテキスト タグ |
|
カテゴリ
|
data.category | string |
目標カテゴリ識別子 |
|
開始日
|
data.startDate | date-time |
目的が測定されているときから |
|
終了日
|
data.endDate | string |
目的の期限 |
|
最後の進展日
|
data.lastProgressDate | date-time |
目的に進展があった日付 |
|
closed
|
data.closed | boolean |
終了 |
|
追加の進行状況を許可する
|
data.allowAddProgress | boolean |
True の場合、人は自分で進行状況を追加でき、それ以外の場合は、指定されたマネージャーのみが目的を更新する |
|
プッシュ通知
|
data.notificationSettings.push | boolean |
プッシュ通知を送信します。 |
|
SMS 通知
|
data.notificationSettings.sms | boolean |
SMS 通知を送信する |
|
メール通知
|
data.notificationSettings.email | boolean |
メールの更新を送信する |
|
Teams 通知
|
data.notificationSettings.microsoftTeams | boolean |
チーム統合が有効になっている場合、Microsoft Teams を介して更新を送信する |
|
アプリ内通知
|
data.notificationSettings.inApp | boolean |
InApp 通知を送信する |
|
いいね! を許可する
|
data.contentSettings.allowLikes | boolean |
ユーザーが目的に "いいね!" を付けることができるようにする |
|
コメントを許可する
|
data.contentSettings.allowComments | boolean |
目的に関するコメントを許可する |
|
コメントでイメージを許可する
|
data.contentSettings.allowImagesInComments | boolean |
コメントに添付するすべての画像。 |
|
ドキュメントを許可する
|
data.contentSettings.allowDocuments | boolean |
コメントに添付するすべてのドキュメント |
|
作成場所
|
data.createdAt | date-time |
目的が作成されたとき |
|
個人 ID で作成
|
data.createdByPerson.PersonId | integer |
目的を作成した人の識別子 |
|
個人名で作成
|
data.createdByPerson.FirstName | string |
目的を作成した人の名 |
|
個人の家族名で作成
|
data.createdByPerson.FamilyName | string |
目的を作成した人の家族名 |
|
個人メールで作成
|
data.createdByPerson.Email | string |
目的を作成した人のメール アドレス |
|
現在の進行状況
|
data.currentProgress | double |
目標の現在の進行状況 |
|
開始値
|
data.startValue | double |
目的の測定方法を定義する |
|
目標
|
data.targetValue | double |
目標を正常に完了するために達した対象値 |
新しい記事が公開されたとき
新しい記事が公開されたときにトリガーします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | string |
名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
記事 URL
|
subjectFrontEndUrl | string |
記事への URL |
|
ID
|
data.Id | integer |
記事の識別子 |
|
敬称
|
data.Title | string |
記事に付けられたタイトル |
|
サマリー
|
data.Summary | string |
記事の概要 |
|
タグ
|
data.Tag | string |
記事に関連付けられているタグ |
|
優先名
|
data.PriorityName | string |
記事の優先度 |
|
作成日
|
data.CreatedAt | date-time |
記事が最初に作成された日付 |
|
すべてのユーザー
|
data.AudienceDto.Everyone | boolean |
記事がすべての人に公開されているかどうか |
|
個人
|
data.AudienceDto.Persons | array of object | |
|
個人タグ
|
data.AudienceDto.Persons.Tag | string |
ターゲットの個人タグ |
|
ID
|
data.AudienceDto.Persons.Id | integer |
タグ ID |
|
サイト
|
data.AudienceDto.Sites | array of object | |
|
サイト タグ
|
data.AudienceDto.Sites.Tag | string |
ターゲット サイト タグ |
|
ID
|
data.AudienceDto.Sites.Id | integer |
タグ ID |
|
部署
|
data.AudienceDto.Departments | array of object | |
|
部署タグ
|
data.AudienceDto.Departments.Tag | string |
ターゲット部署タグ |
|
ID
|
data.AudienceDto.Departments.Id | integer |
タグ ID |
|
作成者 ID
|
data.CreatedByPerson.PersonId | integer |
記事を作成した人の識別子 |
|
名で作成
|
data.CreatedByPerson.FirstName | string |
記事を作成した人の名 |
|
家族名で作成
|
data.CreatedByPerson.FamilyName | string |
記事を作成した人の家族名 |
|
メールで作成
|
data.CreatedByPerson.Email | string |
記事を作成した人のメール アドレス |
|
変更日
|
data.ModifiedAt | date-time |
記事が最後に修正されたとき |
|
変更者 ID
|
data.ModifiedByPerson.PersonId | integer |
記事を最後に修正した人を表す一意の識別子 |
|
名で修正
|
data.ModifiedByPerson.FirstName | string |
記事を最後に修正した人の名 |
|
家族名で修正
|
data.ModifiedByPerson.FamilyName | string |
記事を最後に修正した人の家族名 |
|
メールで修正
|
data.ModifiedByPerson.Email | string |
記事を最後に修正した人のメール アドレス |
|
公開日
|
data.PublishedDate | date-time |
記事が公開されたとき |
|
記事のコンテンツ
|
data.ArticleContent | string |
記事の HTML コンテンツ |
|
記事のコンテンツ テキスト
|
data.ArticleContentText | string |
プレーン テキストの記事のコンテンツ |
|
メイン イメージ ID
|
data.MainImageId | integer |
フィードの記事のメイン イメージとして使用されるイメージへの ID。 |
目標が更新されたとき
目標が更新されたときにトリガーされる
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
webhook に付けられた名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
記録 URL
|
subjectFrontEndUrl | string |
StaffCircle のレコードへの URL |
|
ID
|
data.id | integer |
目的の進行状況の記録の識別子 |
|
目的 ID
|
data.objectiveId | integer |
この進行状況が関連付けられている目的 |
|
値
|
data.value | double |
目的の総進行状況の値 |
|
内容
|
data.description | string |
目的の進行状況の記録に追加された説明 |
|
作成日
|
data.createdAt | date-time |
進行状況の記録が作成された日時 |
|
個人 ID で作成
|
data.createdByPerson.PersonId | integer |
進行状況の目的記録を作成した人の識別子 |
|
名で作成
|
data.createdByPerson.FirstName | string |
進行状況の目的記録を作成した人の名 |
|
家族名で作成
|
data.createdByPerson.FamilyName | string |
進行状況の目的記録を作成した人の家族名 |
|
メールで作成
|
data.createdByPerson.Email | string |
進行状況の目的記録を作成した人のメール アドレス |
|
通知を送信する
|
data.sendNotifications | boolean |
通知が送信されたかどうかを示す |