YESOD API (1.0.0)

Download OpenAPI specification:

利用方法

YESODからAPIキーを取得します。[設定] > [APIトークン]にてキーを発行してください
Authorizationヘッダーに Bearer {取得したキー} の形でAPIキーを設定をし、リクエストを送ります

AC

アカウントコントロール関連で利用可能なAPI

権限セットの照会

ユーザは、本日時点で選択可能な権限セットをYESODから照会する

Authorizations:

Bearer

query Parameters

date	string <date> 照会日付（yyyy-MM-dd形式）。指定がない場合は本日

Responses

Response samples

200

Content type

application/json

{"authority": {"name": "string",
"code": "string",
"members": [{ }
],
"companies": [{ }
],
"organizations": [{ }
],
"projects": [{ }
]
},
"connections": [{"connection": {"name": "string",
"code": "string"
},
"roles": [{"name": "string",
"code": "string"
}
]
}
]
}

タスク照会API

役割変更データの照会。ユーザの属性や、所属する組織、プロジェクト等の変更に伴う、関連付けられる業務アセットとその役割の変更タスクを照会する。

Authorizations:

Bearer

query Parameters

from required	string <date> Example: from=2024-03-01 値の取得開始する実日付。この実日付以降にYESOD内の変更に対し、タスクを生成する
days	integer Default: 7 取得する日数

Responses

Response samples

200

Content type

application/json

{"tasks": [{"task": {"id": "string",
"applicationDate": "2019-08-24",
"status": "string",
"taskNumber": "string",
"changeDate": "2019-08-24"
},
"changeRequest": {"id": "string",
"approvedAt": "2019-08-24T14:15:22Z",
"name": "string"
},
"member": {"date": "2019-08-24",
"id": "string",
"type": "string",
"name": "string",
"email": "string",
"identificationNumber": "string",
"attributes": [{"entityId": "string",
"entityType": "string",
"dataType": "string",
"attributeId": "string",
"attributeLabel": "string",
"connectionAttributeKey": "string",
"value": "string"
}
]
},
"companies": [{"id": "string",
"type": "string",
"name": "string",
"depth": 0,
"code": "string",
"employeeNumber": "string",
"attributes": [{"entityId": "string",
"entityType": "string",
"dataType": "string",
"attributeId": "string",
"attributeLabel": "string",
"connectionAttributeKey": "string",
"value": "string"
}
]
}
],
"organizations": [{"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0,
"attributes": [{"entityId": "string",
"entityType": "string",
"dataType": "string",
"attributeId": "string",
"attributeLabel": "string",
"connectionAttributeKey": "string",
"value": "string"
}
],
"parent": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0
}
}
],
"offices": [{"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0,
"attributes": [{"entityId": "string",
"entityType": "string",
"dataType": "string",
"attributeId": "string",
"attributeLabel": "string",
"connectionAttributeKey": "string",
"value": "string"
}
]
}
],
"projects": [{"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0,
"attributes": [{"entityId": "string",
"entityType": "string",
"dataType": "string",
"attributeId": "string",
"attributeLabel": "string",
"attributeExpression": "string",
"connectionAttributeKey": "string",
"value": "string"
}
],
"parent": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0
}
}
],
"connection": {"id": "string",
"type": "string",
"name": "string",
"code": "string"
},
"staffs": [{"id": "string",
"name": "string",
"email": "string",
"type": "member"
}
],
"action": {"type": "grant",
"allocation": {"id": "string",
"name": "string",
"integrationType": "account"
},
"roles": [{"id": "string",
"code": "string",
"name": "string",
"priority": 0
}
]
},
"relatedTasks": [{"task": {"id": "string",
"taskNumber": "string"
},
"relation": {"code": "0001",
"message": "string"
}
}
],
"job": {"id": "string",
"status": "string",
"message": "string"
}
}
]
}

タスクの完了書き戻し

変更情報をYESODに書き戻す。タスクの完了及びスキップ処理が可能。

Authorizations:

Bearer

path Parameters

taskId

required

string

タスクID(3qb4SOYJVeOwvMdpTrvhKA 等) もしくは、タスク番号 (2) 完了情報の書き戻し先のタスクを指定するID

Request Body schema: application/json
required

status

required

string

Enum: "done" "skip"

タスクの状態(done: 変更処理を行った場合, skip: 変更処理を行わなかった場合)

Responses

Request samples

Payload

Content type

application/json

{"status": "done"
}

Response samples

200

Content type

application/json

{"success": true
}

メンバーに関連づく業務アセットと役割の照会

社員番号をキーに、メンバーに関連づく業務アセットと役割を照会する

Authorizations:

Bearer

query Parameters

employeeNumber required	string 社員を検索する社員番号
date	string <date> 値を取得する日付

Responses

Response samples

200

Content type

application/json

{"member": {"date": "2019-08-24",
"id": "string",
"type": "string",
"name": "string",
"email": "user@example.com",
"companies": [{"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0,
"employeeNumber": "string"
}
],
"identificationNumber": "string"
},
"authorities": [{"authority": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"generateTasks": true,
"checkAttributeAvailabilities": [ ]
},
"relations": [{"type": "member",
"name": "string",
"code": "string"
}
],
"connections": [{"connection": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"staffs": [ ],
"generateTasks": true,
"shiftAuthority": {"start": 0,
"end": 0
}
},
"roles": [{"code": "string",
"name": "string"
}
]
}
]
}
],
"expectedRoles": [{"connection": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"staffs": [ ],
"generateTasks": true,
"shiftAuthority": {"start": 0
}
},
"role": {"code": "string",
"name": "string"
}
}
]
}

プロジェクトに関連づく業務アセットと役割の照会

ユーザは、本日時点で選択可能なプロジェクトをYESODから照会し、そのプロジェクトが持つ業務アセットと役割の情報を取得する

Authorizations:

Bearer

query Parameters

date	string <date> 照会日付（yyyy-MM-dd形式）。指定がない場合は本日

Responses

Response samples

200

Content type

application/json

{"project": {"date": "2019-08-24",
"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0,
"attributes": [{"entityId": "string",
"entityType": "string",
"dataType": "string",
"attributeId": "string",
"attributeLabel": "string",
"value": "string"
}
],
"parent": {"date": "2019-08-24",
"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0
}
},
"authorities": [{"authority": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"generateTasks": true,
"checkAttributeAvailabilities": ["string"
]
},
"relations": [{"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0,
"parent": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"depth": 0
}
}
],
"connections": [{"connection": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"staffs": ["string"
],
"generateTasks": true,
"shiftAuthority": {"start": 0,
"end": 0
}
},
"roles": [{"id": "string",
"code": "string",
"name": "string",
"priority": 0
}
]
}
]
}
],
"expectedRoles": [{"connection": {"id": "string",
"type": "string",
"name": "string",
"code": "string",
"staffs": ["string"
],
"generateTasks": true,
"shiftAuthority": {"start": 0
}
},
"role": {"id": "string",
"code": "string",
"name": "string",
"priority": 0
}
}
]
}

業務アセットに割り当てられているメンバの照会

業務アセットに割り当てられているメンバ一覧を出力します。指定された業務アセットに割り当てられていないメンバは出力されません。業務アセットのIDで割り当てられているメンバを絞り込むことができます。業務アセットIDを指定しない場合は全ての業務アセットについてメンバを出力します。

Authorizations:

Bearer

query Parameters

assetId

string

業務アセットID。指定しない場合は全ての業務アセットについてメンバを出力

Responses

Response samples

200

Content type

application/json

{"members": [{"date": "2019-08-24",
"id": "string",
"type": "member",
"name": "string",
"email": "string",
"identificationNumber": "string",
"companies": [{"id": "string",
"type": "company",
"name": "string",
"depth": 0,
"employeeNumber": "string"
}
],
"organizations": [{"id": "string",
"type": "organization",
"name": "string",
"depth": 0
}
],
"offices": [{"id": "string",
"type": "office",
"name": "string",
"depth": 0
}
],
"projects": [{"id": "string",
"type": "project",
"name": "string",
"depth": 0
}
],
"assets": [{"id": "string",
"type": "asset",
"name": "string",
"attributes": {"userName": "hideyuki.takeuchi",
"name.familyName": "田中",
"name.givenName": "秀行",
"emails[0].primary": "true",
"emails[0].value": "hideyuki.takeuchi@yesod.co"
},
"allocations": [{"id": "string",
"name": "string",
"items": [{"id": "string",
"name": "string",
"code": "string"
}
]
}
]
}
]
}
]
}

「同期する項目」をYESODからSaaSに同期

指定したassetIdの業務アセットについて、「同期する項目」のSaaSへの同期を手動で実行する非同期処理をリクエストします。

Authorizations:

Bearer

Request Body schema: application/json

assetId required	string 業務アセットのID。指定されたIDに紐づく業務アセットで、SaaSへの項目の同期を実行します。
force	boolean Default: false 強制的に同期を実行するかどうかのフラグ。 trueの場合、設定で「項目の同期を有効にする」をOFFにしている場合でも強制的に同期処理を実行します。 falseの場合、設定で「項目の同期を有効にする」をOFFにしている業務アセットを指定した場合はエラーになります。

Responses

Request samples

Payload

Content type

application/json

{"assetId": "RoTNF8HaSHym_FOskaLN1",
"force": false
}

Response samples

200

Content type

application/json

{"jobId": "CXAKoR_rTgKkxrLttTTAs"
}

DS

ディレクトリサービス関連で利用可能なAPI

グループAPI

グループ（会社・組織・事業所・プロジェクト）の一覧を取得します。

Authorizations:

Bearer

query Parameters

groupType

required

string

Enum: "company" "organization" "office" "project"

Example: groupType=company

取得対象のグループ指定。以下のいずれかの値を指定してください。

company：会社の一覧を取得します。
organization：組織の一覧を取得します。
office：オフィスの一覧を取得します。
project：プロジェクトの一覧を取得します。

date

string <date>

Example: date=2018-09-13

値を取得する基準日の指定。（yyyy-MM-dd形式）指定された基準日におけるグループの情報を取得します。基準日を指定しない場合は、現在日が基準日になります。

Responses

Response samples

200

Content type

application/json

{"date": "2024-04-01",
"groups": [{"entityId": "laB5U5NcQBy5ZO68x03uug",
"name": "string",
"attributes": [{"attributeId": "tcEh9H5iRyaAFlTZ0XMnpA",
"attributeLabel": "string",
"values": [{"setId": "D-PYos91TWab0lVomMWD2w",
"validStart": "2022-12-01",
"validEnd": "2022-12-31",
"value": "string"
}
]
}
],
"children": [{"entityId": "laB5U5NcQBy5ZO68x03uug",
"name": "string",
"attributes": [{"attributeId": "tcEh9H5iRyaAFlTZ0XMnpA",
"attributeLabel": "string",
"values": [{"setId": "D-PYos91TWab0lVomMWD2w",
"validStart": "2022-12-01",
"validEnd": "2022-12-31"
}
]
}
]
}
]
}
]
}

属性一覧取得

ロールに基づき「書き込み可能」な項目のみについて、項目ID・ラベル（日本語/英語）・参照種別・データ型を返します。

Authorizations:

Bearer

Responses

Response samples

200

Content type

application/json

[{"attributeId": "z6JbmwvYQcO5BKnec_FVAA",
"attributeLabel": {"ja_JP": "姓",
"en_US": "Family Name (Local)"
},
"referenceType": null,
"dataType": "TEXT"
},
{"attributeId": "D-SLjXIv1nQsi_LQ66l6ffog",
"attributeLabel": {"ja_JP": "名",
"en_US": "Given Name (Local)"
},
"referenceType": null,
"dataType": "TEXT"
}
]

組織・会社・事業所・プロジェクトのインポート

CSV ファイルからインポートします

全てのoptionsをリクエストボディへ指定した例:

{
  "csv": "メールアドレス,所属組織,所属組織における役職,所属事業所,所属プロジェクト\nyesod.taro@example.com,YESOD Holdings/Corporate+YESOD Holdings/YESOD,代表+一般,東京オフィス,YESODプロジェクト",
  "options": {
    "mapping": "email: メールアドレス\norganization: 所属組織\nrole: 所属組織における役職\noffice: 所属事業所\nproject: 所属プロジェクト",
    "optionMapping": "代表: 組織長\n一般: メンバー",
    "applicationName": "2023年4月入社",
    "changeDate": "2025-04-01",
    "tierSeparator": "/",
    "referenceSeparator": "+",
    "companyEntityId": "JiKyiXoBSeOV0r_DhlgqAA",
    "rootCompanyEntityId": "JiKyiXoBSeOV0r_DhlgqAA",
    "rootOrganizationEntityId": "tMWLbAIASOmrCRHRgBT8GA",
    "rootOfficeEntityId": "AzOThNSzRMWjlxvD9CLHeQ",
    "rootProjectEntityId": "CPehjvCKRjaaMAjmdIYQ9w",
    "retireUnlisted": true,
    "avoidUnlistedEmails": "example@example.com",
    "waitForLock": true
  }
}

インポート時の名寄キー項目について

以下の項目の一致を順に確認し、一致すれば情報を更新します。一致しない場合新規登録が行われます。

社員 ID（会社横断の固有の ID）：identificationNumber
社員番号：employeeNumber
メールアドレス：email

入社日および変更日、退社日について

未入社の従業員が、YESOD 上に登録されていなければ、指定された入社日で情報が取り込まれます。
既に従業員が登録されている場合は、changeDate が指定されていればその日付で、指定されていなければ API が実行された日付を基準にして、属性情報を更新します。
退社日が設定されている場合は、その日付で退職予約が行われ、それ以降の属性情報の更新は行われなくなります。

更新される情報について

承認申請には、CSV に記載された情報と YESOD のデータベース上の差分のみ含まれます。変更がない項目については無視されます。

Node.js で API からメンバーをインポートする例

const axios = require('axios');

const YESOD_API_TOKEN = '<YESOD_API_TOKEN>';

const csv = `
従業員番号,メールアドレス,姓,名,所属組織1,所属組織2,所属会社
Y001,yesod.taro@example.com,イエソド,太郎,イエソド,営業部,株式会社イエソド
Y002,yesod.jiro@example.com,イエソド,次郎,イエソド,開発部,株式会社イエソド
`.trim();

const mapping = `
identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier}
company: 所属会社
`.trim();

const optionMapping = undefined;

const data = {
  csv: csv,
  options: {
    changeDate: '2021-11-01',
    mapping: mapping,
  },
};

const options = {
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer ' + YESOD_API_TOKEN,
  },
};

axios
  .post('https://yesod.io/api/v21.07/members/import', data, options)
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.log(error.response.data.messages);
  });

マッピングファイルの記載方法

オプションの mapping で CSV の 1 行目の項目名と、YESOD の属性とをマッピングできます。

mapping の記述方法

YESODの属性ID: CSVの項目名 [{ref}/{tier}]

会社、組織、事業所、プロジェクト項目の記述の最後に 「{tier}」 を追記することで、組織の項目の後ろの連番が階層を意味します。

mapping

organization: 所属組織 {tier}

csv の項目

所属組織1　・・・　第1階層の組織
所属組織2　・・・　第2階層の組織
所属組織3　・・・　第3階層の組織

会社、組織、事業所、プロジェクト項目の記述の最後に 「{ref}」 を追記することで、組織の項目の後ろの連番が所属の複数の所属を意味します。

mapping

organization: 所属組織 {ref}

csv の項目

所属組織1　・・・　１つ目の所属組織
所属組織2　・・・　2つ目の所属組織
所属組織3　・・・　3つ目の所属組織

サンプル

enterDate: 入社日
retireDate: 退社日
company: 所属法人
organization: 所属組織
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名

上記以外のマッピング属性の ID 名については、イエソド社の営業までお問い合わせください。

複数の所属会社や、所属組織情報の登録

複数の所属会社や、所属組織を登録する場合、CSV の形式に合わせて取り込む事ができます。
mapping の「{ref}」「{tier}」の指定、option の「referenceSeparator」、「tierSeparator」を組み合わせることで様々なフォーマットに対応できます。
所属組織における属性情報も所属と同様に表現する必要があります。

パターン１

1つのセルに、所属組織の階層と、複数の組織に所属している状態が表現されている場合

所属組織	役職
YESOD 営業部営業 1 課 / YESOD 管理部経理課	組織長 / メンバー

例) option 設定

tierSeparator:  (半角スペース)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

パターン２

1つのセル組織の階層が表現されており、複数の組織所属している場合、所属毎に項目が分かれている場合

所属組織 1	所属組織 2	役職 1	役職 2
YESOD 営業部営業 1 課	YESOD 管理部経理課	組織長	メンバー

例) option 設定

tierSeparator:  (半角スペース)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {ref}
company: 所属会社 {ref}

パターン３

組織の階層毎にセルが分かれている、なおかつ複数の組織に所属している場合にも、その所属毎にセルが分かれている場合

所属組織 1 1	所属組織 1 2	所属組織 1 3	所属組織 2 1	所属組織 2 2	所属組織 2 3	役職 1	役職 2
YESOD	営業部	営業 1 課	YESOD	管理部	経理課	組織長	メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier} {ref}
company: 所属会社

パターン４

複数の組織に所属しており、各所属組織の最下層のみが存在し、分かれている場合(別途先にグループ階層の取り込みが必要)

所属組織 1	所属組織 2
営業 1 課	経理課

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {ref}
company: 所属会社

パターン５

組織の階層ごとに項目が分かれており、1つのセルの中に複数の組織に所属している（兼務）ことが表現されている場合

所属組織 1	所属組織 2	所属組織 3	役職
YESOD / YESOD	営業部 / 管理部	営業 1 課 / 経理課	組織長 / メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier}
company: 所属会社

パターン６

1つのセルに複数の所属している最下層の組織のみが表現されている場合(別途先にグループ階層の取り込みが必要)

所属組織	役職
営業 1 課 / 経理課	組織長 / メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

パターン７

一人の所属情報が複数行に別れている場合

所属組織	役職
YESOD / 営業部 / 営業 1 課	組織長
YESOD / 管理部 / 経理課	メンバー

例) option 設定

tierSeparator: /
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

Authorizations:

Bearer

Request Body schema: multipart/form-data
required

csv required	string <binary> インポートするCSVデータ
required	object インポート時のオプション設定

Responses

Response samples

200

Content type

application/json

{ }

組織・会社・事業所・プロジェクトのインポート(インポートと同時に承認)

CSVファイルからインポートし、同時に承認を実行します。
詳細は組織・会社・事業所・プロジェクトのインポートを参照してください。

Authorizations:

Bearer

Request Body schema: multipart/form-data
required

csv required	string <binary> インポートするCSVデータ
required	object インポート時のオプション設定

Responses

Response samples

200

Content type

application/json

{ }

従業員情報のインポート

CSV ファイルからインポートします

全てのoptionsをリクエストボディへ指定した例:

{
  "csv": "メールアドレス,所属組織,所属組織における役職,所属事業所,所属プロジェクト\nyesod.taro@example.com,YESOD Holdings/Corporate+YESOD Holdings/YESOD,代表+一般,東京オフィス,YESODプロジェクト",
  "options": {
    "mapping": "email: メールアドレス\norganization: 所属組織\nrole: 所属組織における役職\noffice: 所属事業所\nproject: 所属プロジェクト",
    "optionMapping": "代表: 組織長\n一般: メンバー",
    "applicationName": "2023年4月入社",
    "changeDate": "2025-04-01",
    "tierSeparator": "/",
    "referenceSeparator": "+",
    "companyEntityId": "JiKyiXoBSeOV0r_DhlgqAA",
    "rootCompanyEntityId": "JiKyiXoBSeOV0r_DhlgqAA",
    "rootOrganizationEntityId": "tMWLbAIASOmrCRHRgBT8GA",
    "rootOfficeEntityId": "AzOThNSzRMWjlxvD9CLHeQ",
    "rootProjectEntityId": "CPehjvCKRjaaMAjmdIYQ9w",
    "retireUnlisted": true,
    "avoidUnlistedEmails": "example@example.com",
    "waitForLock": true
  }
}

インポート時の名寄キー項目について

以下の項目の一致を順に確認し、一致すれば情報を更新します。一致しない場合新規登録が行われます。

社員 ID（会社横断の固有の ID）：identificationNumber
社員番号：employeeNumber
メールアドレス：email

入社日および変更日、退社日について

未入社の従業員が、YESOD 上に登録されていなければ、指定された入社日で情報が取り込まれます。
既に従業員が登録されている場合は、changeDate が指定されていればその日付で、指定されていなければ API が実行された日付を基準にして、属性情報を更新します。
退社日が設定されている場合は、その日付で退職予約が行われ、それ以降の属性情報の更新は行われなくなります。

更新される情報について

承認申請には、CSV に記載された情報と YESOD のデータベース上の差分のみ含まれます。変更がない項目については無視されます。

Node.js で API からメンバーをインポートする例

const axios = require('axios');

const YESOD_API_TOKEN = '<YESOD_API_TOKEN>';

const csv = `
従業員番号,メールアドレス,姓,名,所属組織1,所属組織2,所属会社
Y001,yesod.taro@example.com,イエソド,太郎,イエソド,営業部,株式会社イエソド
Y002,yesod.jiro@example.com,イエソド,次郎,イエソド,開発部,株式会社イエソド
`.trim();

const mapping = `
identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier}
company: 所属会社
`.trim();

const optionMapping = undefined;

const data = {
  csv: csv,
  options: {
    changeDate: '2021-11-01',
    mapping: mapping,
  },
};

const options = {
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer ' + YESOD_API_TOKEN,
  },
};

axios
  .post('https://yesod.io/api/v21.07/members/import', data, options)
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.log(error.response.data.messages);
  });

マッピングファイルの記載方法

オプションの mapping で CSV の 1 行目の項目名と、YESOD の属性とをマッピングできます。

mapping の記述方法

YESODの属性ID: CSVの項目名 [{ref}/{tier}]

会社、組織、事業所、プロジェクト項目の記述の最後に 「{tier}」 を追記することで、組織の項目の後ろの連番が階層を意味します。

mapping

organization: 所属組織 {tier}

csv の項目

所属組織1　・・・　第1階層の組織
所属組織2　・・・　第2階層の組織
所属組織3　・・・　第3階層の組織

会社、組織、事業所、プロジェクト項目の記述の最後に 「{ref}」 を追記することで、組織の項目の後ろの連番が所属の複数の所属を意味します。

mapping

organization: 所属組織 {ref}

csv の項目

所属組織1　・・・　１つ目の所属組織
所属組織2　・・・　2つ目の所属組織
所属組織3　・・・　3つ目の所属組織

サンプル

enterDate: 入社日
retireDate: 退社日
company: 所属法人
organization: 所属組織
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名

上記以外のマッピング属性の ID 名については、イエソド社の営業までお問い合わせください。

複数の所属会社や、所属組織情報の登録

複数の所属会社や、所属組織を登録する場合、CSV の形式に合わせて取り込む事ができます。
mapping の「{ref}」「{tier}」の指定、option の「referenceSeparator」、「tierSeparator」を組み合わせることで様々なフォーマットに対応できます。
所属組織における属性情報も所属と同様に表現する必要があります。

パターン１

1つのセルに、所属組織の階層と、複数の組織に所属している状態が表現されている場合

所属組織	役職
YESOD 営業部営業 1 課 / YESOD 管理部経理課	組織長 / メンバー

例) option 設定

tierSeparator:  (半角スペース)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

パターン２

1つのセル組織の階層が表現されており、複数の組織所属している場合、所属毎に項目が分かれている場合

所属組織 1	所属組織 2	役職 1	役職 2
YESOD 営業部営業 1 課	YESOD 管理部経理課	組織長	メンバー

例) option 設定

tierSeparator:  (半角スペース)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {ref}
company: 所属会社 {ref}

パターン３

組織の階層毎にセルが分かれている、なおかつ複数の組織に所属している場合にも、その所属毎にセルが分かれている場合

所属組織 1 1	所属組織 1 2	所属組織 1 3	所属組織 2 1	所属組織 2 2	所属組織 2 3	役職 1	役職 2
YESOD	営業部	営業 1 課	YESOD	管理部	経理課	組織長	メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier} {ref}
company: 所属会社

パターン４

複数の組織に所属しており、各所属組織の最下層のみが存在し、分かれている場合(別途先にグループ階層の取り込みが必要)

所属組織 1	所属組織 2
営業 1 課	経理課

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {ref}
company: 所属会社

パターン５

組織の階層ごとに項目が分かれており、1つのセルの中に複数の組織に所属している（兼務）ことが表現されている場合

所属組織 1	所属組織 2	所属組織 3	役職
YESOD / YESOD	営業部 / 管理部	営業 1 課 / 経理課	組織長 / メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier}
company: 所属会社

パターン６

1つのセルに複数の所属している最下層の組織のみが表現されている場合(別途先にグループ階層の取り込みが必要)

所属組織	役職
営業 1 課 / 経理課	組織長 / メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

パターン７

一人の所属情報が複数行に別れている場合

所属組織	役職
YESOD / 営業部 / 営業 1 課	組織長
YESOD / 管理部 / 経理課	メンバー

例) option 設定

tierSeparator: /
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

Authorizations:

Bearer

Request Body schema: multipart/form-data
required

csv required	string <binary> インポートするCSVデータ
required	object インポート時のオプション設定

Responses

Response samples

200

Content type

application/json

{ }

従業員情報のインポート(インポートと同時に承認)

CSVファイルからインポートし、同時に承認を実行します。
詳細は従業員情報のインポートを参照してください。

Authorizations:

Bearer

Request Body schema: multipart/form-data
required

csv required	string <binary> インポートするCSVデータ
required	object インポート時のオプション設定

Responses

Response samples

200

Content type

application/json

{ }

トランザクションインポート

操作（追加・変更・削除）を指定し、変更する値のみインポートを行います

トランザクション/メンバーインポート

操作オプション

指定した項目にて、操作を指定します。

指定値	説明
addEntity	新規メンバーを登録する際に指定します
modifyEntity	所属組織、事業所への異動や、グループ会社への出向、転籍。属性値を変更する際に指定します
unreferenceEntity	所属組織、事業所からの異動や、複数会社に所属している場合に、そのうちの１つから所属解除する際に指定します
purgeEntity	誤って登録した従業員を過去履歴を含めて削除する場合に指定します
changeJoiningDate	入社日を変更する際に指定します
cancelRetirement	退職登録されたメンバの退職を取り消します

インポート時の名寄キーとなる項目

以下の項目の一致を順に確認し、一致すれば情報を更新します。

identificationNumber : 社員 ID（会社横断の固有の ID）
employeeNumber : 社員番号
email : メールアドレス

グループの名寄せ対象と順序

各グループのコードで名寄せを行います。フルパスでの指定はできません organizationCode / companyCode / officeCode / projectCode

トランザクション/グループインポート

操作オプション

指定した項目にて、操作を指定します。

指定値	説明
addEntity	新規にグループを登録する際に仕様します
retireEntity	グループを終了させるときに指定します。該当の組織の有効期間は終了します

組織・会社・事業所・プロジェクトの指定

所属組織・会社・事業所・プロジェクトは、各種フルパス表記でのみ名寄せが行われます

更新される情報について

承認申請には、CSV に記載された情報と YESOD のデータベース上の差分のみ含まれます。変更がない項目については無視されます。

Node.js でトランザクションインポート API からメンバーをインポートする例

const axios = require('axios');

// YESODから取得したAPIトークンを指定
const YESOD_API_TOKEN = '<APIトークン>';

const csv = `
操作,変更日付,会社コード,ID,メールアドレス
modifyEntity,2023-11-15,00001,1271,ayaka.maeda@hogehoge.com
modifyEntity,2023-11-15,00001,1272,ryutaro.shimizu@hogehoge.com
modifyEntity,2023-11-15,00001,1275,ren.furubayashi@hogehoge.com
modifyEntity,2023-11-15,00001,1270,ayaka.mizuta@hogehoge.com
modifyEntity,2023-11-15,00001,1274,riku.takei@hogehoge.com
modifyEntity,2023-11-15,00001,1273,taiki.shimizu@hogehoge.com
`.trim();

// CSVのマッピングを指定
const mapping = `
transactionType: 操作
changeDate: 変更日付
companyCode: 会社コード
B5RlWXoJQyOAVcmj9TUIDg: ID
email: メールアドレス
`.trim();

const optionMapping = undefined;

const data = {
  csv: csv,
  options: {
    mapping: mapping,
    retireUnlisted: false,
    separateByDate: null,
    optionMapping: optionMapping,
    modifyGroup: false,
    applicationName: '検証XXX',
    tierSeparator: '',
    referenceSeparator: '',
    valueForDelete: '',
    avoidUnlistedEmails: [],
  },
};

const options = {
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer ' + YESOD_API_TOKEN,
  },
};

axios
  .post('https://yesod.io/api/v21.07/transactions/import', data, options)
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.log(error.response.data.messages);
  });

マッピングファイルの記載方法

オプションの mapping で CSV の 1 行目の項目名と、YESOD の属性とをマッピングできます。

mapping の記述方法

YESODの属性ID: CSVの項目名 [{ref}/{tier}]

会社、組織、事業所、プロジェクト項目の記述の最後に 「{tier}」 を追記することで、組織の項目の後ろの連番が階層を意味します。

mapping

organization: 所属組織 {tier}

csv の項目

所属組織1　・・・　第1階層の組織
所属組織2　・・・　第2階層の組織
所属組織3　・・・　第3階層の組織

会社、組織、事業所、プロジェクト項目の記述の最後に 「{ref}」 を追記することで、組織の項目の後ろの連番が所属の複数の所属を意味します。

mapping

organization: 所属組織 {ref}

csv の項目

所属組織1　・・・　１つ目の所属組織
所属組織2　・・・　2つ目の所属組織
所属組織3　・・・　3つ目の所属組織

サンプル

enterDate: 入社日
retireDate: 退社日
company: 所属法人
organization: 所属組織
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名

上記以外のマッピング属性の ID 名については、イエソド社の営業までお問い合わせください。

複数の所属会社や、所属組織情報の登録

複数の所属会社や、所属組織を登録する場合、CSV の形式に合わせて取り込む事ができます。
mapping の「{ref}」「{tier}」の指定、option の「referenceSeparator」、「tierSeparator」を組み合わせることで様々なフォーマットに対応できます。
所属組織における属性情報も所属と同様に表現する必要があります。

パターン１

1つのセルに、所属組織の階層と、複数の組織に所属している状態が表現されている場合

所属組織	役職
YESOD 営業部営業 1 課 / YESOD 管理部経理課	組織長 / メンバー

例) option 設定

tierSeparator:  (半角スペース)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

パターン２

1つのセル組織の階層が表現されており、複数の組織所属している場合、所属毎に項目が分かれている場合

所属組織 1	所属組織 2	役職 1	役職 2
YESOD 営業部営業 1 課	YESOD 管理部経理課	組織長	メンバー

例) option 設定

tierSeparator:  (半角スペース)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {ref}
company: 所属会社 {ref}

パターン３

組織の階層毎にセルが分かれている、なおかつ複数の組織に所属している場合にも、その所属毎にセルが分かれている場合

所属組織 1 1	所属組織 1 2	所属組織 1 3	所属組織 2 1	所属組織 2 2	所属組織 2 3	役職 1	役職 2
YESOD	営業部	営業 1 課	YESOD	管理部	経理課	組織長	メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier} {ref}
company: 所属会社

パターン４

複数の組織に所属しており、各所属組織の最下層のみが存在し、分かれている場合(別途先にグループ階層の取り込みが必要)

所属組織 1	所属組織 2
営業 1 課	経理課

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {ref}
company: 所属会社

パターン５

組織の階層ごとに項目が分かれており、1つのセルの中に複数の組織に所属している（兼務）ことが表現されている場合

所属組織 1	所属組織 2	所属組織 3	役職
YESOD / YESOD	営業部 / 管理部	営業 1 課 / 経理課	組織長 / メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織 {tier}
company: 所属会社

パターン６

1つのセルに複数の所属している最下層の組織のみが表現されている場合(別途先にグループ階層の取り込みが必要)

所属組織	役職
営業 1 課 / 経理課	組織長 / メンバー

例) option 設定

tierSeparator: (指定なし)
referenceSeparator: /

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

パターン７

一人の所属情報が複数行に別れている場合

所属組織	役職
YESOD / 営業部 / 営業 1 課	組織長
YESOD / 管理部 / 経理課	メンバー

例) option 設定

tierSeparator: /
referenceSeparator: (指定なし)

mapping の記述

identificationNumber: 従業員番号
email: メールアドレス
familyNameLocalPreferred: 姓
givenNameLocalPreferred: 名
organization: 所属組織
company: 所属会社

Authorizations:

Bearer

Request Body schema: application/json
required

required

object

インポート時の挙動を制御するオプション

optionsを指定することでインポート時の挙動を制御できます。

Responses

Request samples

Payload

Content type

application/json

{"options": {"mapping": {"property1": "string",
"property2": "string"
},
"optionMapping": {"property1": "string",
"property2": "string"
},
"applicationName": "string",
"changeDate": "2019-08-24",
"valueForDate": "string",
"tierSeparator": "string",
"referenceSeparator": "string"
}
}

Response samples

200

Content type

application/json

{ }

トランザクションインポート(インポートと同時に承認)

CSVファイルからインポートし、同時に承認を実行します。
詳細はトランザクションインポートを参照してください。

Authorizations:

Bearer

Request Body schema: application/json
required

required

object

インポート時の挙動を制御するオプション

optionsを指定することでインポート時の挙動を制御できます。

Responses

Request samples

Payload

Content type

application/json

{"options": {"mapping": {"property1": "string",
"property2": "string"
},
"optionMapping": {"property1": "string",
"property2": "string"
},
"applicationName": "string",
"changeDate": "2019-08-24",
"valueForDate": "string",
"tierSeparator": "string",
"referenceSeparator": "string"
}
}

Response samples

200

Content type

application/json

{ }

メンバー履歴 API

任意のメンバーの変更履歴を取得します。

Authorizations:

Bearer

path Parameters

memberId

required

string

Example: laB5U5NcQBy5ZO68x03uug

メンバーのID

Responses

Response samples

200

Content type

application/json

{"histories": [{"date": "2022-12-01",
"changedAttributes": [{"previousValue": "業務委託",
"value": "正社員",
"dataType": "SELECT",
"referenceName": "株式会社テスト",
"referenceId": "TVqXq3poR1SoBAbfPF2v0g",
"referenceType": "company",
"attributeId": "tcEh9H5iRyaAFlTZ0XMnpA",
"attributeLabel": "雇用形態",
"entityId": "laB5U5NcQBy5ZO68x03uug",
"setId": "D-PYos91TWab0lVomMWD2w",
"date": "2022-12-01"
}
]
}
]
}

メンバーアバター画像更新 API

任意のメンバーのアバター画像を更新します。このAPIの呼び出しには、「パッチ作成」と「パッチ承認」が有効になっているロールが必要です。

Authorizations:

Bearer

path Parameters

memberId

required

any

Example: laB5U5NcQBy5ZO68x03uug

メンバーのID

Request Body schema: multipart/form-data

changeDate	string アバター画像の変更日時。省略可。指定しない場合は現在日になります。
file required	string <binary> アバター画像ファイル。ファイル形式は`jpeg`、`png`、`bmp`、`gif`、`webp`のいずれかである必要があります。

Responses

Response samples

200

Content type

application/json

{"id": "laB5U5NcQBy5ZO68x03uug",
"name": "山田 太郎",
"email": "taro.yamada@example.com",
"avatarId": "tcEh9H5iRyaAFlTZ0XMnpA",
"changeDate": "2024-04-01"
}

組織 API

全組織を取得します。

Authorizations:

Bearer

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "laB5U5NcQBy5ZO68x03uug",
"name": "営業企画部",
"code": "A-001",
"depth": 2,
"parent": {"name": "営業本部",
"id": "laB5U5NcQBy5ZO68x03uug",
"code": "P-001"
},
"validStartDate": "2022-12-01",
"validEndDate": "2022-12-31",
"attributes": [{"value": "string",
"dataType": "TEXT",
"attributeId": "tcEh9H5iRyaAFlTZ0XMnpA",
"attributeLabel": "string",
"referenceId": "TVqXq3poR1SoBAbfPF2v0g",
"referenceName": "株式会社テスト",
"referenceType": "company",
"setId": "D-PYos91TWab0lVomMWD2w",
"entityId": "laB5U5NcQBy5ZO68x03uug"
}
]
}
]
}

クエリ

クエリ条件に一致するメンバーやグループの情報を取得します。

API パラメータの仕様

API パラメータを Body にセットしてリクエストします。 API パラメータはクイックビューにて条件を指定して作成します。

名称	必須	型・形式	説明
query	○	Query オブジェクト	検索するクエリ条件
attributeSelector	○	項目 ID（string）の配列	取得するメンバー情報の属性
groupAttributeSelector	○	項目 ID（string）の配列	取得するグループ情報の属性

例：会社が null でないメンバーの所属会社・メールアドレス・姓・名を取得するリクエストボディ

{
  "query": {
    "type": "AttributeQuery",
    "condition": {
      "attributeId": "4J9wMPgDQJmki9ycfx-Z7g",
      "comparisonOperator": "ISNOTNULL",
      "referenceIds": []
    },
    "onlyLatestData": false
  },
  "attributeSelector": [
    "4J9wMPgDQJmki9ycfx-Z7g",
    "z6JbmwvYQcO5BKnec_FVAA",
    "SLjXIv1nQsi_LQ66l6ffog",
    "TYJ5hHDZSnugN4Lv6e45kw"
  ],
  "groupAttributeSelector": []
}

Query オブジェクト

AttributeQuery オブジェクト

ある日付での値をクエリ条件と比較するオブジェクト

名称	必須	型・形式	説明
type	○	「AttributeQuery」という string	AttributeQuery であることを表す
condition	○	ComparisonCondition オブジェクト	値を比較する条件
onlyLatestData	×	false	指定しないか、false を指定してください

例：姓が田中である

{
  "type": "AttributeQuery",
  "condition": {
    "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
    "comparisonOperator": "EQ",
    "comparisonValue": "田中",
    "referenceIds": []
  },
  "onlyLatestData": false
}

LogicalQuery オブジェクト

Query オブジェクトを連結して条件を構築するオブジェクト

名称	必須	型・形式	説明
type	○	「Logical」という string	LogicalQuery オブジェクトであることを表す
op	○	「AND」か「OR」の string	AND の場合は conditions 内の各条件を AND 検索。OR の場合は conditions 内の各条件を OR 検索。
conditions	○	Query オブジェクトの配列	検索するクエリ条件

例：「会社が null でない」かつ「組織が null である」

{
  "type": "Logical",
  "op": "AND",
  "conditions": [
    {
      "type": "AttributeQuery",
      "condition": {
        "attributeId": "4J9wMPgDQJmki9ycfx-Z7g",
        "comparisonOperator": "ISNOTNULL",
        "referenceIds": []
      },
      "onlyLatestData": false
    },
    {
      "type": "AttributeQuery",
      "condition": {
        "attributeId": "BjTpbKICS9mSP4C6_XCpgg",
        "comparisonOperator": "ISNULL",
        "referenceIds": []
      },
      "onlyLatestData": false
    }
  ]
}

DiffQuery オブジェクト

ある項目の値の変化がクエリ条件と比較するオブジェクト

名称	必須	型・形式	説明
type	○	「DiffQuery」という string	DiffQuery であることを表す
fromCondition	○	ComparisonCondition オブジェクト	変更前の値を比較する条件
toCondition	○	ComparisonCondition オブジェクト	変更後の値を比較する条件
intervalTarget	○	「FROM」か「TO」の string	fromCondition と toCondition を適用する検索期間を決定する。"FROM"を指定すると fromCondition に対して指定した検索期間を適用し、toCondition に対して指定した検索期間を 1 日後ろにずらした期間を適用する。"TO"を指定すると toCondition に対して指定した検索期間を適用し、fromCondition に対して指定した検索期間を 1 日前にずらした期間を適用する。
diffType	○	「IN」か「OUT」の string	どういった項目の変化を検索するか決定する。"IN"を指定すると、値の追加と変更の差分を検索する。"OUT"を指定すると、値の削除と値変更の差分を検索する。

例：会社が未所属からどこかへの追加を検索する DiffQuery

{
  "type": "DiffQuery",
  "fromCondition": {
    "attributeId": "H2jJmfZRR7Ct8k74XqDTjg",
    "comparisonOperator": "ISNULL"
  },
  "toCondition": {
    "attributeId": "H2jJmfZRR7Ct8k74XqDTjg",
    "comparisonOperator": "ISNOTNULL"
  },
  "intervalTarget": "TO",
  "diffType": "IN"
}

その他のオブジェクト

ComparisonCondition オブジェクト

値を比較する条件を表すオブジェクト

名称	必須	型・形式	説明
attributeId	○	項目 ID を表す string	値を比較する項目 ID
comparisonOperator	○	次のいずれかの string - EQ - NE - GE - GT - LE - LT - FORWARD - BACKWARD - PARTIAL - ISNULL - ISNOTNULL - INCLUDE - NOTINCLUDE - DESCENDANT_OF_OR_EQ	値の比較演算子 "EQ"を指定すると値が指定した値と等しいか比較する。 "NE"を指定すると値が指定した値と等しくないか比較する。 "GE"を指定すると値が指定した値より大きいか等しいか比較する。 "GT"を指定すると値が指定した値より大きいか比較する。 "LE"を指定すると値が指定した値より小さいか等しいか比較する。 "LT"を指定すると値が指定した値より小さいか比較する。 "FORWARD"を指定すると値が指定した値と前方一致するか比較する。 "BACKWARD"を指定すると値が指定した値と後方一致するか比較する。 "PARTIAL"を指定すると値が指定した値と部分一致するか比較する。 "ISNULL"を指定すると値が存在しないか比較する。 "ISNOTNULL"を指定すると値が存在するか比較する。 "INCLUDE"を指定すると値が指定した値に含まれるか比較する。 "NOTINCLUDE"を指定すると値が指定した値に含まれないか比較する。 "DESCENDANT_OF_OR_EQ"を指定すると指定した値を ID に持つグループとその下位グループか比較する。
comparisonValue	×	string・number・boolean・string の配列・number の配列・boolean の配列・null	比較に使う値 EQ・NE・GE・GT・LE・LT・FORWARD・BACKWARD・PARTIAL・DESCENDANT_OF_OR_EQ の場合は string・number・boolean の指定が必要。 ISNULL・ISNOTNULL の場合は指定不要。 INCLUDE・NOTINCLUDE の場合は string の配列・number の配列・boolean の配列の指定が必要。
referenceIds	○	所属先の ID を表す string の配列・null	指定すると、「特定の所属先において、メンバーに付与される属性」については指定された所属先のみを対象とする。

例：EQ を使った ComparisonCondition オブジェクト姓が田中と等しい

{
  "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
  "comparisonOperator": "EQ",
  "comparisonValue": "田中",
  "referenceIds": []
}

例：ISNULL を使った ComparisonCondition オブジェクト姓が null でない

{
  "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
  "comparisonOperator": "ISNULL",
  "referenceIds": []
}

例：INCLUDE を使った ComparisonCondition オブジェクト雇用形態が正社員か契約社員に含まれる

{
  "attributeId": "H2jJmfZRR7Ct8k74XqDTjg",
  "comparisonOperator": "INCLUDE",
  "comparisonValue": ["lS2VZfdfTiWL7g7JfUy_qA", "VL0b_SpuQ2WAZxxhSmb--g"],
  "referenceIds": []
}

QueryResult オブジェクト

取得されたメンバーやグループの情報

MemberResult オブジェクト

取得されたメンバー情報

名称	Nullable	型・形式	説明
id	×	string	ID
type	×	「member」という string	メンバーであることを表す
email	×	string	メールアドレス
attributes	×	AttributeValues オブジェクトの配列	メンバーの情報
groups	×	Group オブジェクトの配列	所属先のグループの情報
conditionResults	×	ConditionResult オブジェクトの配列	適合したクエリ条件

サンプル

{
  "id": "2Fb9pp1sQhGpRIcz66SPPQ",
  "type": "member",
  "email": "sample@example.com",
  "attributes": [
    {
      "attributeId": "4J9wMPgDQJmki9ycfx-Z7g",
      "attributeLabel": "会社",
      "values": [
        {
          "reference": "株式会社サンプル",
          "referenceId": "JiKyiXoBSeOV0r_DhlgqAA",
          "referenceType": "company",
          "validStart": "2019-01-01",
          "validEnd": "9999-12-30",
          "value": "株式会社サンプル"
        }
      ]
    },
    {
      "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
      "attributeLabel": "姓",
      "values": [
        {
          "validStart": "2019-01-01",
          "validEnd": "9999-12-30",
          "value": "サンプル"
        }
      ]
    },
    {
      "attributeId": "SLjXIv1nQsi_LQ66l6ffog",
      "attributeLabel": "名",
      "values": [
        {
          "validStart": "2019-01-01",
          "validEnd": "9999-12-30",
          "value": "太郎"
        }
      ]
    },
    {
      "attributeId": "TYJ5hHDZSnugN4Lv6e45kw",
      "attributeLabel": "メールアドレス",
      "values": [
        {
          "validStart": "2019-01-01",
          "validEnd": "9999-12-30",
          "value": "hideyuki.takeuchi@yesod.co"
        }
      ]
    }
  ],
  "groups": [
    {
      "groupId": "tMWLbAIASOmrCRHRgBT8GA",
      "groupType": "organization",
      "groupCode": "",
      "name": "Sample Holdings",
      "depth": 1,
      "attributes": [],
      "parent": null
    },
    {
      "groupId": "JiKyiXoBSeOV0r_DhlgqAA",
      "groupType": "company",
      "groupCode": "",
      "name": "株式会社サンプル",
      "depth": 1,
      "attributes": [],
      "parent": null
    },
    {
      "groupId": "B9JY2b4KShGNWuNEB8Te9Q",
      "groupType": "company",
      "groupCode": "",
      "name": "株式会社サンプルテック",
      "depth": 2,
      "attributes": [],
      "parent": {
        "groupId": "JiKyiXoBSeOV0r_DhlgqAA",
        "groupType": "company",
        "groupCode": "",
        "name": "株式会社サンプル",
        "depth": 1,
        "attributes": [],
        "parent": null
      }
    },
    {
      "groupId": "wcZDtU4-RAaGeFz42osJfA",
      "groupType": "office",
      "groupCode": "",
      "name": "東京オフィス",
      "depth": 1,
      "attributes": [],
      "parent": null
    }
  ],
  "conditionResults": [
    {
      "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
      "attributeLabel": "姓",
      "values": [
        {
          "validStart": "2019-01-01",
          "validEnd": "9999-12-30",
          "value": "サンプル"
        }
      ]
    }
  ]
}

GroupResult オブジェクト

取得されたグループ情報

名称	Nullable	型・形式	説明
id	×	string	ID
type	×	string	グループの種別を表す
attributes	×	AttributeValues オブジェクトの配列	グループの情報
conditionResults	×	ConditionResult オブジェクトの配列	適合したクエリ条件

サンプル

{
  "id": "JiKyiXoBSeOV0r_DhlgqAA",
  "type": "company",
  "attributes": [
    {
      "attributeId": "noeSE7HDT5-Z_FivET314g",
      "attributeLabel": "名称",
      "values": [
        {
          "validStart": "2019-01-01",
          "validEnd": "9999-12-30",
          "value": "株式会社イエソド"
        }
      ]
    }
  ],
  "conditionResults": [
    {
      "attributeId": "noeSE7HDT5-Z_FivET314g",
      "attributeLabel": "名称",
      "values": [
        {
          "validStart": "2019-01-01",
          "validEnd": "9999-12-30",
          "value": "株式会社イエソド"
        }
      ]
    }
  ]
}

ConditionResult オブジェクト

クエリ条件と一致した項目を表すオブジェクト

AttributeQueryConditionResult オブジェクト

実行された AttributeQuery クエリのいずれかと一致した項目を表すオブジェクト

名称	Nullable	型・形式	説明
attributeId	×	string	属性の ID
attributeLabel	×	string	属性の名称
values	×	Value オブジェクトの配列	検索時に使われた値

サンプル

{
  "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
  "attributeLabel": "姓",
  "values": [
    {
      "validStart": "2019-01-01",
      "validEnd": "9999-12-30",
      "value": "サンプル"
    }
  ]
}

DiffQueryConditionResult オブジェクト

実行された DiffQuery クエリのいずれかと一致した項目を表すオブジェクト

名称	Nullable	型・形式	説明
attributeId	×	string	属性の ID
attributeLabel	×	string	属性の名称
fromValues	×	Value オブジェクトの配列	fromCondition の検索時に使われた値
toValues	×	Value オブジェクトの配列	toCondition の検索時に使われた値

サンプル

{
  "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
  "attributeLabel": "姓",
  "fromValues": [
    {
      "validStart": "2019-01-01",
      "validEnd": "2023-04-10",
      "value": "サンプル"
    }
  ],
  "toValues": [
    {
      "validStart": "2023-04-10",
      "validEnd": "9999-12-30",
      "value": "テスト"
    }
  ]
}

その他のオブジェクト

QueryInterval オブジェクト

クエリ条件の検索期間を表すオブジェクト

名称	Nullable	型・形式	説明
from	×	yyyy-MM-dd 形式の string	クエリ条件の検索期間開始日
to	×	yyyy-MM-dd 形式の string	クエリ条件の検索期間終了日

サンプル

{
  "from": "2023-03-14",
  "to": "2023-03-14"
}

AttributeValues オブジェクト

メンバーやグループの各項目とその値を表すオブジェクト

名称	Nullable	型・形式	説明
attributeId	×	string	属性の ID
attributeLabel	×	string	属性の名称
values	×	Value オブジェクトの配列	取得したメンバーやグループの属性の値

サンプル

{
  "attributeId": "z6JbmwvYQcO5BKnec_FVAA",
  "attributeLabel": "姓",
  "values": [
    {
      "validStart": "2019-01-01",
      "validEnd": "9999-12-30",
      "value": "サンプル"
    }
  ]
}

Value オブジェクト

メンバーやグループの各項目の値を表すオブジェクト

名称	Nullable	型・形式	説明
reference	×	string	所属先の名称所属先がない場合は返らない
referenceId	×	string	所属先の ID 所属先がない場合は返らない
referenceType	×	string	所属先の種類所属先がない場合は返らない
setId	×	string	マルチプル項目の ID マルチプル項目でない場合は返らない
validStart	×	yyyy-MM-dd 形式の string	値の有効期間開始日
validEnd	×	yyyy-MM-dd 形式の string	値の有効期間終了日
value	×	string・number・boolean	属性の値

サンプル

{
  "reference": "株式会社サンプル",
  "referenceId": "nEJ4qdMSR0y0LpTtA3Oadw",
  "referenceType": "company",
  "setId": "9JKxbn2iTvWjhTlDXkQmEw",
  "validStart": "2019-01-01",
  "validEnd": "9999-12-30",
  "value": "rBxKrQKRSSCb53wnMek9lw"
}

Group オブジェクト

メンバーの所属グループを表すオブジェクト

名称	Nullable	型・形式	説明
groupId	×	string	グループの ID
groupType	×	string	グループの種類
groupCode	×	string	グループコード
name	×	string	グループの名称
depth	×	number	階層における深さ
attributes	×	AttributeValues オブジェクトの配列	グループの項目情報
parent	◯	Group オブジェクト	親グループのオブジェクト存在しない場合は null

{
  "groupId": "B9JY2b4KShGNWuNEB8Te9Q",
  "groupType": "company",
  "groupCode": "",
  "name": "株式会社サンプルテック",
  "depth": 2,
  "attributes": [],
  "parent": {
    "groupId": "JiKyiXoBSeOV0r_DhlgqAA",
    "groupType": "company",
    "groupCode": "",
    "name": "株式会社サンプル",
    "depth": 1,
    "attributes": [],
    "parent": null
  }
}

Authorizations:

Bearer

query Parameters

baseDate	string <date> Example: baseDate=2023-04-01 情報取得日 maxLeavingDateを指定した場合、退職日時点や抽出日時点の値を取得デフォルト値: 実行日を表すyyyy-MM-dd形式のstring
from	string <date> Example: from=2022-04-01 クエリ条件の検索期間開始日デフォルト値: baseDate と同じ値
to	string <date> Example: to=2023-10-01 クエリ条件の検索期間終了日デフォルト値: baseDate の1日語を表すyyyy-MM-dd形式のstring
entityType	string Default: "member" Enum: "member" "company" "office" "organization" "project" 情報を取得したいエンティティの種類

Request Body schema: application/json
required

APIパラメータをBodyにセットしてリクエストします。 APIパラメータはクイックビューにて条件を指定して作成します。

query required	object 検索するクエリ条件
attributeSelector required	Array of strings 取得するメンバー情報の属性
groupAttributeSelector required	Array of strings 取得するグループ情報の属性

Responses

Request samples

Payload

Content type

application/json

{"query": { },
"attributeSelector": ["string"
],
"groupAttributeSelector": ["string"
]
}

Response samples

200

Content type

application/json

{"baseDate": "2019-08-24",
"queryInterval": {"from": "2019-08-24",
"to": "2019-08-24"
},
"results": [{"id": "string",
"type": "member",
"email": "string",
"attributes": [{"attributeId": "string",
"attributeLabel": "string",
"values": [{"groupName": "string",
"groupId": "string",
"groupType": "string",
"multipleId": "string",
"from": "2019-08-24",
"to": "2019-08-24",
"value": "string"
}
]
}
],
"groups": [{"id": "string",
"type": "string",
"code": "string",
"name": "string",
"depth": 0,
"attributes": [{"id": "string",
"name": "string",
"values": [{"groupName": "string",
"groupId": "string",
"groupType": "string",
"multipleId": "string",
"from": "2019-08-24",
"to": "2019-08-24",
"value": "string"
}
]
}
],
"parent": {"id": "string",
"type": "string",
"code": "string",
"name": "string",
"depth": 0,
"attributes": [{"id": "string",
"name": "string",
"values": [{"groupName": null,
"groupId": null,
"groupType": null,
"multipleId": null,
"from": null,
"to": null,
"value": null
}
]
}
]
}
}
],
"conditionResults": [{"id": "string",
"name": "string",
"values": [{"groupName": "string",
"groupId": "string",
"groupType": "string",
"multipleId": "string",
"from": "2019-08-24",
"to": "2019-08-24",
"value": "string"
}
]
}
]
}
],
"executedAt": "2019-08-24T14:15:22Z"
}

項目オプションAPI

YESODにある項目オプションを取得します。

Authorizations:

Bearer

query Parameters

attributeId

Array of strings

Example: attributeId=Cebgqp1LSpmRbq1YXPmnsQ

項目ID

Responses

Response samples

200

Content type

application/json

{"options": [{"attributeId": "tcEh9H5iRyaAFlTZ0XMnpA",
"attributeLabel": "string",
"optionId": "laB5U5NcQBy5ZO68x03uug",
"labels": {"ja_JP": "正社員",
"en_US": "Full-Time Employee"
},
"order": 1,
"selectable": true
}
]
}

BigQuery用メンバー履歴 API

メンバーの履歴をBigQueryで分析するためのエンドポイントです。NDJSON形式でエンティティ履歴データを取得します。

出力例

  {"entity_id":"vHimb8gBTsu17oOG4eoAhA","valid_start":"2019-01-01T00:00:00.000Z","valid_end":"2020-03-17T00:00:00.000Z","姓":"山田","名":"太郎"}
  {"entity_id":"abc123","valid_start":"2020-01-01T00:00:00.000Z","valid_end":"2021-01-01T00:00:00.000Z","姓":"田中","名":"太郎"}

Authorizations:

Bearer

query Parameters

attributes

Array of strings

Example: attributes=familyNameLocalPreferred,givenNameLocalPreferred

取得する属性のリスト。カンマ区切りで指定します。

Responses

Response samples

200

Content type

application/x-ndjson

"string"

YESOD API (1.0.0)

利用方法

AC

権限セットの照会

Authorizations:

query Parameters

Responses

Response samples

タスク照会API

Authorizations:

query Parameters

Responses

Response samples

タスクの完了書き戻し

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

メンバーに関連づく業務アセットと役割の照会

Authorizations:

query Parameters

Responses

Response samples

プロジェクトに関連づく業務アセットと役割の照会

Authorizations:

query Parameters

Responses

Response samples

業務アセットに割り当てられているメンバの照会

Authorizations:

query Parameters

Responses

Response samples

「同期する項目」をYESODからSaaSに同期

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

DS

グループAPI

Authorizations:

query Parameters

Responses

Response samples

属性一覧取得

Authorizations:

Responses

Response samples

組織・会社・事業所・プロジェクトのインポート

CSV ファイルからインポートします

インポート時の名寄キー項目について

入社日および変更日、退社日について

更新される情報について

Node.js で API からメンバーをインポートする例

マッピングファイルの記載方法

mapping の記述方法

mapping

csv の項目

mapping

csv の項目

サンプル

複数の所属会社や、所属組織情報の登録

パターン１

例) option 設定

パターン２

例) option 設定

パターン３

例) option 設定

パターン４

例) option 設定

パターン５

例) option 設定

パターン６

例) option 設定

パターン７

例) option 設定

Authorizations:

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required