StaffCircle (プレビュー)
StaffCircle は、分散した作業環境でも高パフォーマンスのチームを作成するために、企業文化とパフォーマンス管理を組み合わせた従業員の成功プラットフォームです。 StafffCircle には、コンピテンシー フレームワークにリンクされた目標、レビュー、値、フィードバックが含まれます。 深い洞察を得てエンゲージメントとパフォーマンスを促進します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | StaffCircle サポート |
| URL | https://www.staffcircle.com/contact-us/ |
| support@staffcircle.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | StaffCircle |
| Web サイト | https://www.staffcircle.com/ |
| プライバシー ポリシー | https://www.staffcircle.com/privacy-policy/ |
| カテゴリ | 通信;人的資源 |
StaffCircle は、組織がパフォーマンス管理、Comms、Culture を改善することで、リモートワークフォースを管理するのに役立ちます。 StaffCircle に接続して、One2one のレビュー、パフォーマンス目標、okrs、リアルタイム フィードバック、賞、および認識を管理できます。 パフォーマンス目標の作成や更新、賞の割り当て、記事やアラートの作成、ユーザー情報の更新など、さまざまなアクションを実行できます。
[前提条件]
このコネクタを使用するには、StaffCircle アカウントにアクセスできる必要があります。 StaffCircle はサブスクリプション プランの有料です。 StaffCircle アカウントにアクセスできない場合は、 詳細を参照してください。
資格情報を取得する方法
StaffCircle アカウントにアクセスできる場合は、このコネクタの使用を開始するために必要な資格情報が既にあります。 StaffCircle コネクタの接続を作成するときに、ユーザー名とパスワードの入力を求められます。 StaffCircle アカウントの資格情報は、ここで使用できます。 コネクタは、指定された資格情報のコンテキストで実行されることに注意してください。これには、セキュリティアクセス許可の考慮が含まれます。 つまり、コネクタでトリガーするアクションを実行するために、使用する StaffCircle アカウントに適切なアクセス許可があることを確認する必要があります。
コネクタの概要
StaffCircle コネクタの概要は簡単で、StaffCircle アカウントが必要です。 ユーザー資格情報を使用して、StaffCircle コネクタへの接続を作成できます。 完了したら、コネクタで定義されているトリガーのいずれかを使用して、StaffCircle インスタンス内で発生するイベントから自動化されたワークフローのトリガーを開始できます。
ワークフローの例を次に示します。
- StaffCircle で記事が発行されたときにワークフローをトリガーし、Slack などのチャット アプリケーションに記事に関する通知を送信します。
- 新しいスタッフ メンバーが StaffCircle に追加されたときにワークフローをトリガーし、新しいスタッフ メンバーへのメールなどの通信を含むオンボーディング プロセスを推進します。
StaffCircle には多くの Webhook があり、これらはすべてトリガーとしてコネクタで公開されているわけではありません。 ニーズに合ったトリガーが見つからない場合は、Webhook の表示を検討してください。 Webhook は、StaffCircle Web アプリケーション内の設定の統合セクションにあります。 フロー トリガー "HTTP 要求が受信されたとき" を使用して、ワークフローをトリガーするために StaffCircle Webhook に渡すことができる URL を生成できます。
このようなワークフローの例を次に示します。
- スタッフ メンバーに対して休日の要求が行われた場合は、Outlook カレンダー イベントを作成します。
StaffCircle は、企業内のコミュニケーションと目標管理を改善するための一連のアクションを利用できるようにしました。 "新しいアラートの作成" などのアクションを使用すると、StaffCircle がサポートする複数のチャネル (メール、sms、MS Teams、アプリ内、プッシュ通知など) へのメッセージの送信をトリガーできます。 これにより、他のアプリケーションで発生する重要なイベントをチームに通知できます。
目標アクションを使用して、KPI の追跡を自動化できます。 機会の獲得など、他のアプリケーションでイベントが発生した場合は、StaffCircle で設定されている目標を取引の価値で更新できます。
StaffCircle では、スタッフ メンバーを "新しいタスクの作成" などの他のアクションに簡単にリンクできるように、"メールでユーザーを取得する" などの便利なアクションを提供しています
Support
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
|
title | string |
新しい目標の名前をオーバーライドします。 |
|
|
Description
|
description | string |
新しい目標の説明をオーバーライドします。 |
|
|
マネージャー ID
|
managerId | integer |
目標の追跡を担当するマネージャー。 ユーザーまたは部門マネージャーが自動的に既定値になります。 個人または部署にマネージャーがいない場合、または目的が会社の目的である場合に必要です。 マネージャーの電子メールが指定されていない場合に使用されます |
|
|
会社の目標 ID
|
companyObjectiveId | integer |
新しく作成された目的が関連する会社の目標へのオプションのリンク |
|
|
部署の目標 ID
|
departmentObjectiveId | integer |
新しく作成された目標が関連する部門目標への省略可能なリンク |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
目標 ID
|
id | integer |
作成された目標の識別子 |
メールでユーザーを取得する
電子メールで個人レコードを見つけようとします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
電子メールの検索
|
SearchEmail | True | string |
電子メールで検索 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
ID
|
results.id | integer |
ユーザーの ID |
|
名前
|
results.firstName | string |
ユーザーの名 |
|
Surname
|
results.secondName | string |
その人の姓 |
|
別名
|
results.knownAs | string |
ユーザーが名前を付けるのが好きな名前 |
|
Email
|
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 |
マネージャーの名 |
|
マネージャーの 2 番目の名前
|
results.manager.secondName | string |
マネージャーの 2 番目の名前 |
|
Active
|
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
|
title | True | string |
アラートのタイトル |
|
Priority
|
priority | True | string |
アラートの優先度 |
|
概要
|
summary | string |
アラートの主な内容 |
|
|
全員に送信
|
everyone | boolean |
このアラートを社内のすべてのユーザーに送信する必要がある場合 |
|
|
部門タグに送信する
|
departmentTags | string |
アラートを受信する部門タグのコンマ区切りの一覧。 [すべてのユーザーに送信] が true に設定されている場合は使用しない |
|
|
People タグに送信する
|
peopleTags | string |
アラートを受信するユーザー タグのコンマ区切りのリスト。 [すべてのユーザーに送信] が true に設定されている場合は使用しない |
|
|
グループ タグに送信する
|
groupTags | string |
アラートを受信するグループ タグのコンマ区切りの一覧。 [すべてのユーザーに送信] が true に設定されている場合は使用しない |
|
|
サイト タグに送信する
|
siteTags | string |
アラートを受信するサイト タグのコンマ区切りの一覧。 [すべてのユーザーに送信] が true に設定されている場合は使用しない |
|
|
プッシュ通知の送信
|
push | boolean |
プッシュ通知を使用してユーザーに通知するかどうかを指定します。 |
|
|
SMS 通知の送信
|
sms | boolean |
SMS 通知を使用してユーザーに通知するかどうかを指定します。 |
|
|
電子メール通知の送信
|
boolean |
アラート通知を電子メールで送信するかどうか |
||
|
アプリ内通知の送信
|
inApp | boolean |
アプリ通知でユーザーに通知するかどうかを指定します。 |
|
|
Microsoft Teams通知を送信する
|
teams | boolean |
Microsoft Teams通知を使用してユーザーに通知するかどうかを指定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
アラートの識別子 |
新しいタスクを作成する
新しいタスクを作成し、ユーザーに割り当てます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Title
|
title | True | string |
タスクのタイトル |
|
優先度 ID
|
priorityId | integer |
タスクの優先度。 タスク グループから派生していない場合は必須 |
|
|
Description
|
description | string |
タスクに指定された説明 |
|
|
ワークシート
|
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。 タスクが繰り返し発生する場合は必須 |
|
|
プッシュ通知の送信
|
push | boolean |
タスクに関するプッシュ通知を送信する |
|
|
SMS 通知の送信
|
sms | boolean |
タスクに関する SMS 通知を送信する |
|
|
電子メール通知を送信する
|
boolean |
タスクに関する電子メール通知を送信する |
||
|
Microsoft Teams通知を送信する
|
teams | boolean |
タスクに関するMicrosoft Teams通知を送信する |
|
|
アプリ内の通知を送信する
|
inApp | boolean |
タスクに関するアプリ通知を送信する |
|
|
いいね!を許可する
|
allowLikes | boolean |
ユーザーがタスクに対するコメントを好きにすることを許可する |
|
|
コメントを許可する
|
allowComments | boolean |
タスクに対するコメントを許可する |
|
|
コメント内の画像を許可する
|
allowImagesInComments | boolean |
コメントに添付するすべての画像 |
|
|
ドキュメントを許可する
|
allowDocuments | boolean |
コメントへのドキュメントの添付を許可する |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
タスクの識別子 |
新しいユーザーを作成する
ユーザーを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
firstName | True | string |
ユーザーの名 |
|
Second Name
|
secondName | True | string |
ユーザーの 2 番目の名前 |
|
Email
|
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 |
人物のミドル ネーム |
|
|
個人用Email
|
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 またはマネージャーの電子メールのみを入力できます) |
|
|
部門 ID
|
departmentId | integer |
個人の部署 ID (部署 ID または部門名のみを入力できます) |
|
|
ロール ID
|
roleId | integer |
個人の雇用ロール識別子 (ロール ID またはロール名のみを入力できます) |
|
|
サイト ID
|
mainSiteId | integer |
ユーザーが属しているサイト識別子 |
|
|
緊急連絡先の同意
|
emergencyContactConsent | boolean |
緊急連絡先が詳細を保存する同意を与えているかどうか |
|
|
緊急連絡先の名前
|
emergencyContactName | string |
緊急連絡先の名前 |
|
|
緊急連絡先の関係 ID
|
emergencyRelationshipId | integer |
緊急連絡先と人との関係 |
|
|
緊急連絡先電話
|
emergencyContactTelephone | string |
緊急連絡先の電話番号 |
|
|
緊急対応の住所
|
emergencyAddress | string |
緊急時の住所 |
|
|
近親者の次の名前
|
nextOfKinName | string |
人の次の近親者の名前 |
|
|
Next Of Kin Relationship ID
|
nextOfKinRelationshipId | integer |
次の近親者と人との関係 |
|
|
近親電話の次へ
|
nextOfKinTelephone | string |
人の次の近親者の電話番号 |
|
|
ダイヤル コード
|
dialingCode | string |
ユーザーの電話番号の国際ダイヤル コード |
|
|
作業拡張機能
|
workExtension | string |
ユーザーの勤務延長番号 |
|
|
勤務先の電話
|
telephone | string |
個人の勤務先電話番号 |
|
|
Personal Mobile
|
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
|
title | True | string |
新しい目標の名前。 |
|
Description
|
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 |
Teams 統合が有効になっている場合に Microsoft Teams 経由で更新プログラムを送信する |
|
|
アプリ内通知の送信
|
inApp | boolean |
InApp 通知を送信する |
|
|
いいね!
|
allowLikes | boolean |
ユーザーが目的に対するコメントを好きにすることを許可する |
|
|
コメントを許可する
|
allowComments | boolean |
目的に対するコメントを許可する |
|
|
コメント内の画像を許可する
|
allowImagesInComments | boolean |
コメントに添付するすべての画像。 |
|
|
ドキュメントを許可する
|
allowDocuments | boolean |
コメントへのドキュメントの添付を許可する |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
目標 ID
|
id | integer |
目的識別子 |
新しい記事を作成する
複数の通信チャネルを介して StaffCircle ユーザーに配布できる新しい記事を作成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Title
|
title | True | string |
記事のタイトル。 最大長 250 文字 |
|
Priority
|
priority | True | string |
この記事の優先順位は何ですか? |
|
アーティクルの種類
|
articleType | True | string |
作成するアーティクルの種類 |
|
HTML コンテンツ
|
htmlContent | True | string |
記事のメイン HTML コンテンツ。 |
|
記事イメージの URL
|
mainImageUrl | string |
フィード内の記事のメイン 画像として使用される画像の URL。 |
|
|
概要
|
summary | string |
記事の概要。 指定しない場合、既定では最初の 500 文字の Html コンテンツが使用されます。 |
|
|
タグ
|
tag | True | string |
アーティクルに関連付けられているタグ。 最大文字数 250 |
|
チャネル ID
|
channelId | integer |
記事が公開されるチャネル。 空白のままにすると、既定のフィードに設定されます |
|
|
プッシュ通知の送信
|
push | boolean |
プッシュ通知によって記事についてユーザーに通知するかどうか |
|
|
SMS 通知の送信
|
sms | boolean |
SMS 通知によって記事についてユーザーに通知するかどうか |
|
|
電子メール通知を送信する
|
boolean |
電子メール通知で記事についてユーザーに通知するかどうか |
||
|
アプリ内の通知を送信する
|
inApp | boolean |
アプリ通知で記事についてユーザーに通知するかどうか |
|
|
Teams 通知を送信する
|
teams | boolean |
Microsoft Teams通知によって記事についてユーザーに通知するかどうか |
|
|
いいね!を許可する
|
allowLikes | boolean |
ユーザーは記事を気に入ることができます。 既定値は true |
|
|
コメントを許可する
|
allowComments | boolean |
ユーザーは記事にコメントできます。 既定値は true です。 |
|
|
コメント内の画像を許可する
|
allowImagesInComments | boolean |
コメントで画像を許可するかどうか |
|
|
日付からピン留めする
|
pinFromDate | date-time |
アーティクルをピン留めする必要があります。 その場合は、日付を指定します。 ピン留め時間が指定されている場合は必須 |
|
|
Pin Duration Hours
|
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
|
description | True | string |
進行状況の簡単な説明 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
目標進行状況レコードの識別子 |
目的を検索する
目的を検索する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
タイトルの検索
|
SearchTitle | string |
タイトルに基づいて検索する文字列の一致が緩い |
|
|
ユーザーの電子メール
|
PersonEmail | string |
目的が割り当てられているユーザーの電子メール |
|
|
タグ
|
Tag | string |
目標に割り当てられたタグ |
|
|
クローズド
|
Closed | string |
目的が閉じている場合。 閉じた場合は True、それ以外の場合は false |
|
|
目標の種類
|
ObjectiveType | string |
目的の種類 |
|
|
より
|
From | date-time |
目標は、この時点からアクティブです |
|
|
移行先
|
To | date-time |
目標は、この時点からアクティブです |
|
|
Active At
|
ActiveAt | date-time |
目標は、この時点でアクティブです |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
目標 ID
|
results.id | integer |
目的識別子 |
|
Title
|
results.title | string |
目的に与えられたタイトル |
|
Description
|
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 |
タスクの識別子 |
|
Title
|
data.title | string |
タスクのタイトル |
|
Description
|
data.description | string |
タスクの説明 |
|
Priority
|
data.priority | string |
タスクの優先度 |
|
タスク グループ ID
|
data.groupId | integer |
タスク グループの識別子 |
|
タスク グループのタイトル
|
data.groupTitle | string |
タスク グループのタイトル |
|
Is Adhoc
|
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 通知
|
data.notificationSettings.sms | boolean |
タスクの Sms 通知が送信されるかどうか |
|
電子メール通知
|
data.notificationSettings.email | boolean |
タスクの電子メール通知が送信されるかどうか |
|
Microsoft Teams通知
|
data.notificationSettings.microsoftTeams | boolean |
タスクMicrosoft Teams通知が送信されるかどうか |
|
アプリ通知内
|
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 |
ユーザーを表す識別子 |
|
名前
|
data.givenName | string |
ユーザーの名 |
|
ミドルネーム
|
data.middleName | string |
人物のミドル ネーム |
|
名字
|
data.familyName | string |
ユーザーの家族名 |
|
別名
|
data.knownAs | string |
ユーザーが名前を付けるのが好きな名前 |
|
生年月日
|
data.dateOfBirth | date |
生年月日 |
|
個人用Email
|
data.contactDetails.personalEmail | string |
ユーザーの個人用メール アドレス |
|
職場の電子メール
|
data.contactDetails.workEmail | string |
ユーザーの職場のメール アドレス |
|
Work Mobile
|
data.contactDetails.workMobile | string |
ユーザーの職場の携帯電話番号 |
|
Personal Mobile
|
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 |
人に関連する重要な医療上の注意事項 |
|
Kin Name の次へ
|
data.nextOfKin.Name | string |
人の次の近親者の |
|
金武電話の次へ
|
data.nextOfKin.Telephone | string |
人の次の近親者の電話番号 |
|
[Next of Kin Relationship ID]\(近親関係 ID の次へ\
|
data.nextOfKin.RelationshipId | string |
次の近親者と人との関係 |
|
雇用に関するメモ
|
data.employeeDetails.employmentNotes | string |
人に関する雇用上の注意 |
|
タグ
|
data.employeeDetails.tag | string |
StaffCircle プラットフォーム全体でユーザーを参照するために使用できるタグ |
|
開始日
|
data.employeeDetails.startDate | string |
その人の雇用が始まったとき |
|
サイト ID
|
data.employeeDetails.siteId | integer |
ユーザーが属しているサイト識別子 |
|
グループ識別子
|
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.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 |
レビュー担当者の電子メール アドレス |
|
Title
|
data.title | string |
レビューに与えられたタイトル |
|
Description
|
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 通知
|
data.notificationSettings.sms | boolean |
SMS 通知を送信するかどうか |
|
電子メール通知
|
data.notificationSettings.email | boolean |
電子メール通知を送信するかどうか |
|
Microsoft Teams通知
|
data.notificationSettings.microsoftTeams | boolean |
Microsoft Teams通知を送信するかどうか |
|
アプリ通知内
|
data.notificationSettings.inApp | boolean |
アプリ通知で送信するかどうか |
新しい休暇が追加されたとき
新しい休暇が追加されたときにトリガーされます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
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 |
目的にリンクされているユーザーのメール アドレス |
|
Title
|
data.title | string |
新しい目標の名前 |
|
Description
|
data.description | string |
新しい目標の説明 |
|
値の形式
|
data.valueType | string |
目標の測定方法を定義します |
|
タグ
|
data.tag | string |
検索およびレポートで使用するテキスト タグ |
|
カテゴリ
|
data.category | string |
目標カテゴリ識別子 |
|
開始日
|
data.startDate | date-time |
目標を測定するタイミングから |
|
終了日
|
data.endDate | string |
目標の期限 |
|
最終進捗日
|
data.lastProgressDate | date-time |
目標の進捗状況が発生した日付 |
|
クローズド
|
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 |
Teams 統合が有効になっている場合に Microsoft Teams 経由で更新プログラムを送信する |
|
In App Notification
|
data.notificationSettings.inApp | boolean |
InApp 通知を送信する |
|
いいね!
|
data.contentSettings.allowLikes | boolean |
ユーザーが目的に対するコメントを好きにすることを許可する |
|
コメントを許可する
|
data.contentSettings.allowComments | boolean |
目的に対するコメントを許可する |
|
コメント内の画像を許可する
|
data.contentSettings.allowImagesInComments | boolean |
コメントに添付するすべての画像。 |
|
ドキュメントを許可する
|
data.contentSettings.allowDocuments | boolean |
コメントへのドキュメントの添付を許可する |
|
Created At
|
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 |
アーティクルの識別子 |
|
Title
|
data.Title | string |
記事に与えられたタイトル |
|
概要
|
data.Summary | string |
記事の概要 |
|
タグ
|
data.Tag | string |
記事に関連付けられているタグ |
|
優先度名
|
data.PriorityName | string |
記事の優先順位 |
|
作成日
|
data.CreatedAt | date-time |
アーティクルが最初に作成された日付 |
|
Everyone
|
data.AudienceDto.Everyone | boolean |
記事が全員に公開されているかどうか |
|
人達
|
data.AudienceDto.Persons | array of object | |
|
人物タグ
|
data.AudienceDto.Persons.Tag | string |
ターゲット ユーザー タグ |
|
ID (アイディー)
|
data.AudienceDto.Persons.Id | integer |
タグ ID |
|
Sites
|
data.AudienceDto.Sites | array of object | |
|
サイト タグ
|
data.AudienceDto.Sites.Tag | string |
ターゲット サイト タグ |
|
ID (アイディー)
|
data.AudienceDto.Sites.Id | integer |
タグ ID |
|
Departments
|
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 |
オブジェクトの進行状況の合計値 |
|
Description
|
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 |
通知が送信された場所かどうかを示します |