YESOD API (22.10)

利用方法

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

組織 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

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

Authorizations:

Bearer

path Parameters

memberId

required

any

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`のいずれかである必要があります。

Responses

Response samples

200

Content type

application/json

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