intelliHR (プレビュー)
intelliHR は、高度な分析機能を備えたクラウドベースの人事管理プラットフォームです。 intelliHR テナントに接続して、人を対象としたワークフロー (オンボードなど) とデータのエクスポートを自動化します。
このコネクタは、次の製品および地域で利用可能です。
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) |
お問い合わせ先 | |
---|---|
件名 | カスタマー サポート |
[URL] | https://intellihr.zendesk.com/hc/en-us |
メール | support@intellihr.co |
Connector Metadata | |
---|---|
発行者 | intelliHR |
Web サイト | https://www.intellihr.com |
プライバシー ポリシー | https://intellihr.co/privacy-policy/ |
カテゴリ | 人材;ビジネスインテリジェンス |
intelliHR は、一元化されたパフォーマンス管理、従業員エンゲージメント、コア人材育成プロセス、および HR 分析をすべて 1 か所で行うための使いやすい人事管理および分析プラットフォームです。 intelliHR コネクタを使用してノーコードで Power Automate、Office 365、SharePoint、Microsoft Dynamics 365、およびその他のサービスの従業員データを使用して、スケジュールされたタスクと自動化されたワークフローを作成します。
前提条件
このコネクタを使用するには、intelliHR テナントが必要です。 グループまたは組織にテナントをプロビジョニングするには、このページにアクセスしてください。
資格情報の入手方法
コネクタを設定するには、API キーとテナント名が必要です。
テナント名はアカウントのサブドメインに対応します (例: https://this-is-your-tenant-name.intellihr.net)。
API キーを作成するには:
- 管理者アカウントでテナントにログインする
- 設定ページへ移動する
- 「API」を検索し、「パブリック API アクセスキー」をクリックする
- このページのプロンプトに従って、キーを作成する。
正しいインターフェイスは次の場所にもあります。https://your-tenant.intellihr.net/spa/settings/access-keys
コネクタの使用を開始する
intelliHR コネクタを追加すると、テナント名と API キー、および接続用の表示名を入力するように求められます。
重要: API キーを入力するときは、入力が「Bearer xyz123」になるように、キーの前に「Bearer」を付けてください。 そうしないと、「無効な API キー」エラーが発生します。
既知の問題と制限事項
intelliHR コネクタは intelliHR のパブリック API の翻訳であるため、同じ制限を継承し、リクエストに対して同じ検証が必要です。
一般的なエラーと解決策
intelliHR コネクタが intelliHR のパブリック API にリクエストを渡すとき、ほとんどの問題は、パブリック API ドキュメントを参照することでトラブルシューティングできます。
リクエストの一部が不適切な場合は 400 範囲のエラーが返され、問題を説明するメッセージが表示されます。 最も一般的な問題は、API キー入力に「Bearer」がない状態でコネクタが構成されていることです。
接続の作成
コネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | 内容 | 必要 |
---|---|---|---|
API キー | securestring | この API の API キーで、先頭に「Bearer」が付いています | 真 |
テナント | 文字列 | 自分の intelliHR テナント名 | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
ID で Webhook を削除する |
指定された Webhook を削除します。 |
ID で Webhook を検索する |
単一の Webhook を返します。 |
ID で Webhook イベントを検索する |
単一の Webhook イベントを返します。 |
ID でカスタム フィールド定義を検索する |
単一のカスタム フィールド定義を返します。 |
ID でデフォルトの報酬コンポーネントを検索する |
単一のデフォルトの報酬コンポーネントを返します。 |
ID でトレーニング タイプを検索する |
単一のトレーニング タイプを返します。 |
ID でトレーニング プロバイダーを検索する |
単一のトレーニング プロバイダーを返します。 |
ID でトレーニング レコードを検索する |
単一のトレーニング レコードを返します。 |
ID でトレーニングレコードを削除する |
指定されたトレーニングレコードを削除します。 |
ID でトレーニングレコードを更新する |
トレーニング レコードを更新する |
ID でドキュメントを更新する |
ドキュメントを更新する |
ID でビジネス エンティティを検索する |
識別子によって単一のビジネス エンティティを返します。 |
ID でユーザーを更新する |
ユーザーを更新する |
ID で人を検索する |
UUIDv4 識別子で単一の個人レコードを取得します。 |
ID で仕事を検索する |
UUIDv4 識別子で単一のジョブ レコードを取得します。 |
ID で作業クラスを検索する |
単一の作業クラスを返します。 |
ID で作業タイプを検索する |
単一の作業タイプを返します。 |
ID で作業権利を検索する |
単一の作業権利を返します。 |
ID で場所を検索する |
単一の場所を返します。 |
ID で採用ソースを検索する |
単一の採用ソースを返します。 |
ID で支払いグレードを検索する |
単一の支払いグレードを返します。 |
ID で部署を更新する |
更新された部署を返します。 |
ID で部署を検索する |
単一の部署を返します。 |
ID で雇用条件を検索する |
単一の雇用条件を返します。 |
ID を指定して部署を削除する |
ID を指定して部署を削除する。 |
Update |
webhook を修正する |
すべてのカスタムフィールド定義を一覧表示する |
すべてのカスタムフィールド定義を一覧表示します。 |
すべてのジョブを一覧表示する |
現在の日付でのすべてのジョブ エンティティ レコードのリストを返します。 |
すべてのトレーニング タイプを一覧表示する |
すべてのトレーニング タイプの一覧を返します。 |
すべてのトレーニング プロバイダーを一覧表示する |
すべてのリストの一覧を返します。 |
すべてのトレーニングを一覧表示する |
すべてのトレーニング レコードの一覧を返します。 |
すべてのビジネス エンティティを一覧表示する |
すべてのビジネス エンティティの一覧を返します。 |
すべてのユーザーを一覧表示する |
現在の日付でのすべてのユーザーの一覧を返します。 |
すべての作業クラスを一覧表示する |
システムに記録されているすべての作業クラスの一覧を返します。 |
すべての作業タイプを一覧表示する |
システムに記録されているすべての作業タイプの一覧を返します。 |
すべての作業権利を一覧表示する |
システムに記録されているすべての作業権利の一覧を返します。 |
すべての場所を一覧表示する |
すべての場所の一覧を返します。 |
すべての採用ソースを一覧表示する |
すべての採用ソースの一覧を返します。 |
すべての支払いグレードを一覧表示する |
すべての支払いグレードの一覧を返します。 |
すべての部署を一覧表示する |
システムに記録されているすべての部署のリストを返します。 |
すべての雇用条件を一覧表示する |
すべての雇用条件の一覧を返します。 |
ジョブの終了日を設定する |
ジョブの終了日を設定する |
デフォルトの報酬コンポーネントをすべて一覧表示する |
システムに記録されているすべてのデフォルト報酬コンポーネントのリストを返します。 |
トレーニング レコードを作成する |
新しいトレーニング レコードを作成する |
事前に署名されたアップロード URL を作成する |
事前に署名されたアップロード URL を作成する |
新しいジョブの作成 |
提供されたデータを使用して新しいジョブレコードを作成します。 |
新しい個人レコードを作成する |
人を作成する |
新しい部署の作成 |
作成された部署を返します。 |
既存のジョブにパッチを適用する |
提供されたデータを使用して、既存のジョブレコードの属性にパッチを適用します。 |
ID で Webhook を削除する
ID で Webhook を検索する
単一の Webhook を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Webhook の ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleWebhook
- SingleWebhook
ID で Webhook イベントを検索する
単一の Webhook イベントを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Webhook イベントの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
単一の Webhook イベント。
- webhook-events
- webhook-events
ID でカスタム フィールド定義を検索する
単一のカスタム フィールド定義を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
カスタム フィールドの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleCustomFieldDefinition
- SingleCustomFieldDefinition
ID でデフォルトの報酬コンポーネントを検索する
単一のデフォルトの報酬コンポーネントを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
報酬コンポーネント ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleDefaultRemunerationComponent
- SingleDefaultRemunerationComponent
ID でトレーニング タイプを検索する
単一のトレーニング タイプを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
トレーニング タイプ ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleTrainingTypes
- SingleTrainingTypes
ID でトレーニング プロバイダーを検索する
単一のトレーニング プロバイダーを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
トレーニング プロバイダーの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleTrainingProvider
- SingleTrainingProvider
ID でトレーニング レコードを検索する
単一のトレーニング レコードを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
トレーニング レコードの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleTraining
- SingleTraining
ID でトレーニングレコードを削除する
ID でトレーニングレコードを更新する
トレーニング レコードを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
トレーニング レコードの ID
|
id | True | string |
リソース識別子文字列 |
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
completionDate
|
completionDate | string |
トレーニングが完了したタイムスタンプ。 この日付は、RFC3339 によって定義された形式に従います。 YYYY-MM-DD の日付形式もサポートされていますが、この形式を使用すると、日付は、要求しているテナントのタイムゾーンではなく、UTC 時間の開始日として保存されます。 |
|
コスト
|
cost | string |
このトレーニングのコストです。 |
|
通貨
|
currency | string |
このトレーニングで使用される通貨です。 提供されていない場合、デフォルトでテナントのデフォルト通貨になります。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
時間
|
hours | string |
このトレーニングに費やした時間 |
|
ID
|
id | string | ||
名前
|
name | string |
システムで識別するためにこのトレーニングに付けられたユーザーフレンドリ名。 |
|
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
ID
|
id | string |
トレーニングのトレーニング プロバイダーの識別子文字列。 |
|
名前
|
name | string |
トレーニングのトレーニング プロバイダーに付けられたユーザーフレンドリ名。 |
|
ID
|
id | string |
トレーニングのトレーニング タイプの識別子文字列。 |
|
名前
|
name | string |
トレーニングのトレーニング タイプに付けられたユーザーフレンドリ名。 |
|
customFields
|
customFields |
この トレーニング のカスタム フィールド値 |
戻り値
- SingleTraining
- SingleTraining
ID でドキュメントを更新する
ドキュメントを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ドキュメントの ID
|
id | True | string |
リソース識別子文字列 |
personId
|
personId | True | string | |
uploadStatus
|
uploadStatus | True | string |
このドキュメントのアップロードの状態。 列挙型: |
戻り値
- PatchaPersonDocument
- PatchaPersonDocument
ID でビジネス エンティティを検索する
識別子によって単一のビジネス エンティティを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リソース識別子文字列
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleBusinessEntity
- SingleBusinessEntity
ID でユーザーを更新する
ユーザーを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
個人レコードの ID
|
id | True | string |
リソース識別子文字列 |
firstName
|
firstName | string |
その人の名。 |
|
middleName
|
middleName | string |
その人のミドル ネーム。 |
|
lastName
|
lastName | string |
その人の姓。 |
|
preferredName
|
preferredName | string |
その人の希望する名前。 通常、従業員が自分で構成できます。 |
|
dateOfBirth
|
dateOfBirth | string |
生年月日 (YYYY-MM-DD)。 |
|
性別
|
gender | string |
人の性別の人間が読める文字列、例えば |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
タイトル
|
title | string |
この人のタイトル、たとえば、「Mr」。 指定しない場合は無効であり、大文字と小文字は区別されません。 |
|
名前
|
name | string |
緊急連絡先の名前。 |
|
relationship
|
relationship | string |
この緊急連絡先とその人との関係。 |
|
電話
|
phone | string |
緊急連絡先の電話番号。 |
|
電子メール
|
string |
緊急連絡先のメール。 |
||
電子メール
|
string |
このユーザーに関連付けられているメール アドレスです。 |
||
isPersonal
|
isPersonal | boolean |
このメールが個人用か仕事用かを示します。 |
|
isPrimary
|
isPrimary | boolean |
このメールが取引先責任者のメールであるかどうかを示します。 |
|
数値
|
number | string |
電話番号。 この番号の前に市外局番を付けることができます。 これがある場合、システムは自動的に電話番号の発信国を判別しようとします |
|
isPersonal
|
isPersonal | boolean |
この電話番号が個人用か職場用かを示します。 |
|
isPrimary
|
isPrimary | boolean |
この電話番号が取引先責任者かを示します。 |
|
addressType
|
addressType | string |
列挙型: |
|
fullAddress
|
fullAddress | string |
郵便番号と国を除いた、完全に読み取り可能な住所 |
|
国
|
country | string |
この住所がある国。 |
|
postcode
|
postcode | string |
住所の郵便番号。 |
|
状態
|
state | string |
この住所がある州。 これはオーストラリア固有であり、常に提供されるとは限りません。 |
|
番地
|
street | string |
住所がある通り。 これはオーストラリア固有であり、常に提供されるとは限りません。 |
|
区町村
|
suburb | string |
この住所がある区長村。 これはオーストラリア固有であり、常に提供されるとは限りません。 |
|
customFields
|
customFields | object |
このユーザーのためのカスタムフィールド値 |
|
id
|
id | string | ||
名前
|
name | string |
作業ライツの名前。 |
|
workRightExpiryDate
|
workRightExpiryDate | string |
戻り値
- SinglePerson
- SinglePerson
ID で人を検索する
UUIDv4 識別子で単一の個人レコードを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
個人レコードの ID
|
id | True | string |
個人レコードの ID |
戻り値
- SinglePerson
- SinglePerson
ID で仕事を検索する
UUIDv4 識別子で単一のジョブ レコードを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
返すジョブの ID
|
id | True | string |
リソース識別子文字列 |
この日付のジョブの正確なデータを返す
|
asAt | string |
RFC3339 datetime として、このジョブデータを返す日付を構成するために使用されます。 ジョブ エンドポイントから返されるすべてのデータは、特定の時点での個人のジョブ属性の値を表します。 デフォルトでは、現在の日時が使用されますが、このパラメーターを使用して、履歴データを表示するために別の日時を構成できます。 |
戻り値
- SingleJob
- SingleJob
ID で作業クラスを検索する
単一の作業クラスを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
作業クラスの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleWorkClass
- SingleWorkClass
ID で作業タイプを検索する
単一の作業タイプを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
作業タイプの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleWorkType
- SingleWorkType
ID で作業権利を検索する
単一の作業権利を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
作業権利の ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleWorkRight
- SingleWorkRight
ID で場所を検索する
ID で採用ソースを検索する
単一の採用ソースを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
採用ソースの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleRecruitmentSource
- SingleRecruitmentSource
ID で支払いグレードを検索する
単一の支払いグレードを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
支払いグレードの ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SinglePayGrade
- SinglePayGrade
ID で部署を更新する
更新された部署を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
部署の ID
|
id | True | string |
リソース識別子文字列 |
識別子
|
identifier | string |
管理タスクに使用できるオプションの識別子。 |
|
名前
|
name | True | string |
この部署に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
注意
|
notes | string |
部署に添付されたメモ |
|
parentId
|
parentId | string |
親部署の識別子文字列、または親 (これはトップレベルの部署です) がない場合は null。 |
|
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの部署を選択できるかどうかを指定します。 |
戻り値
- 回答
- Response
ID で部署を検索する
ID で雇用条件を検索する
単一の雇用条件を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
雇用条件 ID
|
id | True | string |
リソース識別子文字列 |
戻り値
- SingleEmploymentCondition
- SingleEmploymentCondition
ID を指定して部署を削除する
UpdateAWebhook
webhook を修正する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
webhook の ID
|
id | True | string |
リソース識別子文字列 |
url
|
url | string |
サブスクライブされた Webhook イベントがトリガーされた時にリクエストが送信される Webhook エンドポイント。 |
|
webhookEvent
|
webhookEvent | string |
Webhook イベントの置換フィールド。 |
|
isEnabled
|
isEnabled | boolean |
ユーザーがこの Webhook を選択できるかどうかを指定します。 無効にすると、この Webhook は送信されません。 |
|
ソース
|
source | string |
どのシステムがこの Webhook を作成したかを識別するために使用できるカスタマイズ可能な文字列。 intelliHR アプリケーションを介して作成された Webhook はソースが「カスタム」になります。 |
戻り値
- SingleWebhook
- SingleWebhook
すべてのカスタムフィールド定義を一覧表示する
すべてのカスタムフィールド定義を一覧表示します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
|
クエリに適用するフィルター
|
filters | string |
クエリ文字列にフィルターを適用して、このエンドポイントから返されるデータを制限できます。 フィルターは、 |
戻り値
- ListofCustomFieldDefinitions
- ListofCustomFieldDefinitions
すべてのジョブを一覧表示する
現在の日付でのすべてのジョブ エンティティ レコードのリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
|
クエリに適用するフィルター
|
filters | string |
クエリ文字列にフィルターを適用して、このエンドポイントから返されるデータを制限できます。 フィルターは、 |
|
クエリに適用する並べ替え順
|
sort | string |
クエリ文字列に並べ替えを適用して、このエンドポイントから返されるデータを並べ替えできます。 ソートの前にマイナスを付けて、データを降順 (-) で返すことができます。 たとえば、最新のレコードを最初に取得する並べ替えは |
戻り値
- ListJobs
- ListJobs
すべてのトレーニング タイプを一覧表示する
すべてのトレーニング タイプの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListallTrainingTypes
- ListallTrainingTypes
すべてのトレーニング プロバイダーを一覧表示する
すべてのリストの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListallTrainingProviders
- ListallTrainingProviders
すべてのトレーニングを一覧表示する
すべてのトレーニング レコードの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
|
クエリに適用するフィルター
|
filters | string |
クエリ文字列にフィルターを適用して、このエンドポイントから返されるデータを制限できます。 フィルターは、 |
|
クエリに適用する並べ替え順
|
sort | string |
クエリ文字列に並べ替えを適用して、このエンドポイントから返されるデータを並べ替えできます。 ソートの前にマイナスを付けて、データを降順 (-) で返すことができます。 たとえば、最新のレコードを最初に取得する並べ替えは |
戻り値
- ListofTrainings
- ListofTrainings
すべてのビジネス エンティティを一覧表示する
すべてのビジネス エンティティの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListofBusinessEntities
- ListofBusinessEntities
すべてのユーザーを一覧表示する
現在の日付でのすべてのユーザーの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
|
クエリに適用するフィルター
|
filters | string |
クエリ文字列にフィルターを適用して、このエンドポイントから返されるデータを制限できます。 フィルターは、 |
|
クエリに適用する並べ替え順
|
sort | string |
クエリ文字列に並べ替えを適用して、このエンドポイントから返されるデータを並べ替えできます。 ソートの前にマイナスを付けて、データを降順 (-) で返すことができます。 たとえば、最新のレコードを最初に取得する並べ替えは |
戻り値
- ListPeople
- ListPeople
すべての作業クラスを一覧表示する
システムに記録されているすべての作業クラスの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListWorkClasses
- ListWorkClasses
すべての作業タイプを一覧表示する
システムに記録されているすべての作業タイプの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListWorkTypes
- ListWorkTypes
すべての作業権利を一覧表示する
システムに記録されているすべての作業権利の一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListofWorkRights
- ListofWorkRights
すべての場所を一覧表示する
すべての場所の一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- Listlocations
- Listlocations
すべての採用ソースを一覧表示する
すべての採用ソースの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListofRecruitmentSources
- ListofRecruitmentSources
すべての支払いグレードを一覧表示する
すべての支払いグレードの一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListofPayGrades
- ListofPayGrades
すべての部署を一覧表示する
システムに記録されているすべての部署のリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListofBusinessUnits
- ListofBusinessUnits
すべての雇用条件を一覧表示する
すべての雇用条件の一覧を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListofEmploymentConditions
- ListofEmploymentConditions
ジョブの終了日を設定する
ジョブの終了日を設定する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
終了するジョブの ID
|
id | True | string |
終了するジョブの ID |
endDate
|
endDate | True | string |
endDate |
turnoverType
|
turnoverType | True | string |
turnoverType |
turnoverReason
|
turnoverReason | string |
turnoverReason |
戻り値
- SingleJob
- SingleJob
デフォルトの報酬コンポーネントをすべて一覧表示する
システムに記録されているすべてのデフォルト報酬コンポーネントのリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ページあたりのアイテム数
|
limit | integer |
ページあたりのアイテム数 |
|
ページ番号
|
page | integer |
ページ番号 |
戻り値
- ListofDefaultRemunerationComponents
- ListofDefaultRemunerationComponents
トレーニング レコードを作成する
新しいトレーニング レコードを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
completionDate
|
completionDate | True | string |
トレーニングが完了したタイムスタンプ。 この日付は、RFC3339 によって定義された形式に従います。 YYYY-MM-DD の日付形式もサポートされていますが、この形式を使用すると、日付は、要求しているテナントのタイムゾーンではなく、UTC 時間の開始日として保存されます。 |
コスト
|
cost | string |
このトレーニングのコストです。 |
|
通貨
|
currency | string |
このトレーニングで使用される通貨です。 提供されていない場合、デフォルトでテナントのデフォルト通貨になります。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
時間
|
hours | string |
このトレーニングに費やした時間 |
|
ID
|
id | string | ||
名前
|
name | True | string |
システムで識別するためにこのトレーニングに付けられたユーザーフレンドリ名。 |
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
ID
|
id | string |
トレーニングのトレーニング プロバイダーの識別子文字列。 |
|
名前
|
name | string |
トレーニングのトレーニング プロバイダーに付けられたユーザーフレンドリ名。 |
|
ID
|
id | string |
トレーニングのトレーニング タイプの識別子文字列。 |
|
名前
|
name | string |
トレーニングのトレーニング タイプに付けられたユーザーフレンドリ名。 |
|
customFields
|
customFields |
この トレーニング のカスタム フィールド値 |
戻り値
- SingleTraining
- SingleTraining
事前に署名されたアップロード URL を作成する
事前に署名されたアップロード URL を作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
ファイル名
|
filename | True | string |
ドキュメントの元のファイル名です。 これは表示名に使用されます。 拡張機能が含まれています。 |
mime
|
mime | True | string |
ドキュメントの MIME の種類 |
サイズ
|
size | True | integer |
ドキュメントの推定サイズ (バイト単位) |
拡張子
|
extension | True | string |
ドットを含まないドキュメントの拡張子 |
戻り値
- SinglePersonDocument
- SinglePersonDocument
新しいジョブの作成
提供されたデータを使用して新しいジョブレコードを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
companyStartDate
|
companyStartDate | True | string |
組織内でこのジョブが開始した、または開始する予定の日付です。 この日付は、RFC3339 によって定義された形式に従います。 YYYY-MM-DD の日付形式もサポートされていますが、この形式を使用すると、日付は、要求しているテナントのタイムゾーンではなく、UTC 時間の開始日として保存されます。 |
companyEndDate
|
companyEndDate | string |
組織内でこのジョブが終了した、または終了する予定の日付です。 この日付は、RFC3339 によって定義された形式に従います。 YYYY-MM-DD の日付形式もサポートされていますが、この形式を使用すると、日付は、要求しているテナントのタイムゾーンではなく、UTC 時間の開始日として保存されます。 |
|
名前
|
name | True | string |
作成するジョブの名前 |
ID
|
id | string |
このジョブが所属するビジネス エンティティの識別子文字列。 |
|
名前
|
name | string |
このビジネス エンティティに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
|
legalName
|
legalName | string |
ビジネス エンティティの法的名称です。 通常、管理タスクに使用されます。 |
|
数値
|
number | string |
法的に登録されたビジネス エンティティ番号、たとえば、オーストラリアではこれは ABN であり、アメリカでは RN である可能性があります。 |
|
ID
|
id | string | ||
名前
|
name | string |
この部署に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
|
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
ID
|
id | string |
このジョブのスーパーバイザーのジョブの識別子文字列。 |
|
名前
|
name | string |
スーパーバイザーのジョブの名前/役職。 |
|
ID
|
id | string |
ロケーションの識別子文字列。 |
|
名前
|
name | string |
ロケーションに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
|
アドレス
|
address | string |
この場所の住所。 |
|
ID
|
id | string | ||
名前
|
name | string |
作業クラスの名前。 |
|
ID
|
id | string | ||
名前
|
name | string |
作業の種類の名前。 列挙型: |
|
fte
|
fte | string |
このジョブに相当するフルタイム。 さまざまなコンテキスト間で比較できる従業員のワークロードを示します。 これは、FTE を持たない人には無効です。 |
|
ID
|
id | string |
支払いグレードの識別子文字列。 |
|
コード
|
code | string |
支払いグレードに関連付けられた管理上のショート コード。 |
|
名前
|
name | string |
支払いグレードに付けられたフレンドリ名。 |
|
種類
|
type | string |
この報酬スケジュールの支払い方法。 列挙型: |
|
payCycle
|
payCycle | True | string |
ジョブが支払われるサイクル。 列挙型: |
通貨
|
currency | string |
このジョブが支払われる基本金額と合計金額の通貨。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
ID
|
id | string |
この報酬スケジュールの雇用条件の識別子文字列。 |
|
名前
|
name | string |
雇用条件に付けられた名前。 |
|
awardName
|
awardName | string |
アワードの名前は、ユーザーに提示される名前とは異なる場合があります。 通常、アワードの正式名称に使用されます。 |
|
hoursPerCycle
|
hoursPerCycle | True | double |
payCycle ごとに何時間働いたか。 |
baseAnnualSalary
|
baseAnnualSalary | double |
基本給は年俸です。これは、報酬スケジュールタイプが「年俸」の場合にのみ必要です。 |
|
baseHourlyRate
|
baseHourlyRate | double |
基本給は時給です。これは、報酬スケジュールタイプが「時給」の場合にのみ必要です。 |
|
名前
|
name | True | string |
この追加の名前。 |
種類
|
type | True | string |
この加算がどのように計算されて基本金額に適用されるか、MultipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、FixedAmount は合計に直接追加されます。 列挙型: |
値
|
value | True | string |
MultipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この加算で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
ID
|
id | string |
デフォルトの報酬コンポーネントの識別子文字列。 |
|
名前
|
name | string |
デフォルトの報酬コンポーネントの名前。 |
|
名前
|
name | True | string |
この追加の名前。 |
種類
|
type | True | string |
この加算がどのように計算されて基本金額に適用されるか、MultipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、FixedAmount は合計に直接追加されます。 列挙型: |
値
|
value | True | string |
MultipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この加算で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
名前
|
name | True | string |
この内訳の名前。 |
種類
|
type | True | string |
この内訳がどのように計算されて基本金額に適用されるか、MultipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、FixedAmount は合計に直接追加されます。 列挙型: |
値
|
value | True | string |
MultipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この内訳で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
ID
|
id | string |
デフォルトの報酬コンポーネントの識別子文字列。 |
|
名前
|
name | string |
デフォルトの報酬コンポーネントの名前。 |
|
ID
|
id | string |
採用ソースの識別子文字列。 |
|
名前
|
name | string |
この採用ソースに付けられた名前。 |
|
コスト
|
cost | double |
採用のコスト。 |
|
通貨
|
currency | string |
このジョブを採用するために使用される通貨。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
戻り値
- SingleJob
- SingleJob
新しい個人レコードを作成する
人を作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
firstName
|
firstName | string |
その人の名。 |
|
middleName
|
middleName | string |
その人のミドル ネーム。 |
|
lastName
|
lastName | True | string |
その人の姓。 |
preferredName
|
preferredName | string |
その人の希望する名前。 通常、従業員が自分で構成できます。 |
|
dateOfBirth
|
dateOfBirth | string |
生年月日 (YYYY-MM-DD)。 |
|
性別
|
gender | string |
人の性別の人間が読める文字列、例えば |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
タイトル
|
title | string |
この人のタイトル、たとえば、「Mr」。 指定しない場合は無効であり、大文字と小文字は区別されません。 |
|
名前
|
name | string |
緊急連絡先の名前。 |
|
relationship
|
relationship | string |
この緊急連絡先とその人との関係。 |
|
電話
|
phone | string |
緊急連絡先の電話番号。 |
|
電子メール
|
string |
緊急連絡先のメール。 |
||
電子メール
|
string |
実際のメール アドレスです。 |
||
isPersonal
|
isPersonal | boolean |
このメールが個人用か仕事用かを示します。 |
|
数値
|
number | string |
実際の電話番号。 この番号の前に市外局番を付けることができます。 これがある場合、システムは自動的に電話番号の発信国を判別しようとします |
|
isPersonal
|
isPersonal | boolean |
この電話番号が個人用か職場用かを示します。 |
|
customFields
|
customFields | object |
このユーザーのためのカスタムフィールド値 |
|
id
|
id | string | ||
名前
|
name | string |
作業ライツの名前。 |
|
workRightExpiryDate
|
workRightExpiryDate | string |
戻り値
- SinglePerson
- SinglePerson
新しい部署の作成
作成された部署を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
識別子
|
identifier | string |
管理タスクに使用できるオプションの識別子。 |
|
名前
|
name | True | string |
この部署に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
注意
|
notes | string |
部署に添付されたメモ |
|
parentId
|
parentId | string |
親部署の識別子文字列、または親 (これはトップレベルの部署です) がない場合は null。 |
|
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの部署を選択できるかどうかを指定します。 |
戻り値
- 回答
- Response
既存のジョブにパッチを適用する
提供されたデータを使用して、既存のジョブレコードの属性にパッチを適用します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ジョブの ID
|
id | True | string |
リソース識別子文字列 |
effectiveFrom
|
effectiveFrom | True | string |
このジョブの更新が組織内から有効になる日付です。 これは、ジョブ全体の開始日には影響しないことに注意してください。 YYYY-MM-DD の日付形式もサポートされていますが、この形式を使用すると、日付は、要求しているテナントのタイムゾーンではなく、UTC 時間の開始日として保存されます。 |
effectiveTo
|
effectiveTo | string |
このジョブの更新が組織内で有効になる日付です。 これは、ジョブ全体の終了日には影響しないことに注意してください。 この日付は、RFC3339 によって定義された形式に従います。 YYYY-MM-DD の日付形式もサポートされていますが、この形式を使用すると、日付は、要求しているテナントのタイムゾーンではなく、UTC 時間の開始日として保存されます。 |
|
名前
|
name | string |
更新するジョブの名前 |
|
ID
|
id | string |
このジョブが所属するビジネス エンティティの識別子文字列。 |
|
名前
|
name | string |
このビジネス エンティティに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
|
legalName
|
legalName | string |
ビジネス エンティティの法的名称です。 通常、管理タスクに使用されます。 |
|
数値
|
number | string |
法的に登録されたビジネス エンティティ番号、たとえば、オーストラリアではこれは ABN であり、アメリカでは RN である可能性があります。 |
|
ID
|
id | string | ||
名前
|
name | string |
この部署に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
|
ID
|
id | string |
人の識別子文字列をシステム内で検索します。 |
|
名前
|
name | string |
intelliHR で検索する人の名前。 検索では、名前の順序の違いが自動的に考慮されることに注意してください。 |
|
primaryEmailAddress
|
primaryEmailAddress | string |
システム内の人のプライマリとしてフラグが立てられたメールアドレス。 |
|
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
autoIncrementIntellihrId
|
autoIncrementIntellihrId | string |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
|
ID
|
id | string |
このジョブのスーパーバイザーのジョブの識別子文字列。 |
|
名前
|
name | string |
スーパーバイザーのジョブの名前/役職。 |
|
ID
|
id | string |
ロケーションの識別子文字列。 |
|
名前
|
name | string |
ロケーションに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
|
アドレス
|
address | string |
この場所の住所。 |
|
ID
|
id | string | ||
名前
|
name | string |
作業クラスの名前。 |
|
ID
|
id | string | ||
名前
|
name | string |
作業の種類の名前。 列挙型: |
|
fte
|
fte | string |
このジョブに相当するフルタイム。 さまざまなコンテキスト間で比較できる従業員のワークロードを示します。 これは、FTE を持たない人には無効です。 |
|
ID
|
id | string |
支払いグレードの識別子文字列。 |
|
コード
|
code | string |
支払いグレードに関連付けられた管理上のショート コード。 |
|
名前
|
name | string |
支払いグレードに付けられたフレンドリ名。 |
|
種類
|
type | string |
この報酬スケジュールの支払い方法。 列挙型: |
|
payCycle
|
payCycle | True | string |
ジョブが支払われるサイクル。 列挙型: |
通貨
|
currency | string |
このジョブが支払われる基本金額と合計金額の通貨。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
ID
|
id | string |
この報酬スケジュールの雇用条件の識別子文字列。 |
|
名前
|
name | string |
雇用条件に付けられた名前。 |
|
awardName
|
awardName | string |
アワードの名前は、ユーザーに提示される名前とは異なる場合があります。 通常、アワードの正式名称に使用されます。 |
|
hoursPerCycle
|
hoursPerCycle | True | double |
payCycle ごとに何時間働いたか。 |
baseAnnualSalary
|
baseAnnualSalary | double |
基本給は年俸です。これは、報酬スケジュールタイプが「年俸」の場合にのみ必要です。 |
|
baseHourlyRate
|
baseHourlyRate | double |
基本給は時給です。これは、報酬スケジュールタイプが「時給」の場合にのみ必要です。 |
|
名前
|
name | True | string |
この追加の名前。 |
種類
|
type | True | string |
この加算がどのように計算されて基本金額に適用されるか、MultipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、FixedAmount は合計に直接追加されます。 列挙型: |
値
|
value | True | string |
MultipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この加算で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
ID
|
id | string |
デフォルトの報酬コンポーネントの識別子文字列。 |
|
名前
|
name | string |
デフォルトの報酬コンポーネントの名前。 |
|
名前
|
name | True | string |
この追加の名前。 |
種類
|
type | True | string |
この加算がどのように計算されて基本金額に適用されるか、MultipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、FixedAmount は合計に直接追加されます。 列挙型: |
値
|
value | True | string |
MultipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この加算で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
名前
|
name | True | string |
この内訳の名前。 |
種類
|
type | True | string |
この内訳がどのように計算されて基本金額に適用されるか、MultipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、FixedAmount は合計に直接追加されます。 列挙型: |
値
|
value | True | string |
MultipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この内訳で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
|
ID
|
id | string |
デフォルトの報酬コンポーネントの識別子文字列。 |
|
名前
|
name | string |
デフォルトの報酬コンポーネントの名前。 |
戻り値
- SingleJob
- SingleJob
トリガー
Webhook を作成し、テナント内にあるタイプのイベントにサブスクライブする |
Webhook を作成し、テナント内にあるタイプのイベントにサブスクライブする |
Webhook を作成し、テナント内にあるタイプのイベントにサブスクライブする
Webhook を作成し、テナント内にあるタイプのイベントにサブスクライブする
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
webhookEvent
|
webhookEvent | True | string |
webhookEvent |
isEnabled
|
isEnabled | boolean |
isEnabled |
|
ソース
|
source | string |
ソース |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ID |
イベント
|
event | string |
イベント |
timestamp
|
timestamp | string |
timestamp |
セルフ
|
links.self | string |
セルフ |
定義
SingleBusinessEntity
名前 | パス | 型 | 説明 |
---|---|---|---|
BusinessEntity
|
data | BusinessEntity |
ListofBusinessEntities
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of BusinessEntity | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
回答
名前 | パス | 型 | 説明 |
---|---|---|---|
BusinessUnit3
|
data | BusinessUnit3 | |
Meta1
|
meta | Meta1 |
応答に関するその他のメタ情報が含まれています。 |
ListofBusinessUnits
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of BusinessUnit3 | |
Meta2
|
meta | Meta2 |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleCustomFieldDefinition
名前 | パス | 型 | 説明 |
---|---|---|---|
CustomFieldDefinition
|
data | CustomFieldDefinition |
ListofCustomFieldDefinitions
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of CustomFieldDefinition | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleDefaultRemunerationComponent
名前 | パス | 型 | 説明 |
---|---|---|---|
DefaultRemunerationComponent
|
data | DefaultRemunerationComponent |
ListofDefaultRemunerationComponents
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of DefaultRemunerationComponent | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleEmploymentCondition
名前 | パス | 型 | 説明 |
---|---|---|---|
EmploymentCondition
|
data | EmploymentCondition |
ListofEmploymentConditions
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of EmploymentCondition | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleJob
名前 | パス | 型 | 説明 |
---|---|---|---|
Meta1
|
meta | Meta1 |
応答に関するその他のメタ情報が含まれています。 |
ジョブ
|
data | Job |
ListJobs
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of Job | |
Meta8
|
meta | Meta8 |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleLocation
名前 | パス | 型 | 説明 |
---|---|---|---|
location5
|
data | location5 |
Listlocations
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of location5 | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SinglePayGrade
名前 | パス | 型 | 説明 |
---|---|---|---|
payGrade5
|
data | payGrade5 |
ListofPayGrades
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of payGrade5 | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
ListPeople
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of data1 | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SinglePerson
名前 | パス | 型 | 説明 |
---|---|---|---|
data1
|
data | data1 |
SinglePersonDocument
名前 | パス | 型 | 説明 |
---|---|---|---|
Data3
|
data | Data3 |
PatchaPersonDocument
名前 | パス | 型 | 説明 |
---|---|---|---|
Data4
|
data | Data4 |
SingleRecruitmentSource
名前 | パス | 型 | 説明 |
---|---|---|---|
recruitmentSource
|
data | recruitmentSource |
ListofRecruitmentSources
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of recruitmentSource |
採用ソースの詳細。 |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleTrainingProvider
名前 | パス | 型 | 説明 |
---|---|---|---|
trainingProviders
|
data | trainingProviders |
ListallTrainingProviders
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of trainingProviders | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleTraining
名前 | パス | 型 | 説明 |
---|---|---|---|
トレーニング
|
data | Training |
ListofTrainings
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of Training | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleTrainingTypes
名前 | パス | 型 | 説明 |
---|---|---|---|
trainingTypes
|
data | trainingTypes |
ListallTrainingTypes
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of trainingTypes | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleWorkClass
名前 | パス | 型 | 説明 |
---|---|---|---|
WorkClassesSchema
|
data | WorkClassesSchema |
ListWorkClasses
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of WorkClassesSchema | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleWorkRight
名前 | パス | 型 | 説明 |
---|---|---|---|
WorkRight2
|
data | WorkRight2 |
ListofWorkRights
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of WorkRight2 | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
SingleWorkType
名前 | パス | 型 | 説明 |
---|---|---|---|
workType4
|
data | workType4 |
ListWorkTypes
名前 | パス | 型 | 説明 |
---|---|---|---|
data
|
data | array of workType4 | |
Meta
|
meta | Meta |
応答に関するその他のメタ情報が含まれています。 |
リンク
|
links | Links |
他の関連リソースへのリンク。 |
webhook-events
単一の Webhook イベント。
名前 | パス | 型 | 説明 |
---|---|---|---|
Data5
|
data | Data5 |
SingleWebhook
名前 | パス | 型 | 説明 |
---|---|---|---|
Data7
|
data | Data7 |
加算
名前 | パス | 型 | 説明 |
---|---|---|---|
名前
|
name | string |
この追加の名前。 |
種類
|
type | string |
この加算がどのように計算されて基本金額に適用されるか、multipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、固定金額は合計に直接追加されます。 列挙型: |
値
|
value | double |
multipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この加算で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
AdditionsToTotal
名前 | パス | 型 | 説明 |
---|---|---|---|
名前
|
name | string |
この合計追加の名前。 |
種類
|
type | string |
この合計加算がどのように計算されて基本金額に適用されるか、multipleOfBase は baseAnnualSalary で乗算されてから合計に追加され、固定金額は合計に直接追加されます。 列挙型: |
値
|
value | double |
multipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この加算で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
住所
名前 | パス | 型 | 説明 |
---|---|---|---|
addressType
|
addressType | string |
住所のタイプです。 |
fullAddress
|
fullAddress | string |
完全な住所。 |
国
|
country | string |
この住所の国。 |
postcode
|
postcode | string |
住所の郵便番号。 |
状態
|
state | string |
住所の状態。 |
番地
|
street | string |
住所がある通り。 |
区町村
|
suburb | string |
この住所の区長村。 |
詳細
名前 | パス | 型 | 説明 |
---|---|---|---|
名前
|
name | string |
この追加の名前。 |
種類
|
type | string |
この追加がどのように記録されるかは、他の報酬コンポーネントとは異なり、パッケージ全体の計算には使用されません。 列挙型: |
値
|
value | double |
multipleOfBase の場合、これは乗数 (9 = 9% など) ですが、固定金額の場合、これは合計に直接追加する金額です。 |
通貨
|
currency | string |
この加算で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
BusinessEntity
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ビジネス エンティティの識別子文字列。 |
名前
|
name | string |
このビジネス エンティティに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
legalName
|
legalName | string |
正式名称は、ユーザーに提示される名前とは異なる場合があります。 通常、管理タスクに使用されます。 |
数値
|
number | string |
法的に登録されたビジネス エンティティ番号、たとえば、オーストラリアではこれは ABN であり、アメリカでは RN である可能性があります。 |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこのビジネス エンティティを選択できるかどうかを指定します。 |
BusinessUnit3
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
部署の識別子文字列。 |
識別子
|
identifier | string |
管理タスクに使用できるオプションの識別子。 |
名前
|
name | string |
この部署に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
注意
|
notes | string |
部署に添付されたメモ |
parentId
|
parentId | string |
親部署の識別子文字列、または親 (これはトップレベルの部署です) がない場合は null。 |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの部署を選択できるかどうかを指定します。 |
BusinessEntity2
システムでのジョブの現在のビジネス エンティティ。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
このジョブのビジネス エンティティの識別子文字列。 |
名前
|
name | string |
このビジネス エンティティに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
BusinessUnit4
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
名前
|
name | string |
この部署に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
コーディネーター
トレーニングをしたコーディネーター。 このデータはオプションであり、保存されていない場合は null になります。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
displayName
|
displayName | string | |
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
autoIncrementIntellihrId
|
autoIncrementIntellihrId | double |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
CustomFieldDefinition
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
カスタム フィールド定義の識別子文字列。 |
名前
|
name | string |
このカスタム フィールド定義に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
apiName
|
apiName | string |
このカスタム フィールド定義に付けられた API 名前。 この名前は、API のカスタム フィールドを一意に識別するために使用され、レコードのカスタム フィールドを変更するときのキーとして使用されます。 |
説明
|
description | string |
このカスタム フィールド定義の説明。 これは、作成ページと更新ページのヒントとして使用されます。 |
modelType
|
modelType | string |
このカスタムフィールドが関連し、アタッチできるモデル。 列挙型: |
種類
|
type | string |
このフィールドが記録するデータのタイプ。 列挙型: |
定義
|
definitions | object |
このキーの値は、「タイプ」キーによって異なります。 これは、そのキーに関連する追加情報を格納するために使用されます。 カスタム フィールド構成の詳細については、カスタム フィールドに関するサポート情報の記事をご覧ください |
data1
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ユーザーの識別子文字列。 |
displayName
|
displayName | string |
このユーザーのためにシステム全体に表示する名前。 通常、preferredName (firstName) lastName のパターンに従いますが、テナント全体で異なる形式に構成することもできます。 |
firstName
|
firstName | string |
その人の名。 |
middleName
|
middleName | string |
その人のミドル ネーム。 |
lastName
|
lastName | string |
その人の姓。 |
preferredName
|
preferredName | string |
その人の希望する名前。 通常、従業員が自分で構成できます。 |
dateOfBirth
|
dateOfBirth | string |
生年月日 (YYYY-MM-DD)。 |
性別
|
gender | string |
ユーザーの性別を表す人間が読める文字列 (例: 男性)。 |
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
autoIncrementIntellihrId
|
autoIncrementIntellihrId | double |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
タイトル
|
title | string |
この人のタイトル、たとえば、「Mr」。 指定しない場合、これは null です。 |
emailAddresses
|
emailAddresses | array of EmailAddress |
このユーザーに属するメール アドレスの配列。 |
EmergencyContact
|
emergencyContact | EmergencyContact |
このユーザーの緊急連絡の詳細。 |
employmentStatus
|
employmentStatus | string |
組織内でのこのユーザーの現在の状態。 列挙型: |
jobs
|
jobs | array of Job4 |
開始日の逆の時系列でならんだ、このユーザーに関連付けられたシンプルなジョブ エントリの配列です。 |
WorkRights
|
workRights | WorkRights |
そのユーザーの労働者の権利を示す |
PrimaryEmailAddress1
|
primaryEmailAddress | PrimaryEmailAddress1 |
このユーザーのメインのメール アドレスに関する情報。メール情報がない場合は null。 |
PrimaryPhoneNumber1
|
primaryPhoneNumber | PrimaryPhoneNumber1 |
このユーザーのメインの電話番号に関する情報。電話番号情報がない場合は null。 |
住所
|
addresses | array of Address |
このユーザーに属する住所の配列。 |
phoneNumbers
|
phoneNumbers | array of PhoneNumber |
この "ユーザー" に属する電話番号の配列。 |
createdAt
|
createdAt | string |
レコードが作成された日時。 この日付は、RFC3339 によって定義された形式に従います。 |
updatedAt
|
updatedAt | string |
このレコードが最後に更新された日時。 この日付は、RFC3339 によって定義された形式に従います。 |
Data3
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ユーザーのドキュメントの識別子文字列。 |
personId
|
personId | string | |
presignedUploadUrl
|
presignedUploadUrl | string |
S3 へユーザーのドキュメントをアップロードできるようにする事前に署名されたアップロード URL。 このリンクは、作成後 20 分で期限切れになります。 ここに事前に署名された S3 URL を使用してオブジェクトをアップロードする方法の説明があります |
Data4
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ユーザーのドキュメントの識別子文字列。 |
personId
|
personId | string | |
uploadStatus
|
uploadStatus | string |
このドキュメントのアップロードの状態。 列挙型: |
Data5
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
Webhook イベントの識別子文字列。 |
名前
|
name | string |
この Webhook イベントの人間が読み取り可能な一意のイベント キーです。 |
イベント
|
event | string |
Webhook イベントの置換フィールド。 |
examplePayload
|
examplePayload | object |
この特定の Webhook イベントにサブスクライブする Webhooks に送信されるペイロードの例。 |
Data7
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
Webhook の識別子文字列。 |
url
|
url | string |
サブスクライブされた Webhook イベントがトリガーされた時にリクエストが送信される Webhook エンドポイント。 |
WebhookEvent
|
webhookEvent | WebhookEvent |
この Webhook をトリガーした Webhook イベント。 |
isEnabled
|
isEnabled | boolean |
ユーザーがこの Webhook を選択できるかどうかを指定します。 無効にすると、この Webhook は送信されません。 |
ソース
|
source | string |
どのシステムがこの Webhook を作成したかを識別するために使用できるカスタマイズ可能な文字列。 intelliHR アプリケーションを介して作成された Webhook はソースが「カスタム」になります。 |
createdAt
|
createdAt | string |
レコードが作成された日時。 この日付は、RFC3339 によって定義された形式に従います。 |
updatedAt
|
updatedAt | string |
このレコードが最後に更新された日時。 この日付は、RFC3339 によって定義された形式に従います。 |
控除
名前 | パス | 型 | 説明 |
---|---|---|---|
名前
|
name | string |
この控除の名前。 |
種類
|
type | string |
この控除がどのように計算されて基本金額に適用されるか、multipleOfBase は baseAnnualSalary で乗算されてから合計から控除され、固定金額は合計から直接控除されます。 列挙型: |
値
|
value | double |
multipleOfBase の場合、これは乗数ですが、固定金額の場合、これは合計から直接控除する金額です。 |
通貨
|
currency | string |
この控除で使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
DefaultRemunerationComponent
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
デフォルトの報酬コンポーネントの識別子文字列。 |
名前
|
name | string |
このデフォルトの報酬コンポーネントに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
値
|
value | string |
この報酬コンポーネントの値。 multipleOfBase の場合、これは乗数ですが、固定金額の場合、これは合計に直接追加する金額です。 |
isInUse
|
isInUse | boolean |
このデフォルトの報酬コンポーネントを報酬コンポーネントとして使用するかどうか。 |
automaticallyAddToJobs
|
automaticallyAddToJobs | boolean |
このデフォルトの報酬コンポーネントを新しく作成/更新されたジョブに自動的に追加するかどうか。 |
isEnabled
|
isEnabled | boolean |
システムでこのデフォルトの報酬コンポーネントの使用が有効になっている場合。 |
通貨
|
currency | string |
このデフォルトの報酬コンポーネントに使用される通貨。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
種類
|
type | string |
このデフォルトの報酬コンポーネントのタイプ。 列挙型: |
valueType
|
valueType | string |
このデフォルトの報酬コンポーネントの値のタイプ。 列挙型: |
EmailAddress
名前 | パス | 型 | 説明 |
---|---|---|---|
電子メール
|
string |
実際のメール アドレスです。 |
|
isPrimary
|
isPrimary | boolean |
これがメインのメール アドレスの場合。 |
isPersonal
|
isPersonal | boolean |
これが個人のメール アドレスの場合。 |
EmergencyContact
このユーザーの緊急連絡の詳細。
名前 | パス | 型 | 説明 |
---|---|---|---|
名前
|
name | string |
緊急連絡先の名前。 |
relationship
|
relationship | string |
この緊急連絡先とその人との関係。 |
電話
|
phone | string |
緊急連絡先の電話番号。 |
電子メール
|
string |
緊急連絡先のメール。 |
EmploymentCondition
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
雇用条件の識別子文字列。 |
名前
|
name | string |
雇用条件に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
awardName
|
awardName | string |
アワードの名前は、ユーザーに提示される名前とは異なる場合があります。 通常、アワードの正式名称に使用されます。 |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの雇用条件を選択できるかどうかを指定します。 |
EmploymentCondition2
この仕事が支払われている雇用条件。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
この報酬スケジュールの雇用条件の識別子文字列。 |
名前
|
name | string |
雇用条件に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
awardName
|
awardName | string |
アワードの名前は、ユーザーに提示される名前とは異なる場合があります。 通常、アワードの正式名称に使用されます。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
ジョブ
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ジョブの識別子文字列。 |
人
|
person | Person | |
採用
|
recruitment | Recruitment |
このジョブために保存された採用の詳細。 |
場所
|
location | Location |
このジョブの地理的位置。 |
PayGrade
|
payGrade | PayGrade | |
BusinessUnit4
|
businessUnit | BusinessUnit4 | |
BusinessEntity2
|
businessEntity | BusinessEntity2 |
システムでのジョブの現在のビジネス エンティティ。 |
SupervisorJob
|
supervisorJob | SupervisorJob | |
SupervisorPerson
|
supervisorPerson | SupervisorPerson |
このジョブのスーパーバイザーのためのユーザー情報、スーパーバイザーがいない場合は null。 |
RemunerationSchedule
|
remunerationSchedule | RemunerationSchedule |
給与や時給などの情報を含む、このジョブの現在の報酬の詳細は、すべてのジョブに報酬スケジュールがありますが、無給の従業員には特別な |
名前
|
name | string |
このジョブの名前/役職。 |
fte
|
fte | number |
このジョブに相当するフルタイム。 さまざまなコンテキスト間で比較できる従業員のワークロードを示します。 これは、FTE を持たない人には無効です。 |
workClass
|
workClass | string | |
workType
|
workType | string |
これはこのジョブの作業の分類で、フルタイムとパートタイムの従業員と無給のボランティアを区別するために使用されます。 列挙型: |
jobStatus
|
jobStatus | string |
組織内でのこのジョブの現在の状態。 列挙型: |
companyStartDate
|
companyStartDate | string |
組織内でこのジョブが開始した、または開始する予定の日付です。 この日付は、RFC3339 によって定義された形式に従います。 |
companyEndDate
|
companyEndDate | string |
このジョブが組織内で終了または終了する日付、終了日がない場合は null。 この日付は、RFC3339 によって定義された形式に従います。 |
isEndDateConfirmed
|
isEndDateConfirmed | boolean |
終了日が intelliHR アプリケーション内で確定されているかどうか。 |
turnoverType
|
turnoverType | string |
この仕事の終わりの離職のタイプが、分類されます。 |
turnoverReason
|
turnoverReason | string |
離職理由の名前です。 |
createdAt
|
createdAt | string |
レコードが作成された日時。 この日付は、RFC3339 によって定義された形式に従います。 |
Job4
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ジョブの識別子文字列。 |
名前
|
name | string |
このジョブの名前/役職。 |
startDate
|
startDate | string |
組織内でこのジョブが開始した、または開始する予定の日付です。 この日付は、RFC3339 によって定義された形式に従います。 |
endDate
|
endDate | string |
このジョブが組織内で終了または終了する日付、終了日がない場合は null。 この日付は、RFC3339 によって定義された形式に従います。 |
jobStatus
|
jobStatus | string |
組織内でのこのジョブの現在の状態。 列挙型: |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
Job7
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
名前
|
name | string | |
startDate
|
startDate | string | |
endDate
|
endDate | string | |
jobStatus
|
jobStatus | string |
ステータス スキーマ。 列挙型: |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
リンク
他の関連リソースへのリンク。
名前 | パス | 型 | 説明 |
---|---|---|---|
セルフ
|
self | string |
現在のページの URL |
最初
|
first | string |
最初のページの URL |
prev
|
prev | string |
前のページの URL |
次へ
|
next | string |
次のページの URL |
最後
|
last | string |
最後のページの URL |
場所
このジョブの地理的位置。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
名前
|
name | string |
ロケーションに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
アドレス
|
address | string |
この場所の住所。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
location5
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
ロケーションの識別子文字列。 |
parentId
|
parentId | string |
親場所の識別子文字列、または親 (これはトップレベルの場所です) がない場合は null。 |
名前
|
name | string |
ロケーションに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
アドレス
|
address | string |
この場所の住所。 |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの場所を選択できるかどうかを指定します。 |
Meta
応答に関するその他のメタ情報が含まれています。
名前 | パス | 型 | 説明 |
---|---|---|---|
ページ割り付け
|
pagination | Pagination |
応答の改ページに関連する情報が含まれています |
Meta1
応答に関するその他のメタ情報が含まれています。
名前 | パス | 型 | 説明 |
---|---|---|---|
asAt
|
asAt | string |
この応答の対象となる時点。 この日付は、RFC3339 によって定義された形式に従います。 |
Meta2
応答に関するその他のメタ情報が含まれています。
名前 | パス | 型 | 説明 |
---|---|---|---|
asAt
|
asAt | string |
この応答の対象となる時点。 この日付は、RFC3339 によって定義された形式に従います。 |
ページ割り付け
|
pagination | Pagination |
応答の改ページに関連する情報が含まれています |
Meta8
応答に関するその他のメタ情報が含まれています。
名前 | パス | 型 | 説明 |
---|---|---|---|
asAt
|
asAt | string |
この応答のデータが正確である時点。 この日付は、RFC3339 によって定義された形式に従います。 |
ページ割り付け
|
pagination | Pagination |
応答の改ページに関連する情報が含まれています |
ページ割り付け
応答の改ページに関連する情報が含まれています
名前 | パス | 型 | 説明 |
---|---|---|---|
合計
|
total | integer |
合計項目数 |
カウント
|
count | integer |
現在のページの項目数 |
per_page
|
per_page | integer |
ページごとの制限項目 |
current_page
|
current_page | integer |
現在のページ |
total_pages
|
total_pages | integer |
ページの合計数 |
PayGrade
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
名前
|
name | string |
支払いグレードに付けられたフレンドリ名。 |
コード
|
code | string |
支払いグレードに関連付けられた管理上のショート コード。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
payGrade5
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
支払いグレードの識別子文字列。 |
コード
|
code | string |
支払いグレードに関連付けられた管理上のショート コード。 |
名前
|
name | string |
支払いグレードに付けられたフレンドリ名。 |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの支払いグレードを選択できるかどうかを指定します。 |
人
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
displayName
|
displayName | string |
このユーザーのためにシステム全体に表示する名前。 通常、preferredName (firstName) lastName のパターンに従いますが、テナント全体で異なる形式に構成することもできます。 |
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
autoIncrementIntellihrId
|
autoIncrementIntellihrId | double |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
Person7
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
displayName
|
displayName | string | |
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
autoIncrementIntellihrId
|
autoIncrementIntellihrId | double |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
電話番号
名前 | パス | 型 | 説明 |
---|---|---|---|
数値
|
number | string |
実際の電話番号。 |
fullNumber
|
fullNumber | string |
市外局番付きの実際の電話番号 (登録されている場合)。 |
isPrimary
|
isPrimary | boolean |
これがメインの電話番号の場合。 |
isPersonal
|
isPersonal | boolean |
これが個人の電話番号の場合。 |
PrimaryEmailAddress1
このユーザーのメインのメール アドレスに関する情報。メール情報がない場合は null。
名前 | パス | 型 | 説明 |
---|---|---|---|
電子メール
|
string |
実際のメール アドレスです。 |
|
isPersonal
|
isPersonal | boolean |
このメールが個人用か仕事用かを示します。 |
PrimaryPhoneNumber1
このユーザーのメインの電話番号に関する情報。電話番号情報がない場合は null。
名前 | パス | 型 | 説明 |
---|---|---|---|
数値
|
number | string |
実際の電話番号。 |
fullNumber
|
fullNumber | string |
市外局番付きの実際の電話番号 (登録されている場合)。 |
isPersonal
|
isPersonal | boolean |
この電話番号が個人用番号か職場用かを示します。 |
プロバイダー
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
トレーニングのトレーニング プロバイダーの識別子文字列。 |
名前
|
name | string |
トレーニングのトレーニング プロバイダーに付けられたユーザーフレンドリ名。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
採用
このジョブために保存された採用の詳細。
名前 | パス | 型 | 説明 |
---|---|---|---|
コスト
|
cost | number |
このジョブを採用するためのコスト。 null の場合、コストは記録されていません。 |
通貨
|
currency | string |
このジョブを採用するために使用される通貨。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
ソース
|
source | Source |
このジョブのソースは採用ソース、記録されていない場合は null です。 |
recruitmentSource
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
採用ソースの識別子文字列。 |
名前
|
name | string |
この採用ソースに付けられた名前。 |
parentId
|
parentId | string |
親採用ソースの識別子文字列、または親 (これはトップレベルの採用ソースです) がない場合は null。 |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの採用ソースを選択できるかどうかを指定します。 |
RemunerationSchedule
給与や時給などの情報を含む、このジョブの現在の報酬の詳細は、すべてのジョブに報酬スケジュールがありますが、無給の従業員には特別な No Remuneration Schedule
スケジュールがあります。
名前 | パス | 型 | 説明 |
---|---|---|---|
種類
|
type | string |
この報酬スケジュールの支払い方法。ユーザーが未払いの場合、これは |
baseAnnualSalary
|
baseAnnualSalary | double |
基本給は毎年支払われます。これは、1 時間ごとに支払われる場合は概算です。 baseAnnualSalary と baseHourlyRate の両方が作成またはパッチ要求で提供されている場合、baseHourlyRate は無視されることに注意してください。 |
baseHourlyRate
|
baseHourlyRate | double |
基本給は 1 時間ごとに支払われます。これは、年棒制の場合は概算です。 baseAnnualSalary と baseHourlyRate の両方が作成またはパッチ要求で提供されている場合、baseHourlyRate は無視されることに注意してください。 |
通貨
|
currency | string |
このジョブが支払われる基本金額と合計金額の通貨。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
hoursPerCycle
|
hoursPerCycle | double |
payCycle ごとに何時間働いたか。 |
payCycle
|
payCycle | string |
ジョブが支払われるサイクル。 列挙型: |
annualPackage
|
annualPackage | double |
追加と控除を含む、毎年支払われるパッケージの合計。 この金額は、基本年俸と追加額から控除額を差し引いて計算されます。 |
hourlyPackage
|
hourlyPackage | double |
追加と控除を含む、時間ごとに支払われるパッケージの合計。 この金額は、年間パッケージを年間の合計時間数で割って計算されます。 |
currencyConversionOccurred
|
currencyConversionOccurred | boolean |
年間パッケージを計算するときに、加算通貨と控除通貨の間で変換を実行する必要がある場合。 |
EmploymentCondition2
|
employmentCondition | EmploymentCondition2 |
この仕事が支払われている雇用条件。 |
追加
|
additions | array of Addition |
この報酬スケジュールの追加の配列。 |
控除
|
deductions | array of Deduction |
この報酬スケジュールの控除の配列。 |
additionsToTotal
|
additionsToTotal | array of AdditionsToTotal |
この報酬スケジュールの他のすべてのコンポーネントの後にパッケージに適用される追加の配列。 |
内訳
|
breakdowns | array of Breakdown |
この報酬スケジュールの内訳の配列。 内訳は、パッケージ全体の計算には使用されません。 |
ソース
このジョブのソースは採用ソース、記録されていない場合は null です。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
名前
|
name | string |
この採用ソースに付けられた名前。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
SupervisorJob
このジョブのスーパーバイザーのためのジョブ情報、スーパーバイザーがいない場合は null。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
このジョブのスーパーバイザーのジョブの識別子文字列。 |
jobStatus
|
jobStatus | string |
組織内でのこのジョブの現在の状態。 列挙型: |
名前
|
name | string |
スーパーバイザーのジョブの名前/役職。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
SupervisorPerson
このジョブのスーパーバイザーのためのユーザー情報、スーパーバイザーがいない場合は null。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
このジョブのスーパーバイザーのユーザーの識別子文字列。 |
displayName
|
displayName | string |
このユーザーのためにシステム全体に表示する名前。 通常、preferredName (firstName) lastName のパターンに従いますが、テナント全体で異なる形式に構成することもできます。 |
employeeNumber
|
employeeNumber | string |
intelliHR で人を識別する手動で入力された従業員番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
autoIncrementIntellihrId
|
autoIncrementIntellihrId | double |
intelliHR で人を一意に識別する自動生成された番号。 テナントの構成によっては、システムの UI に表示されない場合があります。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
トレーニング
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
トレーニングの識別子文字列。 |
名前
|
name | string |
このトレーニングに付けられたフレンドリ名。 |
Person7
|
person | Person7 | |
Job7
|
job | Job7 | |
コーディネーター
|
coordinator | Coordinator | |
時間
|
hours | string |
このトレーニングに費やした時間。 |
通貨
|
currency | string |
このトレーニングで使用される通貨です。 国際通貨コード。 通常、オーストラリアドルは AUD、米ドルは USD などです。コードの公式リストを参照してください。 |
コスト
|
cost | string |
このトレーニングのコストです。 |
プロバイダー
|
provider | Provider | |
タイプ
|
type | Type | |
completionDate
|
completionDate | string | |
createdAt
|
createdAt | string |
レコードが作成された日時。 この日付は、RFC3339 によって定義された形式に従います。 |
updatedAt
|
updatedAt | string |
このレコードが最後に更新された日時。 この日付は、RFC3339 によって定義された形式に従います。 |
trainingProviders
名前 | パス | 型 | 説明 |
---|---|---|---|
id
|
id | string |
トレーニング プロバイダーの識別子文字列。 |
名前
|
name | string |
このトレーニング プロバイダーに付けられたフレンドリ名。 |
既定
|
isDefault | boolean |
トレーニングレコードの作成時に、この トレーニング プロバイダーをデフォルトとして使用するかどうかを示します。 |
trainingTypes
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
トレーニング タイプの識別子文字列。 |
名前
|
name | string |
このトレーニング タイプに付けられたフレンドリ名。 |
既定
|
isDefault | boolean |
トレーニングレコードの作成時に、このトレーニング タイプをデフォルトとして使用するかどうかを示します。 |
タイプ
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
トレーニングのトレーニング タイプの識別子文字列。 |
名前
|
name | string |
トレーニングのトレーニング タイプに付けられたユーザーフレンドリ名。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
WebhookEvent
この Webhook をトリガーした Webhook イベント。
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
Webhook イベントの識別子文字列。 |
名前
|
name | string |
この Webhook イベントの人間が読み取り可能な一意のイベント キーです。 |
イベント
|
event | string |
Webhook イベントの置換フィールド。 |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
WorkClassesSchema
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
作業クラスの識別子文字列。 |
名前
|
name | string |
この作業クラスに付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
WorkType2
|
workType | WorkType2 | |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの作業タイプを選択できるかどうかを指定します。 |
WorkRight2
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
作業権利の識別子文字列。 |
名前
|
name | string |
この作業権利に付けられた名前。 この名前は通常、システムのユーザーに表示されます。 |
countryId
|
countryId | string |
国の識別子文字列。 |
国
|
country | string |
割り当てられた国の名前の値。 |
WorkRights
そのユーザーの労働者の権利を示す
名前 | パス | 型 | 説明 |
---|---|---|---|
名前
|
name | string |
作業権利の種類 |
国
|
country | string |
労働者の権利が有効な国 |
expirationDate
|
expirationDate | string |
労働者の権利が失効する日付 |
WorkType2
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string | |
名前
|
name | string |
作業の種類の名前。 列挙型: |
リンク
|
link | string |
このデータの詳細については、パブリック API にリンクしてください。 |
workType4
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
id | string |
作業 タイプの識別子文字列。 |
名前
|
name | string |
作業の種類の名前。 列挙型: |
isEnabled
|
isEnabled | boolean |
ドロップダウンでユーザーがこの作業タイプを選択できるかどうかを指定します。 |
文字列
これは基本的なデータ型 '文字列' です。