Endpoint
| field | value |
|---|
| method | PUT |
| path | /api/integrations/v1/companies/{company_id}/employees/by-external-id/{external_id}/branch-services |
| operationId | replace_employee_branch_services_by_external_id_for_integration |
| auth | server to server integration client token |
| Idempotency-Key | required |
| lifecycle | stable |
| resource type | branch-service |
| data classification | confidential |
| scope risk | medium |
| write operation | yes |
Summary
対象 を更新します
Required scope
| scope | requirement |
|---|
| employees:write | required |
Operation contract
| field | value |
|---|
| bulk mode | - |
| bulk max items | - |
| bulk dry run | - |
| sync type | - |
| sync max limit | - |
| reconciliation | - |
Path parameters
| name | required | schema |
|---|
| company_id | required | integer |
| external_id | required | string |
Query parameters
Header parameters
| name | required | schema |
|---|
| Idempotency-Key | required | string |
Request body
| status | media type | schema |
|---|
| - | application/json | IntegrationEmployeeBranchServiceReplaceRequest |
Response
| status | media type | schema |
|---|
| 200 | application/json | SuccessResponse_IntegrationEmployeeBranchServiceReplaceResponse_ |
Example
curl -X PUT "https://api.anshin.care/api/integrations/v1/companies/{company_id}/employees/by-external-id/{external_id}/branch-services" \
-H "Authorization: Bearer $ANSHIN_INTEGRATION_ACCESS_TOKEN" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" \
-H "Content-Type: application/json" \
-d '{"example":"replace with request schema"}'
業務境界
- domain: 職員
- endpoint は各 backend の S2S scoped OpenAPI artifact から同期しています。
- company 境界は backend で検証します。
- write 系 endpoint は、画面用 API と endpoint を分け、処理本体は service 層で共通化します。