API docs by Redocly

G-COMPATH 公開API仕様 (2.0.0)

Download OpenAPI specification:Download

連絡先: g-compath@sun-m.co.jp License: プライバシーポリシー

G-COMPATHのREST APIを使い、各種データの取得が行えます。
APIの利用・認証には、あらかじめAPIキーを発行する必要があります。
APIキーは、G-COMPATHの個人設定から発行できます。

認証

クエリパラメータapikeyに発行されたAPIキーを付与することで認証を行うことができます。

例：

  • 社員情報を取得したい場合
    curl https://[spaceId].g-compath.com/public-api/accounts?apikey=[APIキー]

クエリパラメータ

クエリパラメータで検索条件を指定することも可能です。 クエリパラメータはキー、値ともに大文字と小文字を区別します。

社員情報

accounts

社員情報取得

指定した条件に合致する社員情報を取得できます。

query Parameters
name
string

社員名を指定します。(部分一致検索)

mailAddress
string <email>

社員のメールアドレスを指定します。（完全一致検索）

employeeCode
string

社員番号/コードを指定します。（完全一致検索）

employedAtFrom
string or null <date-time>

入社日の範囲のうち、始まりの日付を指定します。(例：employedAtFrom=2023-04-01)

employedAtTo
string or null <date-time>

入社日の範囲のうち、終わりの日付を指定します。(例：employedAtTo=2023-04-01)

departmentDisplayName
string

部門表示名を指定します。(部分一致検索)

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

キャリアパス

career-path

キャリアパス取得

指定した条件に合致するキャリアパス取得を取得できます。

query Parameters
careerPath
string

キャリアパス名を指定します。(部分一致検索)

roleName
string

役割名を指定します。(部分一致検索)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

取得資格

certifications

取得資格取得

指定した条件に合致する取得済みの資格を取得できます。

query Parameters
certifierName
string

資格団体名を指定します。(部分一致検索)

certificationName
string

資格名を指定します。(部分一致検索)

certifiedAtFrom
string or null <date-time>

資格取得日の範囲のうち、始まりの日付を指定します。(例：certifiedAtFrom=2023-04-01)

certifiedAtTo
string or null <date-time>

資格取得日の範囲のうち、終わりの日付を指定します。(例：certifiedAtTo=2023-04-01)

name
string

社員名を指定します。(部分一致検索)

employeeCode
string

社員番号/コードを指定します。（完全一致検索）

mailAddress
string <email>

社員のメールアドレスを指定します。（完全一致検索）

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

組織情報

departments

組織情報取得

指定した条件に合致する組織情報を取得できます。

query Parameters
departmentName
string

部門名を指定します(部分一致検索)。

departmentDisplayName
string

部門表示名を指定します(部分一致検索)。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

自己評価結果

diagnosis

自己評価結果取得

指定した条件に合致する最新の自己評価結果を取得できます。

query Parameters
diagnosisAt
string or null <date-time>

指定した日付けまでの最新の自己評価結果を検索します。 (例：diagnosisAt=2023-04-01)

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

知識評価結果

knowledge

知識評価結果取得

指定した条件に合致する最新の知識評価結果を取得できます。

query Parameters
divideAt
string or null <date-time>

指定した日付けまでの最新の知識評価結果を検索します。 (例：divideAt=2023-04-01)

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

知識評価値

knowledge-tasks

知識評価値取得

指定した条件に合致する知識評価値を取得できます。

query Parameters
name
string

社員名を指定します。(部分一致検索)

mailAddress
string <email>

社員のメールアドレスを指定します。（完全一致検索）

employeeCode
string

社員番号/コードを指定します。（完全一致検索）

divideAt
string or null <date-time>

指定した日付までの最新知識評価値を取得できる。(例：divideAt=2023-04-01)

type
string

出力形式を指定します。評価項目レベル、もしくは小分類レベルの知識評価値一覧を指定します。
item（デフォルト）: 評価項目レベルの知識評価値一覧を指定。
category: 小項目レベルの知識評価値一覧を指定。

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

自己評価回答

replies

自己評価回答取得

指定した条件に合致する自己評価回答を取得できます。

query Parameters
name
string

社員名を指定します。(部分一致検索)

employeeCode
string

社員番号/コードを指定します。（完全一致検索）

mailAddress
string <email>

社員のメールアドレスを指定します。（完全一致検索）

repliedAt
string or null <date-time>

指定した日付までの最新回答値を取得できる。(例：repliedAt=2023-04-01)

type
string

回答一覧の出力形式を指定します。
item（デフォルト）: 評価項目レベルの回答一覧を指定。
category: 小分類レベルの回答一覧を指定。
m-category: 中分類レベルの回答一覧を指定。

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

役割タスク

role-tasks

役割タスク取得

指定した条件に合致する役割タスクを取得できます。

query Parameters
dictionaryName
string

辞書名を指定します。(部分一致検索)

roleName
string

役割名を指定します。(部分一致検索)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

受講研修

trainings

受講研修取得

指定した条件に合致する受講済みの研修を取得できます。

query Parameters
name
string

社員名を指定します。(部分一致検索)

employeeCode
string

社員番号/コードを指定します。（完全一致検索）

mailAddress
string <email>

社員のメールアドレスを指定します。（完全一致検索）

trainingInstituteName
string

研修団体名を指定します。(部分一致検索)

trainingName
string

研修名を指定します。(部分一致検索)

trainedAtFrom
string or null <date-time>

研修受講日の範囲のうち、始まりの日付を指定します。(例：trainedAtFrom=2023-04-01)

trainedAtTo
string or null <date-time>

研修受講日の範囲のうち、終わりの日付を指定します。(例：trainedAtTo=2023-04-01)

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

自己評価スキル回答

skill-reply

自己評価スキル回答取得

指定した条件に合致する自己評価スキル回答を取得できます。

query Parameters
name
string

社員名を指定します。(部分一致検索)

employeeCode
string

社員番号/コードを指定します。（完全一致検索）

mailAddress
string <email>

社員のメールアドレスを指定します。（完全一致検索）

repliedAt
string or null <date-time>

指定した日付までの最新回答値を取得できる。(例：repliedAt=2023-04-01)

includeResigned
string

退職者を含めるか指定します。
true: 退職者を含むすべての社員。
false（デフォルト）: 現在在籍している社員のみ。

Responses

Response samples

Content type
application/json
[
  • {
    }
]