API docs by Redocly

PEOPLE API (1.0)

Download OpenAPI specification:Download

概要

このドキュメントでは CYDAS PEOPLE API の仕様について説明します。

エラーレスポンス

source はエラーの原因の対象のフィールド、type はエラーの型、message は原因の説明を示します。errors には送られたリソースのプロパティにエラーがあった場合の説明が入ります。

{
  "errors": [
    {
      "source": "pageSize",
      "type": "INVALID_PARAMETER",
      "message": "pageSize には、100 以下の値を指定してください。"
    }
  ]
}
Type ステータスコード 説明
BadRequest 400 リクエストパラメータが不正です。レスポンスのエラーメッセージをご確認ください。
Unauthorized 401 トークンが正しくありません。
Forbidden 403 リソースへのアクセスが認められていません。また、エンドポイントが不正なときにも、このコードが使用されます。
NotFound 404 社員情報など指定したリソースが存在しないときに返されます。レスポンスのエラーメッセージをご確認ください。
InternalServerError 500 システム内部で予期せぬエラーが発生しました。
GatewayTimeout 504 サーバー側でリクエストを処理できませんでした。デプロイ中のときにもこのコードが返されます。時間を置いて再度実行してください。また、リクエストの件数が多いときにもこのコードが返されます。1,200 件を目安に分割して再度実行してください。

テナント

テナント情報を取得する

APIの接続先のテナント情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

社員情報

社員情報リスト

社員情報をリストで取得します。

取得したい情報のカテゴリ指定について

Query Parameter の embed を利用します。embed にカテゴリのキーをカンマ区切りで指定することで、複数の社員情報を同時に取得することができます。embed で指定可能な情報と取得できる情報については以下を参照ください。

  • ※ カテゴリ名（キー）: 取得する情報
  • 異動情報（personnelChanges）：現在有効な情報 1 件を取得します。
  • 兼務情報（additionalPositions）：現在有効な情報を取得します。
  • 自宅住所（addresses）: PEOPLE では複数の情報を登録することができるため、更新日時が最新の情報を 1 件取得します。
  • 戸籍情報（familyRegisters）: PEOPLE では 1 件のみ登録することができるため、その 1 件を取得します。
  • 通勤費情報（transportationExpenses）: 現在有効な情報 1 件を取得します。
  • 給与情報（salaries）：現在有効な情報 1 件を取得します。
  • 時給改定情報（hourlyWageRevisions）: 現在有効な情報 1 件を取得します。
  • 業務連絡先（workingContacts）: PEOPLE では 1 件のみ登録することができるため、その 1 件を取得します。
  • 希望する業務領域（preferredWorkAreas）: 現在有効な情報 1 件を取得します。

指定日付以降で更新のあった社員リスト取得について

Query Parameter の fromUpdatedDate で日付を指定することで、以下の条件に合致する社員に絞り込みます。

  • 指定日付以降に人事異動情報の更新が行われた（「指定日付 <= 更新日時」を条件に絞り込みます）
    • 過去の異動歴を更新した場合、その対象となる社員を取得することができます。
  • 指定日付以降に異動が行われた（「指定日付 <= 異動日」を条件に絞り込みます）
  • 指定日付以降に「基本情報」、「業務連絡先」に更新が行われた（「指定日付 <= 更新日時」を条件に絞り込みます）
  • 指定日付以降に embed で指定されたカテゴリの情報のいずれかに更新が行われた（「指定日付 <= 更新日時」を条件に絞り込みます）

注意事項

fromUpdatedDate は社員リストを絞り込むためのパラメータです。embed で指定して取得する情報に対する条件ではありません。例えば、給与情報の適用日が fromUpdatedDate 以降のものを取得する、といったことはできません。embed で指定して取得される情報の仕様については、「取得したい情報のカテゴリ指定について」をご参照ください。

通勤費情報などの時系列で扱う情報で、あらかじめ未来日を指定して登録した情報の取得について

Query Parameter の includesScheduled をご利用ください。これを利用することで、例えば「来月 10月1日から交通費の支給額が 20,000 円」という情報を取得することができます。

所属情報について

所属情報（position）は現在の情報が取得しますが、異動情報（personnelChanges）は異動日時点の情報が取得します。

ページネーションについて

  • page: デフォルト値を 1 とします。
  • pageSize: デフォルト値を 100 とします。指定可能な値は 1 ~ 100 とします。
query Parameters
embed
string
Example: embed=addresses,familyRegisters,transportationExpenses

同時に取得したい社員情報カテゴリを指定します。複数ある場合はカンマ区切りで指定します。

fromUpdatedDate
string <date>
Example: fromUpdatedDate=2020-04-01

指定した日付以降に人事異動・社員情報の更新があった社員に絞り込みます。

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

１ページで取得する件数

includesScheduled
boolean
Default: "false"

日付を基準とする情報のうち、未来日で登録している情報を含めて取得する時に指定します。

announcementType
string
Enum: "joining" "assignment" "transfer" "secondment" "leaveAbsence" "retirement" "rejoining"

発令タイプ（実装予定）

employmentType
string
Example: employmentType=1

雇用区分（実装予定）

enrollmentStatus
string
Example: enrollmentStatus=20,30
  • 在籍区分で社員を絞り込みます。複数ある場合は、カンマ区切りで指定します。
    • 10: 在籍予定（入社処理後、まだどの部署にも配属されていない社員）
    • 20: 在籍（配属または異動処理が行われた社員）
    • 30: 出向（出向処理が行われた社員）
    • 40: 休職（休職処理が行われた社員）
    • 50: 再入社予定（再入社処理が行われ、再入社日が未来日の社員）
    • 90: 退職（退職処理が行われた社員）

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

社員情報

指定した社員コード、もしくは指定した社員IDの社員情報を取得する。

path Parameters
id/employeeCode
required
string
query Parameters
embed
string
Example: embed=personnelChanges,addresses,familyRegisters,transportationExpenses,hourlyWageRevisions

同時に取得したい社員情報カテゴリを指定します。複数ある場合はカンマ区切りで指定します。

idType
string
Default: "employeeCode"
Enum: "id" "employeeCode"

IDで社員を指定する場合はid、社員番号で社員を指定する場合はemployeeCodeを指定してください。指定がない場合はデフォルトで社員番号が採用されます。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

月別勤怠情報

勤怠情報を登録します。複数社員のデータを登録することができます。

社員番号、適用日でユニークとなります。このユニーク項目で指定されるデータが存在しないとき、登録します。存在するときは、更新します。

Request Body schema: application/json
Array of objects (AttendancePost)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

月別勤怠情報

勤怠情報を月単位のリストで取得します。

Query Parameter の date で年月（YYYY-MM）を指定すると、その月の勤怠情報をリストで取得します。デフォルトでは当月の勤怠情報を取得します。

Query Parameter の departmentCode を指定すると、指定された部署に所属している社員に絞り込みます。

query Parameters
date
string <none>
Example: date=2020-04

年月

departmentCode
string
Example: departmentCode=10001

部署コード

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 1000 ]
Example: pageSize=100

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

時給改定情報

時給改定情報を登録します。複数社員のデータを登録することができます。

社員番号、適用日でユニークとなります。このユニーク項目で指定されるデータが存在しないとき、登録します。存在するときは、更新します。

Request Body schema: application/json
Array of objects (HourlyWageRevisionPost)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

給与情報

給与情報を登録します。

社員番号、適用日でユニークとなります。このユニーク項目で指定されるデータが存在しないとき、登録します。存在するときは、更新します。

Request Body schema: application/json
Array of objects (SalaryPost)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

アサインメント関連情報をリストで取得する

アサインメント関連情報をリストで取得します。

query Parameters
startDate
string <date>
Example: startDate=2020-04-01

指定した日付以降のアサイメント関連情報に絞り込みます。

endDate
string <date>
Example: endDate=2020-11-30

endDate を指定するときは、startDate も指定してください。 startDate, endDate で指定した期間内のアサイメント関連情報に絞り込みます。

page
integer

ページ番号

pageSize
integer

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

社員のプロフィール画像をリストで取得する

社員のプロフィール画像を Base64 文字列にエンコードしてリストで取得します。

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

employeeCode
string

指定した社員番号に対応する社員のプロフィール画像に絞って取得します。複数の社員番号で絞り込む場合は、社員番号をカンマで区切って指定してください。最大で100人分の社員の社員番号を同時に指定することができます。

fromUpdatedDate
string <date>

指定した日付以降に更新されたプロフィール画像に絞って取得します。

Responses

Response samples

Content type
application/json
{}

部署情報

部署情報をリストで取得する

現在有効な組織改編図内の部署情報をリストで取得します。

query Parameters
page
integer

ページ番号

pageSize
integer

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

部署情報を登録する

Request Body schema: application/json
Array of objects (DepartmentPost)

Request samples

Content type
application/json
{
  • "data": [
    ]
}

部署のマスタをリストで取得する

Query Parameter の types に以下のタイプを指定して絞り込みを行うことができます。複数の種別を同時に取得するときは、カンマ区切りで指定してください。types に何も指定しないときは、以下の種別のマスタデータ全てを対象に取得します。

  • 自由項目カテゴリ1: freeCode1
  • 自由項目カテゴリ2: freeCode2
  • 自由項目カテゴリ3: freeCode3
  • 自由項目カテゴリ4: freeCode4
  • 自由項目カテゴリ5: freeCode5
  • 自由項目カテゴリ6: freeCode6
  • 自由項目カテゴリ7: freeCode7
  • 自由項目カテゴリ8: freeCode8
  • 自由項目カテゴリ9: freeCode9
  • 自由項目カテゴリ10: freeCode10
query Parameters
page
integer

ページ番号

pageSize
integer

１ページで取得する件数

types
string

マスタデータの種別。複数指定するときはカンマ区切りで指定してください。

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

部署のマスタを登録する

マスタデータの種別を指定してマスタデータを登録します。 登録できるマスタデータの種別は以下になります。

  • 自由項目カテゴリ1: freeCode1
  • 自由項目カテゴリ2: freeCode2
  • 自由項目カテゴリ3: freeCode3
  • 自由項目カテゴリ4: freeCode4
  • 自由項目カテゴリ5: freeCode5
  • 自由項目カテゴリ6: freeCode6
  • 自由項目カテゴリ7: freeCode7
  • 自由項目カテゴリ8: freeCode8
  • 自由項目カテゴリ9: freeCode9
  • 自由項目カテゴリ10: freeCode10

新規で登録されたデータはマスタの最後尾に追加されます。 （画面上のマスタ一覧で最後尾に表示されます）

既存のマスタデータを更新する場合、画面上での表示位置は変更されません。

Request Body schema: application/json
object (DepartmentMasterPost)

Request samples

Content type
application/json
{
  • "data": {
    }
}

部署履歴をリストで取得する

部署の履歴情報をリストで取得します。

query Parameters
targetEffectiveDate
string <date>
Example: targetEffectiveDate=2024-04-01

履歴の開始年月日を基準に、指定された日付時点で有効な履歴に絞り込みます。

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 1000 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

所属長をリストで取得する

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 1000 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

組織改編をリストで取得する

改編日降順で取得します。

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer
Example: pageSize=100

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

組織改編を登録する

Request Body schema: application/json
object (組織改編作成)

新規に登録するとき、ステータスは notCompleted で作成します。

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

組織改編を更新

path Parameters
id
required
string
Request Body schema: application/json
object (組織改編更新)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

現在有効な組織改編を取得

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

組織改編の構造情報を取得

path Parameters
id
required
string
query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

組織改編と組織構造を紐付ける

path Parameters
id
required
string
Request Body schema: application/json
Array of objects (組織改編の構造情報作成)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "isSuccess": true
}

組織管理機能の設定情報を取得する

Request Body schema: application/json
object

Request samples

Content type
application/json
{
  • "data": {
    }
}

プロジェクト

プログラム情報を登録する

プログラム情報を登録します。複数プログラムのデータを登録することができます。

Request Body schema: application/json
Array of objects (プログラム情報)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

プログラム情報をリストで取得する

プログラム情報をリストで取得する

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer
Example: pageSize=100

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

プログラム情報を削除する

指定したコードのプログラム情報を削除する。

プログラムを削除すると、プロジェクトの情報なども削除します。

path Parameters
programCode
required
string

プログラムコード

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

プロジェクト情報を登録する

プロジェクト情報を登録します。

Request Body schema: application/json
Array of objects (プロジェクト情報登録モデル)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

プロジェクト情報をリストで取得する

プロジェクト情報をリストで取得する

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer
Example: pageSize=100

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

プロジェクト情報を削除する

指定したコードのプロジェクト情報を削除する。

プロジェクトを削除すると、アサインメント関連の情報なども削除します。

path Parameters
projectCode
required
string

プロジェクトコード

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

指定したプロジェクトに社員をアサインする

指定したプロジェクトに社員をアサインします。

path Parameters
projectCode
required
string

プロジェクトコード

Request Body schema: application/json
Array of objects (ProjectMember)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

プロジェクトのアサイン状況

プロジェクトのアサイン状況をリストで取得します。

path Parameters
projectCode
required
string

プロジェクトコード

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

メンバーのアサインを取り消す

指定したプロジェクトから社員のアサインを取り消します。

アサインを取り消すと、活動計画の情報なども削除します。

path Parameters
projectCode
required
string
employeeCode
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

アサインしたメンバーの活動計画を立てる

path Parameters
projectCode
required
string

プロジェクトコード

employeeCode
required
string

社員番号

date
required
string
Example: 2020-11

計画年月（YYYY-DD で指定）

Request Body schema: application/json
object (ProjectActivityPlan)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

活動計画情報をリストで取得する

指定されたプロジェクトおよび社員の活動計画情報をリストで取得します。

path Parameters
projectCode
required
string

プロジェクトコード

employeeCode
required
string

社員番号

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{}

活動計画情報を削除

指定されたプロジェクトおよび社員の活動計画情報を全て削除します。

path Parameters
projectCode
required
string

プロジェクトコード

employeeCode
required
string

社員番号

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

プロジェクト評価者

path Parameters
projectCode
required
string
query Parameters
page
integer

ページ番号

pageSize
integer

１ページで取得する件数

Responses

Response samples

Content type
application/json
{}

プロジェクト評価者を設定する

プロジェクト評価者を設定する

path Parameters
projectCode
required
string
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

プロジェクトのステージを取得する

プロジェクトのステージを取得する

path Parameters
projectCode
required
string
query Parameters
page
integer

ページ番号

pageSize
integer

１ページで取得する件数

Responses

Response samples

Content type
application/json
{}

プロジェクトのステージを更新する

プロジェクトのステージを更新する

path Parameters
projectCode
required
string
Request Body schema: application/json
object (ProjectStage)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

プロジェクトマネージャーをリストで取得する

path Parameters
projectCode
required
string
query Parameters
page
integer

ページ番号

pageSize
integer

１ページで取得する件数

Responses

Response samples

Content type
application/json
{}

プロジェクトマネージャーを設定する

プロジェクトに初めてマネージャーを登録すると、評価者にも登録します。

path Parameters
projectCode
required
string
Request Body schema: application/json
object (ProjectManager)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

勤怠情報

月別勤怠情報をリストで取得

月別勤怠情報をリストで取得します。各項目（休憩時間を除く、合計労働時間（分））など全て、集計期間開始日から集計期間終了日の期間内で集計されたデータです。

Query Parameter の departmentCode を指定すると、指定された部署に所属している社員に絞り込みます。

Query Parameter の date で年月（YYYY-MM）を指定すると、指定した月の１日を含む集計期間（集計期間開始年月日 <= 指定した月の１日 <= 集計期間終了日）を対象に情報を取得します。デフォルトでは当月の１日を含む集計期間を対象にします。

query Parameters
departmentCode
string

部署コード

date
string

対象年月

page
integer

ページ番号

pageSize
integer [ 1 .. 1000 ]

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

月別勤怠情報を登録

月別勤怠情報を登録します。登録した情報はパーソナルプロファイルの「My勤怠」や「マネジメント機能」で確認することができます。

休暇取得情報（holidays）およびその他勤怠項目情報（workingItems）に指定できる件数には上限があります。日数項目（unitType = day）、時間項目（unitType = minute）それぞれ 80 件までです。例えば、日数項目を holidays に 40 件、workingItems に 41 件指定するとエラーとなります。

Request Body schema: application/json
Array of objects (月別勤怠情報)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

日別勤怠情報をリストで取得

日別勤怠情報をリストで取得します。１日のうち打刻実績（「出勤」と「退勤」のセット）が複数回あるとき、その回数分の情報を取得します。レスポンスの例は「１日に複数の実績があるケース」をご参照ください。

Query Parameter の departmentCode を指定すると、指定された部署に所属している社員に絞り込みます。

Query Parameter の startDate, endDate で期間を指定して取得することができます。デフォルトは当日の情報を取得します。

query Parameters
startDate
string

期間（開始日）

endDate
string

期間（終了日）

departmentCode
string

部署コード

page
integer

ページ番号

pageSize
integer [ 1 .. 1000 ]

１ページで取得する件数

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

日別勤怠情報を登録

Request Body schema: application/json
Array of objects (DailyWorking)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

人事異動

異動情報をリストで取得

query Parameters
startDate
string <date>
Example: startDate=2020-04-01

指定した日付以降の異動情報に絞り込みます。

endDate
string <date>
Example: endDate=2020-11-30

endDate を指定するときは、startDate も指定してください。 startDate, endDate で指定した期間内の異動情報に絞り込みます。

page
integer

ページ番号

pageSize
integer

１ページで取得する件数

employeeCode
string

指定した社員番号に対応する社員の異動情報に絞って取得します。複数の社員番号で絞り込む場合は、社員番号をカンマで区切って指定してください。最大で100人分の社員の社員番号を同時に指定することができます。

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

異動情報を登録

異動情報を登録します。

Request Body schema: application/json

announcementTypeに指定する値を変えることで、異なる発令タイプの異動情報を同時に登録することができます。 発令タイプによってオブジェクトの構造、必須の項目は異なります。

指定する値とそれに対応する発令タイプは以下の通りです。

  • joining: 入社
  • assignment: 配属
  • transfer: 異動
  • leaveAbsence: 休職
  • leaveAbsenceReturn: 復職（休職中の社員に対してのみ登録可能です。）
  • secondment: 出向
  • secondmentReturn: 帰任（出向中の社員に対してのみ登録可能です。）
  • retirement: 退職
  • rejoining: 再入社（退職済みの社員に対してのみ登録可能です。）
  • other: その他
Array of PersonnelChangeJoiningPost (object) or PersonnelChangeAssignmentPost (object) or PersonnelChangeTransferPost (object) or PersonnelChangeLeaveAbsencePost (object) or PersonnelChangeLeaveAbsenceReturnPost (object) or PersonnelChangeSecondmentPost (object) or PersonnelChangeSecondmentReturnPost (object) or PersonnelChangeRetirementPost (object) or PersonnelChangeRejoiningPost (object) or PersonnelChangeOtherPost (object)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

異動情報をリストで取得 v2

query Parameters
startDate
string <date>
Example: startDate=2020-04-01

指定した日付以降の異動情報に絞り込みます。

endDate
string <date>
Example: endDate=2020-11-30

endDate を指定するときは、startDate も指定してください。 startDate, endDate で指定した期間内の異動情報に絞り込みます。

page
integer

ページ番号

pageSize
integer

１ページで取得する件数

employeeCode
string

指定した社員番号に対応する社員の異動情報に絞って取得します。複数の社員番号で絞り込む場合は、社員番号をカンマで区切って指定してください。最大で100人分の社員の社員番号を同時に指定することができます。

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

異動情報を更新された社員をリストで取得

期間中に異動情報を編集された、もしくは異動情報を新規で登録された社員をリストで取得します。 異動情報を削除された場合については更新としてカウントされません。

query Parameters
startDate
string <date>

指定された日付以降に更新された社員に絞り込みます。

endDate
string <date>

指定された日付以前に更新された社員に絞り込みます。

page
integer

ページ番号

pageSize
integer

１ページで取得する件数

Responses

Response samples

Content type
application/json
{}

異動情報登録のステータスを確認

operationId(UUID)を指定して異動情報登録バッチのステータスを取得します。

path Parameters
operationId
required
string <uuid>

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

マスタデータをリストで取得する

Query Parameter の types に以下のタイプを指定して絞り込みを行うことができます。複数の種別を同時に取得するときは、カンマ区切りで指定してください。types に何も指定しないときは、以下の種別のマスタデータ全てを対象に取得します。

  • 雇用区分: employmentType
  • 役職: jobTitle
  • 職種: jobCategory
  • 職務: jobDuty
  • 役割: jobRole
  • 等級A: gradeA
  • 等級B: gradeB
  • 等級C: gradeC
  • 担当エリア: area
  • 担当エリア分類区分01: areaType01
  • 担当エリア分類区分02: areaType02
  • 担当エリア分類区分03: areaType03
  • 担当エリア分類区分04: areaType04
  • 担当エリア分類区分05: areaType05
  • 採用区分: recruitmentType
  • 異動区分: transferType
  • その他区分: otherType
  • 退職事由: retirementReason
  • 休職事由: leaveAbsenceReason
  • 出向先会社名: secondmentCompany
  • 出向先地域（エリア）: secondmentArea
  • 職掌: officialDuty
  • 職群: jobFamily
  • 勤務地: workplace
  • 部門: division
  • 選択項目 01: announcementItemSelect01
  • 選択項目 02: announcementItemSelect02
  • 選択項目 03: announcementItemSelect03
  • 選択項目 04: announcementItemSelect04
  • 選択項目 05: announcementItemSelect05
  • 選択項目 06: announcementItemSelect06
  • 会社: companyCode
  • 原価: costCode
  • 担当: chargeCode
  • 勤務シフト: workShiftCode
  • 就労: employmentCode
  • 管轄人事: personnelCode
  • 専門職: professionalCode
  • 社外肩書: externalTitleCode
  • 駐在所属: stayAffiliationCode
  • ジョブグレード: jobGrade
  • 専任ジョブ: dedicatedJobCode
  • 専任ジョブグレード: dedicatedJobGrade
  • 組合支部: unionBranchCode
  • 要員集計: personnelTallyCode
  • 計上部門: accountingDepartmentCode
  • 原籍会社: originalCompanyCode
  • 原籍所属: originalAffiliationCode
  • 原籍役職: originalJobTitleCode
  • 予備０１: spareCode01
  • 予備０２: spareCode02
  • 予備０３: spareCode03
  • 予備０４: spareCode04
  • 予備０５: spareCode05
  • 予備０６: spareCode06
  • 予備０７: spareCode07
  • 予備０８: spareCode08
  • 予備０９: spareCode09
  • 予備１０: spareCode10
  • 人事区分: personnelClass
  • 組合員区分: membershipClass
  • 海外赴任区分: abroadAssignedClass
  • 家族／単身区分: familySingleClass
  • 駐在区分: residentClass
  • 常勤区分: fulltimeClass
  • 組合専従区分: unionDedicatedClass
  • 有期雇用者区分: fixedTermEmploymentClass
  • 転勤区分: transferClass
  • 研修者区分: traineeClass
  • 職務異動事由区分: jobTransferReasonClass
  • ライン区分: lineClass
  • フレックス区分: flexClass
  • 予備01・区分: spareClass01
  • 予備02・区分: spareClass02
  • 予備03・区分: spareClass03
  • 予備04・区分: spareClass04
  • 予備05・区分: spareClass05
  • 予備06・区分: spareClass06
  • 予備07・区分: spareClass07
  • 予備08・区分: spareClass08
  • 予備09・区分: spareClass09
  • 予備10・区分: spareClass10
  • 予備（帳票用）01: spareFormCode01
  • 予備（帳票用）02: spareFormCode02
  • 予備（帳票用）03: spareFormCode03
  • 予備（帳票用）04: spareFormCode04
  • 予備（帳票用）05: spareFormCode05
  • ポジション: positionCode
  • 兼務自社他社区分: companyClass
  • 兼務種別区分: additionalType
  • 兼務主副区分: mainSubClass
query Parameters
types
string

マスタデータの種別。複数指定するときはカンマ区切りで指定してください。

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 1000 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

マスタデータを登録・更新する

マスタデータの種別を指定してマスタデータを登録します。
登録できるマスタデータの種別は以下になります。

  • 雇用区分: employmentType
  • 役職: jobTitle
  • 職種: jobCategory
  • 職務: jobDuty
  • 役割: jobRole
  • 等級A: gradeA
  • 等級B: gradeB
  • 等級C: gradeC
  • 担当エリア: area
  • 担当エリア分類区分01: areaType01
  • 担当エリア分類区分02: areaType02
  • 担当エリア分類区分03: areaType03
  • 担当エリア分類区分04: areaType04
  • 担当エリア分類区分05: areaType05
  • 異動区分: transferType
  • その他区分: otherType
  • 退職事由: retirementReason
  • 休職事由: leaveAbsenceReason
  • 出向先会社名: secondmentCompany
  • 出向先地域（エリア）: secondmentArea
  • 職掌: officialDuty
  • 職群: jobFamily
  • 勤務地: workplace
  • 部門: division
  • 選択項目 01: announcementItemSelect01
  • 選択項目 02: announcementItemSelect02
  • 選択項目 03: announcementItemSelect03
  • 選択項目 04: announcementItemSelect04
  • 選択項目 05: announcementItemSelect05
  • 選択項目 06: announcementItemSelect06
  • 会社: companyCode
  • 原価: costCode
  • 担当: chargeCode
  • 勤務シフト: workShiftCode
  • 就労: employmentCode
  • 管轄人事: personnelCode
  • 専門職: professionalCode
  • 社外肩書: externalTitleCode
  • 駐在所属: stayAffiliationCode
  • ジョブグレード: jobGrade
  • 専任ジョブ: dedicatedJobCode
  • 専任ジョブグレード: dedicatedJobGrade
  • 組合支部: unionBranchCode
  • 要員集計: personnelTallyCode
  • 計上部門: accountingDepartmentCode
  • 原籍会社: originalCompanyCode
  • 原籍所属: originalAffiliationCode
  • 原籍役職: originalJobTitleCode
  • 予備０１: spareCode01
  • 予備０２: spareCode02
  • 予備０３: spareCode03
  • 予備０４: spareCode04
  • 予備０５: spareCode05
  • 予備０６: spareCode06
  • 予備０７: spareCode07
  • 予備０８: spareCode08
  • 予備０９: spareCode09
  • 予備１０: spareCode10
  • 人事区分: personnelClass
  • 組合員区分: membershipClass
  • 海外赴任区分: abroadAssignedClass
  • 家族／単身区分: familySingleClass
  • 駐在区分: residentClass
  • 常勤区分: fulltimeClass
  • 組合専従区分: unionDedicatedClass
  • 有期雇用者区分: fixedTermEmploymentClass
  • 転勤区分: transferClass
  • 研修者区分: traineeClass
  • 職務異動事由区分: jobTransferReasonClass
  • ライン区分: lineClass
  • フレックス区分: flexClass
  • 予備01・区分: spareClass01
  • 予備02・区分: spareClass02
  • 予備03・区分: spareClass03
  • 予備04・区分: spareClass04
  • 予備05・区分: spareClass05
  • 予備06・区分: spareClass06
  • 予備07・区分: spareClass07
  • 予備08・区分: spareClass08
  • 予備09・区分: spareClass09
  • 予備10・区分: spareClass10
  • 予備（帳票用）01: spareFormCode01
  • 予備（帳票用）02: spareFormCode02
  • 予備（帳票用）03: spareFormCode03
  • 予備（帳票用）04: spareFormCode04
  • 予備（帳票用）05: spareFormCode05
  • ポジション: positionCode
  • 兼務自社他社区分: companyClass
  • 兼務種別区分: additionalType
  • 兼務主副区分: mainSubClass

新規で登録されたデータはマスタの最後尾に追加されます。
（画面上のマスタ一覧で最後尾に表示されます）

既存のマスタデータを更新する場合、画面上での表示位置は変更されません。

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

マスタデータを洗い替え登録する

マスタデータの種別を指定してマスタデータを洗い替えます。 洗い替えはリクエスト内で指定された、codeをキーに行われます。

typeで指定するマスタデータの種別によってオブジェクトの構造、必須の項目は異なります。

Request Body schema: application/json
Array of PositionMaster (object) or companyMaster (object) or originalCompanyMaster (object) or areaMaster (object)

Responses

Request samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "915957d9-0103-4721-b1ad-0f48b047e13b"
}

マスタデータ洗い替え登録のステータスを確認

operationId(UUID)を指定してマスタデータ洗い替え登録バッチのステータスを取得します。

path Parameters
operationId
required
string <uuid>

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

人事申請

各種申請をリストで取得する

filterDate について

例えば、「氏名変更申請」書の中から「戸籍名変更日」が 2021年7月1日 以降で入力されているものを抽出したいケースにご利用ください。 指定する項目 ID（itemId）は、「申請フォームの詳細を取得する」API で取得することができます。

query Parameters
status
string
Enum: "inProgress" "approved" "remand"

申請ステータス

  • inProgress: 申請中
  • approved: 承認済
  • remand: 差戻し
startApplicationDate
string

指定した日付以降に申請されたものに絞り込みます。

endApplicationDate
string

指定した日付以前に申請されたものに絞り込みます。

startApprovedDate
string

指定した日付以降に承認されたものに絞り込みます。

endApprovedDate
string

指定した日付以前に承認されたものに絞り込みます。

applicantEmployeeCode
string

申請者社員番号

formId
string
Example: formId=5001,5002

申請フォーム ID。カンマ区切りで複数指定することができます。

filterDate
string

任意の日付項目を対象に、指定した日付および比較演算子により情報に絞り込みます。指定できるパターンは以下の通りです。

  • "eq": 指定した日付時点で有効な情報に絞り込みます。
  • "le": 指定した日付以前で有効な情報に絞り込みます。
  • "ge": 指定した日付以降で有効な情報に絞り込みます。
  • "ge", "le": 指定した期間で有効な情報に絞り込みます。

例えば、住所変更申請にある「住民票異動予定日」項目が 2021/04/01, 2021/05/01, 2021/06/01 の 3 申請が登録されているとき、以下のように取得することができます。

  • filterDate[itemId]=665&filterDate[eq]=2021-06-01
    • 「住民票異動予定日」が 2021/06/01 のレコード 1 つを取得します。
  • filterDate[itemId]=665&filterDate[le]=2021-05-20
    • 「住民票異動予定日」が 2021/05/20 以前のものに絞り込むため、2021/04/01, 2021/05/01 のレコード 2 つを取得します。
  • filterDate[itemId]=665&filterDate[ge]=2021-05-20
    • 「住民票異動予定日」が 2021/05/20 以降のものに絞り込むため、2021/06/01 のレコード 1 つを取得します。
  • filterDate[itemId]=665&filterDate[ge]=2021-04-01&filterDate[le]=2021-06-01
    • 「住民票異動予定日」が 2021/04/01 ~ 2021/06/01 内のものに絞り込むため、 2021/04/01, 2021/05/01, 2021/06/01 のレコード 3 つを取得します。

項目を指定する際に key を利用することができます。この場合、以下のように itemId の代わりに key を指定してください。

例:

  • filterDate[key]=resident_register_date&filterDate[ge]=2021-04-01&filterDate[le]=2021-06-01
page
integer
Example: page=2

ページ番号

pageSize
integer
Example: pageSize=50

１ページで取得する件数

Responses

Response samples

Content type
application/json
{}

各種申請の詳細を取得する

path Parameters
applicationNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

申請フォームをリストで取得する

query Parameters
page
integer

ページ番号

pageSize
integer

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

申請フォームの詳細を取得する

path Parameters
id
required
string

申請フォーム ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

パーソナルプロファイル

項目定義を取得する

パーソナルプロファイルで利用可能な項目の定義をリストで取得します。

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

マスタデータをリストで取得する

パーソナルプロファイルで利用しているマスタデータをリストで取得します。

query Parameters
itemIds
string

項目 ID（カンマ区切りで複数指定可能）

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 1000 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

マスタデータを登録・更新する

マスタデータを登録・更新します。
テキストや日付で入力する項目などのマスタデータを持たない項目を指定した場合エラーを返します。

親マスタを持つマスタにコードを追加・更新する場合、parentCodeに親コードのコード番号を指定することでコードの親子関係を登録することができます。 コードを指定しない場合は親子関係は登録されません。

親マスタを持つマスタの例

  • 研修名称（親マスタ: 研修カテゴリ）
  • 免許名（親マスタ: 免許カテゴリ）
  • 資格名（親マスタ: 資格カテゴリ）

新規で登録されたデータはマスタの最後尾に追加されます。
（画面上のマスタ一覧で最後尾に表示されます）

既存のマスタデータを更新する場合、画面上での表示位置は変更されません。

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

社員情報をリストで取得する

query Parameters
categoryId
required
string

カテゴリ ID

filterEffectiveDate
object
Example: itemId=20001&ge=2021-06-01

任意の日付項目を対象に、指定した日付時点で有効な情報、または指定した期間における有効な情報に絞り込みます。現在、指定可能な演算子のパターンは以下の通りです。

  • "eq": 指定した日付時点で有効な情報に絞り込みます。
  • "le": 指定した日付以前で有効な情報に絞り込みます。
  • "ge": 指定した日付以降で有効な情報に絞り込みます。
  • "ge", "le": 指定した期間で有効な情報に絞り込みます。

例えば、給与情報の適用日が 2021/04/01, 2021/05/01, 2021/06/01 の 3 レコードが登録されているとき、以下のように取得することができます。

  • filterEffectiveDate[itemId]=20001&filterEffectiveDate[eq]=2021-05-20
    • 2021/05/20 時点で有効な情報として、適用日が 2021/05/01 のレコード 1 つを取得します。
  • filterEffectiveDate[itemId]=20001&filterEffectiveDate[le]=2021-05-20
    • 2021/05/20 以前で有効な情報として、適用日が 2021/04/01, 2021/05/01 のレコード 2 つを取得します。
  • filterEffectiveDate[itemId]=20001&filterEffectiveDate[ge]=2021-05-20
    • 2021/05/20 以降で有効な情報として、適用日が 2021/05/01, 2021/06/01 のレコード 2 つを取得します。
  • filterEffectiveDate[itemId]=20001&filterEffectiveDate[ge]=2021-04-20&filterEffectiveDate[le]=2021-05-20
    • 2021/04/20 〜 2021/05/20 で有効な情報として、適用日が 2021/04/01, 2021/05/01 のレコード 2 つを取得します。
fromUpdatedDate
string
Example: fromUpdatedDate=2021-07-01

更新日を対象に、指定した日付以降の情報に絞り込みます。

employeeCode
string

指定した社員番号に対応する社員のパーソナルプロファイルに絞って取得します。複数の社員番号で絞り込む場合は、社員番号をカンマで区切って指定してください。最大で100人分の社員の社員番号を同時に指定することができます。

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

社員情報の登録や更新

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
{
  • "isSuccess": true
}

カテゴリ内の社員情報を削除

社員番号または社員IDで指定された社員を対象にカテゴリ内の社員情報を削除します。基本情報（カテゴリID: 1000）と雇用契約（カテゴリID: 15000）のみ削除できません。

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

社員情報の洗い替え

現在登録されているパーソナルプロファイルのデータをリクエスト内のデータで洗い替えます。

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
{
  • "isSuccess": true
}

給与・賞与

給与情報を登録する

Request Body schema: application/json
Array of objects (PayrollSalarySplipPost)

Request samples

Content type
application/json
{
  • "data": [
    ]
}

賞与情報を登録する

Request Body schema: application/json
object (PayrollBonusSlipPost)

Request samples

Content type
application/json
{
  • "data": {
    }
}

年末徴収票を登録

Responses

スキルチェック

シート情報をリストで取得する

スキルチェックのシート情報をリストで取得します。

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{}

チェックシートの詳細（設問項目）を取得する

id で指定したスキルチェックシートの詳細情報を取得します。シート内に設定された設問項目リストを取得することができます。

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

スキルチェックのレベルレンジ設定を取得する

id で指定したスキルチェックシートのレベルレンジ設定を取得します。

path Parameters
id
required
string
query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

スキルチェックの回答結果を取得する

id で指定したスキルチェックシートに関連する回答結果を取得します。承認済みで結果が確定したものを対象に取得します。 なお、回答結果はスキルチェックデータの新しい順に取得します。

path Parameters
id
required
string
query Parameters
startApprovedDate
string

指定した日付以降に承認されたものに絞り込みます。

endApprovedDate
string

指定した日付以前に承認されたものに絞り込みます。

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

スキルチェックの回答結果サマリーを取得する

id で指定したスキルチェックシートに関連する回答結果のサマリーを取得します。承認済みで結果が確定したものを対象に取得します。 小項目、中項目単位で集計した結果を取得することができます。 なお、回答結果はスキルチェックデータの新しい順に取得します。

path Parameters
id
required
string
query Parameters
unit
integer
Default: 1
Enum: 1 2
Example: unit=1

集計の単位（1: 小項目単位、2: 中項目単位）

startApprovedDate
string

指定した日付以降に承認されたものに絞り込みます。

endApprovedDate
string

指定した日付以前に承認されたものに絞り込みます。

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

キャリアプラン

フォームをリストで取得する

フォーム情報をリストで取得します。

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

フォームを作成する

フォーム情報を登録します。

Request Body schema: application/json
object (CareerPlanFormPost)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

フォームを更新する

フォーム情報を更新します。

path Parameters
id
required
string
Request Body schema: application/json
object (CareerPlanFormPut)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

削除する

フォーム情報を削除します。削除そ実行すると、回答情報も削除されるため、ご注意ください。

path Parameters
id
required
string

Responses

フォーム内の項目をリストで取得する

設問項目をリストで取得します。

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

フォーム内の項目を保存する

id で指定されたフォームに、設問項目を登録します。

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

回答内容をリストで取得する

回答内容をリストで取得します。

query Parameters
formId
required
string

フォーム ID

targetDate
string

対象日（指定した日付時点で最新の回答内容を取得します。）

employeeCode
string

社員番号（指定した社員の回答内容を取得します。employeeIdと同時に利用することは出来ません。）

employeeId
string

社員ID（指定した社員の回答内容を取得します。employeeCode と同時に利用することはできません。）

page
integer
Example: page=3

ページ番号

pageSize
integer [ 1 .. 100 ]
Example: pageSize=100

1ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

回答内容を登録する

回答内容を登録します。

Request Body schema: application/json
Array of objects

Request samples

Content type
application/json
{
  • "data": [
    ]
}

通知

通知メッセージを登録する

Request Body schema: application/json
Array of objects (NotificationPost)

Responses

Request samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

通知メッセージを削除する

配列で通知 id を指定します。 対象の通知を一括で削除します。

Request Body schema: application/json
data
Array of strings

通知 id

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

アカウント

アカウント情報をリストで取得する

アカウント情報をリストで取得します。

query Parameters
page
string

ページ番号

pageSize
string

１ページで取得する件数

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {},
  • "data": [
    ]
}

アカウント情報を登録する

アカウント情報をリストで登録します。

このAPIはシングルサインオン(SSO)ユーザーの利用を想定しています。パスワードはサーバー側で自動的に設定されます。

Request Body schema: application/json
Array of objects (UserPost)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

アカウント情報を削除する

リストで指定したアカウント情報を削除します。

Request Body schema: application/json
data
Array of strings

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

アカウント情報登録のステータスを確認

operationId(UUID)を指定してアカウント情報登録バッチのステータスを取得します。

path Parameters
operationId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

権限

サービスへのアクセス可否情報を取得する

path Parameters
employeeId
required
string

社員 ID

serviceId
required
string

サービス ID

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

権限設定をリストで取得する

query Parameters
status
string
Enum: "active" "deactive"

ステータス

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

権限の適用者をリストで取得する

path Parameters
policyId
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

サービスへアクセス可能な社員をリストで取得する

path Parameters
serviceId
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

指定した社員の権限を取得する

path Parameters
employeeId
required
string
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Job

ジョブディスクリプションを一覧で取得する

query Parameters
page
integer
Example: page=3

ページ番号

pageSize
integer
Example: pageSize=100

１ページで取得する件数

fromUpdatedDate
string <date>
Example: fromUpdatedDate=2025-02-20

指定した日付以降に更新があったものに絞り込みます。

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

ジョブディスクリプションを登録する

Request Body schema: application/json
object (JobDescriptionPost)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ジョブディスクリプションを削除する

path Parameters
code
required
string

ジョブディスクリプションコード

startDate
required
string

開始日

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

ジョブディスクリプションを更新する

path Parameters
code
required
string

ジョブディスクリプションコード

startDate
required
string

開始日

Request Body schema: application/json
object (JobDescriptionPut)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ジョブディスクリプションの詳細を取得する

path Parameters
code
required
string

ジョブディスクリプションコード

startDate
required
string

開始日

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

ジョブファミリー・グループを取得する

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

ジョブファミリー・グループを洗い替え登録する

Request Body schema: application/json
Array of objects (JobFamilyGroup)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

ジョブファミリーを取得する

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

ジョブファミリーを洗い替え登録する

Request Body schema: application/json
Array of objects (JobFamily)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

ジョブレベルを取得する

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "pagination": {
    },
  • "data": [
    ]
}

ジョブレベルを洗い替え登録する

Request Body schema: application/json
Array of objects (JobLevel)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}