mirror of
https://github.com/freee/freee-mcp.git
synced 2026-09-19 02:18:01 +08:00
github-actions[bot]
3437 lines
116 KiB
JSON
3437 lines
116 KiB
JSON
{
|
||
"openapi": "3.0.3",
|
||
"info": {
|
||
"title": "freee工数管理",
|
||
"version": "v1.1.0",
|
||
"x-copyright": "© Since 2013 freee K.K.",
|
||
"description": "<h1 id=\"freee_api\">freee工数管理</h1> <hr />\n<h2 id=\"start_guide\">スタートガイド</h2> <p>freee API開発がはじめての方は<a href=\"https://developer.freee.co.jp/getting-started\">freee APIスタートガイド</a>を参照してください。</p>\n<hr />\n<h2 id=\"specification\">仕様</h2>\n<h3 id=\"api_endpoint\">APIエンドポイント</h3> <p>https://api.freee.co.jp/pm (httpsのみ)</p>\n<h3 id=\"about_authorize\">認証について</h3> <p>OAuth2.0を利用します。<a href=\"https://developer.freee.co.jp/reference/#%e8%aa%8d%e8%a8%bc\" target=\"_blank\">詳細はリファレンスの認証に関する記載を参照してください。</a></p>\n<h3 id=\"data_format\">データフォーマット</h3> <p>リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄（application/jsonなど）を確認してください。</p>\n<h3 id=\"compatibility\">後方互換性ありの変更</h3> <p>freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。</p> <ul>\n <li>新しいAPIリソース・エンドポイントの追加</li>\n <li>既存のAPIに対して必須ではない新しいリクエストパラメータの追加</li>\n <li>既存のAPIレスポンスに対する新しいプロパティの追加</li>\n <li>既存のAPIレスポンスに対するプロパティの順番の入れ変え</li>\n <li>keyとなっているidやcodeの長さの変更（長くする）</li>\n <li>エラーメッセージの変更</li>\n</ul>\n<h3 id=\"common_response_header\">共通レスポンスヘッダー</h3> <p>すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。</p> <ul>\n <li>\n <p>X-Freee-Request-ID</p>\n <ul>\n <li>各リクエスト毎に発行されるID</li>\n </ul>\n </li>\n</ul>\n<h3 id=\"common_error_response\">共通エラーレスポンス</h3> <ul>\n <li>\n <p>ステータスコードはレスポンス内のJSONに含まれる他、HTTPヘッダにも含まれます</p>\n </li>\n <li>\n <p>\n 一部のエラーレスポンスにはエラーコードが含まれます。<br>\n 詳細は、<a href=\"https://developer.freee.co.jp/tips/faq/40x-checkpoint\">HTTPステータスコード400台エラー時のチェックポイント</a>を参照してください\n </p>\n </li>\n <p>type</p>\n <ul>\n <li>status : HTTPステータスコードの説明</li>\n <li>validation : エラーの詳細の説明（開発者向け）</li>\n </ul>\n</ul>\n<p>レスポンスの例</p> <pre><code> {\n "status_code" : 400,\n "errors" : [\n {\n "type" : "status",\n "messages" : ["不正なリクエストです。"]\n },\n {\n "type" : "validation",\n "messages" : ["Date は不正な日付フォーマットです。入力例：'2013-01-01'"]\n }\n ]\n }</code></pre>\n\n<h3 id=\"api_rate_limit\">API使用制限</h3> <p>APIリクエストは1時間で5000回を上限としています。API使用ステータスはレスポンスヘッダに付与されます。<br> 各ヘッダの意味は次のとおりです。</p> <table>\n <thead>\n <tr><th>ヘッダ名</th><th>説明</th></tr>\n </thead>\n <tbody>\n <tr><td>X-RateLimit-Limit</td><td>使用回数の上限</td></tr>\n <tr><td>X-RateLimit-Remaining</td><td>残り使用回数</td></tr>\n <tr><td>X-RateLimit-Reset</td><td>使用回数がリセットされる時刻</td></tr>\n </tbody>\n</table>\n<p>上記に加え、freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。<br> その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。</p>\n<h3 id=\"demo_company\">開発用テスト環境</h3> <p>\n 会計・人事労務のAPIはアプリストアから開発用テスト環境を作成することができますが、freee工数管理の環境には対応しておりません。<br>\n freee工数管理のお試しをご自身で行っていただいくと、テストに使用できる環境としてお使いいただけます。<br>\n <br>\n freee工数管理のお試しは以下の手順で行うことができます。<br>\n <ol>\n <li>アプリストアから開発用テスト事業所を作成してください。</li>\n <li>作成した事業所にログインして、freee工数管理にアクセスしてください。</li>\n <li>『プランを選択する』をクリックして、必要事項を入力してください。</li>\n <li>プラン選択画面にてお試しプランを選択してください。</li>\n <li>freee工数管理がテストに使用できる状態になりました。</li>\n </ol>\n</p>"
|
||
},
|
||
"tags": [
|
||
{
|
||
"name": "Users",
|
||
"description": "ログインユーザー"
|
||
}
|
||
],
|
||
"servers": [
|
||
{
|
||
"url": "https://api.freee.co.jp/pm"
|
||
}
|
||
],
|
||
"security": [
|
||
{
|
||
"oauth2": [
|
||
"write",
|
||
"read"
|
||
]
|
||
}
|
||
],
|
||
"paths": {
|
||
"/users/me": {
|
||
"get": {
|
||
"operationId": "/users/me/index",
|
||
"summary": "ログインユーザー情報の取得",
|
||
"description": "このリクエストの認可セッションにおけるログインユーザーの情報を返します。 freee工数管理では一人のログインユーザーを複数の事業所に関連付けられるため、このユーザーと関連のあるすべての事業所の情報をリストで返します。 他のAPIのパラメータとして company_id が求められる場合は、このAPIで取得した company_id を使用します。",
|
||
"tags": [
|
||
"Users"
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/user"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/components/schemas/error"
|
||
},
|
||
{
|
||
"type": "object",
|
||
"properties": {
|
||
"fields": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string",
|
||
"example": "project_id"
|
||
},
|
||
"message": {
|
||
"type": "string",
|
||
"example": "存在しないプロジェクトが指定されています"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"example": {
|
||
"status_code": 400,
|
||
"errors": [
|
||
{
|
||
"messages": [
|
||
"リクエストの形式が不正です。"
|
||
],
|
||
"type": "bad_request",
|
||
"codes": [
|
||
"invalid_request"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/paths/~1users~1me/get/responses/400/content/application~1json/schema/allOf/0"
|
||
}
|
||
]
|
||
},
|
||
"example": {
|
||
"status_code": 500,
|
||
"errors": [
|
||
{
|
||
"messages": [
|
||
"予期しない問題が発生しました。しばらく経ってから再度お試しください。"
|
||
],
|
||
"type": "error",
|
||
"codes": [
|
||
"internal_server_error"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/projects": {
|
||
"post": {
|
||
"operationId": "/projects/create",
|
||
"summary": "プロジェクトの登録",
|
||
"description": "プロジェクトを登録します。\nプロジェクト作成申請が有効な場合は利用できません。",
|
||
"tags": [
|
||
"Projects"
|
||
],
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/create_project_param"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"project": {
|
||
"$ref": "#/components/schemas/project_detail"
|
||
}
|
||
},
|
||
"required": [
|
||
"project"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/paths/~1users~1me/get/responses/400/content/application~1json/schema/allOf/0"
|
||
}
|
||
]
|
||
},
|
||
"example": {
|
||
"status_code": 401,
|
||
"errors": [
|
||
{
|
||
"messages": [
|
||
"アクセスする権限がありません"
|
||
],
|
||
"type": "unauthorized",
|
||
"codes": [
|
||
"bad_request"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"402": {
|
||
"description": "Payment Required",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/paths/~1users~1me/get/responses/400/content/application~1json/schema/allOf/0"
|
||
}
|
||
]
|
||
},
|
||
"example": {
|
||
"status_code": 402,
|
||
"errors": [
|
||
{
|
||
"messages": [
|
||
"ご利用には有料プランが必要です。プラン状態をご確認ください。"
|
||
],
|
||
"type": "payment_required",
|
||
"codes": [
|
||
"payment_required"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Forbidden",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/paths/~1users~1me/get/responses/400/content/application~1json/schema/allOf/0"
|
||
}
|
||
]
|
||
},
|
||
"example": {
|
||
"status_code": 403,
|
||
"errors": [
|
||
{
|
||
"messages": [
|
||
"アクセスする権限がありません"
|
||
],
|
||
"type": "forbidden",
|
||
"codes": [
|
||
"forbidden"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/paths/~1users~1me/get/responses/400/content/application~1json/schema/allOf/0"
|
||
}
|
||
]
|
||
},
|
||
"example": {
|
||
"status_code": 404,
|
||
"errors": [
|
||
{
|
||
"messages": [
|
||
"対象リソースが見つかりませんでした。"
|
||
],
|
||
"type": "resource_not_found",
|
||
"codes": [
|
||
"not_found"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
},
|
||
"get": {
|
||
"summary": "プロジェクト一覧の取得",
|
||
"description": "この事業所のプロジェクトの一覧情報を返します。 運用ステータス、マネージャー、発注先、発注元で絞り込みできます。",
|
||
"tags": [
|
||
"Projects"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "運用ステータス",
|
||
"in": "query",
|
||
"name": "operational_status",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string",
|
||
"enum": [
|
||
"planning",
|
||
"awaiting_approval",
|
||
"in_progress",
|
||
"rejected",
|
||
"done"
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"description": "マネージャのユーザID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "manager_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "発注元の取引先ID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "orderer_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "発注先の取引先ID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "contractor_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"meta": {
|
||
"$ref": "#/components/schemas/meta"
|
||
},
|
||
"projects_counts": {
|
||
"type": "object",
|
||
"properties": {
|
||
"total": {
|
||
"type": "integer",
|
||
"description": "取得件数合計",
|
||
"example": 10
|
||
},
|
||
"by_status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"planning": {
|
||
"type": "integer",
|
||
"description": "計画中件数",
|
||
"example": 10
|
||
},
|
||
"awaiting_approval": {
|
||
"type": "integer",
|
||
"description": "承認待ち件数",
|
||
"example": 10
|
||
},
|
||
"in_progress": {
|
||
"type": "integer",
|
||
"description": "運用中件数",
|
||
"example": 10
|
||
},
|
||
"rejected": {
|
||
"type": "integer",
|
||
"description": "差し戻し件数",
|
||
"example": 10
|
||
},
|
||
"done": {
|
||
"type": "integer",
|
||
"description": "終了件数",
|
||
"example": 10
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"projects": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/project"
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"projects",
|
||
"projects_counts",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/projects/{id}": {
|
||
"get": {
|
||
"summary": "プロジェクト詳細の取得",
|
||
"description": "IDに該当するプロジェクトの詳細情報を返します。",
|
||
"tags": [
|
||
"Projects"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "プロジェクトID",
|
||
"in": "path",
|
||
"name": "id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"project": {
|
||
"$ref": "#/paths/~1projects/post/responses/200/content/application~1json/schema/properties/project"
|
||
}
|
||
},
|
||
"required": [
|
||
"project"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"404": {
|
||
"$ref": "#/paths/~1projects/post/responses/404"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
},
|
||
"patch": {
|
||
"operationId": "/projects/partial_update",
|
||
"summary": "プロジェクトの編集",
|
||
"description": "IDに該当するプロジェクトを編集します。\nプロジェクト変更申請が有効な場合は利用できません。\nリクエストに含まれているフィールドのみ更新され、含まれていないフィールドは更新されません。",
|
||
"tags": [
|
||
"Projects"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "プロジェクトID",
|
||
"in": "path",
|
||
"name": "id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/partial_update_project_param"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"project": {
|
||
"$ref": "#/paths/~1projects/post/responses/200/content/application~1json/schema/properties/project"
|
||
}
|
||
},
|
||
"required": [
|
||
"project"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"404": {
|
||
"$ref": "#/paths/~1projects/post/responses/404"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"operationId": "/projects/destroy",
|
||
"summary": "プロジェクトの削除",
|
||
"description": "IDに該当するプロジェクトを削除します。\nプロジェクト削除申請が有効な場合は利用できません。",
|
||
"tags": [
|
||
"Projects"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "プロジェクトID",
|
||
"in": "path",
|
||
"name": "id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "成功時"
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"404": {
|
||
"$ref": "#/paths/~1projects/post/responses/404"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/unit_costs": {
|
||
"get": {
|
||
"operationId": "/unit_costs/index",
|
||
"summary": "従業員単価マスタの取得",
|
||
"description": "従業員の単価マスタを返します。",
|
||
"tags": [
|
||
"UnitCosts"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"unit_costs": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/unit_cost"
|
||
}
|
||
},
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
}
|
||
},
|
||
"required": [
|
||
"unit_costs",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/people": {
|
||
"get": {
|
||
"summary": "従業員一覧の取得",
|
||
"description": "このリクエストで指定したIDの事業所の従業員一覧を返します。 権限・ステータス・従業員IDで取得する情報を絞り込むことができます。",
|
||
"tags": [
|
||
"People"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "役割",
|
||
"in": "query",
|
||
"name": "role",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"description": "ステータス（招待中・利用中・無効）",
|
||
"in": "query",
|
||
"name": "status",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string",
|
||
"enum": [
|
||
"sent",
|
||
"accepted",
|
||
"inactive"
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"description": "従業員ID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "person_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"properties": {
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
},
|
||
"people_counts": {
|
||
"type": "object",
|
||
"properties": {
|
||
"total": {
|
||
"type": "integer",
|
||
"description": "取得件数合計",
|
||
"example": 10
|
||
},
|
||
"by_status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"sent": {
|
||
"type": "integer",
|
||
"description": "招待済み従業員件数",
|
||
"example": 10
|
||
},
|
||
"accepted": {
|
||
"type": "integer",
|
||
"description": "利用中従業員件数",
|
||
"example": 10
|
||
},
|
||
"inactive": {
|
||
"type": "integer",
|
||
"description": "無効従業員件数",
|
||
"example": 10
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"people": {
|
||
"items": {
|
||
"$ref": "#/components/schemas/person"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"required": [
|
||
"people",
|
||
"people_counts",
|
||
"meta"
|
||
],
|
||
"type": "object"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/partners": {
|
||
"get": {
|
||
"operationId": "/partners/index",
|
||
"summary": "取引先の一覧取得",
|
||
"description": "登録されている取引先の一覧を返します。",
|
||
"tags": [
|
||
"Partners"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"partners": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/partner"
|
||
}
|
||
},
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
}
|
||
},
|
||
"required": [
|
||
"partners",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/workloads": {
|
||
"post": {
|
||
"operationId": "/workloads/create",
|
||
"summary": "工数登録",
|
||
"description": "工数を登録することが出来ます。",
|
||
"tags": [
|
||
"Workloads"
|
||
],
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/create_workload_param"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"workload": {
|
||
"$ref": "#/components/schemas/workload"
|
||
}
|
||
},
|
||
"required": [
|
||
"workload"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"402": {
|
||
"$ref": "#/paths/~1projects/post/responses/402"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"404": {
|
||
"$ref": "#/paths/~1projects/post/responses/404"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
},
|
||
"get": {
|
||
"summary": "工数詳細の取得",
|
||
"description": "取得対象の従業員の工数実績の詳細を返します。 取得対象従業員と年月の取得範囲で絞り込みできます。",
|
||
"tags": [
|
||
"Workloads"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象従業員の検索スコープです。 <ul> <li> allを指定した場合は全従業員が対象です。 絞り込みを行わない場合にご使用ください。 person_ids, team_idsでの絞り込みはできません。 </li> <li> teamを指定した場合はチーム単位で絞り込みが可能です。 team_idsでの絞り込みができます。 person_idsでの絞り込みはできません。 </li> <li> employeeを指定した場合はperson_idsによる絞り込みができます。 team_idsでの絞り込みは行なえません。 </li> <li> scopeを指定しない場合はログインユーザの情報のみの取得です。 </li> </ul>",
|
||
"in": "query",
|
||
"name": "employees_scope",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string",
|
||
"enum": [
|
||
"all",
|
||
"team",
|
||
"employee"
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象従業員のユーザID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "person_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象のチームID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "team_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象範囲（YYYY-MM）",
|
||
"in": "query",
|
||
"name": "year_month",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"workloads": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/paths/~1workloads/post/responses/200/content/application~1json/schema/properties/workload"
|
||
}
|
||
},
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
}
|
||
},
|
||
"required": [
|
||
"workloads",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/workloads/{id}": {
|
||
"patch": {
|
||
"operationId": "/workloads/partial_update",
|
||
"summary": "工数編集",
|
||
"description": "指定した工数の情報を更新します。リクエストに含まれていないフィールドは更新されません。memo と workload_tags は null（または空）で削除できます。",
|
||
"tags": [
|
||
"Workloads"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "工数ID",
|
||
"in": "path",
|
||
"name": "id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/partial_update_workload_param"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"workload": {
|
||
"$ref": "#/paths/~1workloads/post/responses/200/content/application~1json/schema/properties/workload"
|
||
}
|
||
},
|
||
"required": [
|
||
"workload"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"402": {
|
||
"$ref": "#/paths/~1projects/post/responses/402"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"404": {
|
||
"$ref": "#/paths/~1projects/post/responses/404"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"operationId": "/workloads/destroy",
|
||
"summary": "工数削除",
|
||
"description": "指定した工数を削除します。",
|
||
"tags": [
|
||
"Workloads"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "工数ID",
|
||
"in": "path",
|
||
"name": "id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "成功時"
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"402": {
|
||
"$ref": "#/paths/~1projects/post/responses/402"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"404": {
|
||
"$ref": "#/paths/~1projects/post/responses/404"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/workload_summaries": {
|
||
"get": {
|
||
"summary": "工数実績の取得",
|
||
"description": "取得対象の従業員の工数実績のサマリを返します。 取得対象従業員と年月の取得範囲で絞り込みできます。",
|
||
"tags": [
|
||
"Workloads"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象従業員の検索スコープです。 <ul> <li> allを指定した場合は全従業員が対象です。 絞り込みを行わない場合にご使用ください。 person_ids, team_idsでの絞り込みはできません。 </li> <li> teamを指定した場合はチーム単位で絞り込みが可能です。 team_idsでの絞り込みができます。 person_idsでの絞り込みはできません。 </li> <li> employeeを指定した場合はperson_idsによる絞り込みができます。 team_idsでの絞り込みは行なえません。 </li> <li> scopeを指定しない場合はログインユーザの情報のみの取得です。 </li> </ul>",
|
||
"in": "query",
|
||
"name": "employees_scope",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string",
|
||
"enum": [
|
||
"all",
|
||
"team",
|
||
"employee"
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象従業員のユーザID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "person_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象のチームID",
|
||
"explode": true,
|
||
"in": "query",
|
||
"name": "team_ids[]",
|
||
"required": false,
|
||
"schema": {
|
||
"items": {
|
||
"type": "integer"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象範囲（YYYY-MM）",
|
||
"in": "query",
|
||
"name": "year_month",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"workload_summaries": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/workload_summary"
|
||
}
|
||
},
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
}
|
||
},
|
||
"required": [
|
||
"workload_summaries",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/teams": {
|
||
"get": {
|
||
"operationId": "/teams/index",
|
||
"summary": "チームの一覧取得",
|
||
"description": "登録されているチームの一覧を返します。",
|
||
"tags": [
|
||
"Teams"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"teams": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/team"
|
||
}
|
||
},
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
}
|
||
},
|
||
"required": [
|
||
"teams",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/labor_budgets": {
|
||
"get": {
|
||
"operationId": "/labor_budgets/index",
|
||
"summary": "人件費予算一覧の取得",
|
||
"description": "この事業所の人件費予算の一覧を返します。プロジェクト・従業員・年月範囲 で絞り込みができます。対象プロジェクト数が一定値を超えるとエラーとなります。その場合はプロジェクトIDまたは従業員IDを指定して絞り込む必要があります。",
|
||
"tags": [
|
||
"LaborBudgets"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "プロジェクトID",
|
||
"in": "query",
|
||
"name": "project_id",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "従業員ID",
|
||
"in": "query",
|
||
"name": "person_id",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象の開始年月（YYYY-MM）。指定した年月を含みます。",
|
||
"in": "query",
|
||
"name": "from",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string",
|
||
"example": "2026-01"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得対象の終了年月（YYYY-MM）。指定した年月を含みます。",
|
||
"in": "query",
|
||
"name": "to",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "string",
|
||
"example": "2026-06"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大：100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"labor_budgets": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/labor_budget"
|
||
}
|
||
},
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
}
|
||
},
|
||
"required": [
|
||
"labor_budgets",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/labor_budgets/projects/{project_id}/people/{person_id}/year_month/{year_month}": {
|
||
"put": {
|
||
"operationId": "/labor_budgets/update",
|
||
"summary": "人件費予算の更新",
|
||
"description": "指定したプロジェクト・従業員・年月の予定工数（時間）と人件費予算の金額を更新します。金額は従業員の単価に基づき、自動で更新されます。",
|
||
"tags": [
|
||
"LaborBudgets"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "プロジェクトID",
|
||
"in": "path",
|
||
"name": "project_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "対象従業員ID",
|
||
"in": "path",
|
||
"name": "person_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "対象年月（YYYY-MM）",
|
||
"in": "path",
|
||
"name": "year_month",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
],
|
||
"requestBody": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/components/schemas/update_labor_budget_param"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"labor_budget": {
|
||
"$ref": "#/paths/~1labor_budgets/get/responses/200/content/application~1json/schema/properties/labor_budgets/items"
|
||
}
|
||
},
|
||
"required": [
|
||
"labor_budget"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"402": {
|
||
"$ref": "#/paths/~1projects/post/responses/402"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"404": {
|
||
"$ref": "#/paths/~1projects/post/responses/404"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/workload_tag_groups": {
|
||
"get": {
|
||
"operationId": "/workload_tag_groups/index",
|
||
"summary": "工数タグの取得",
|
||
"description": "事業所の工数タググループと、その配下に属する工数タグの一覧を取得します。",
|
||
"tags": [
|
||
"WorkloadTagGroups"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "事業所ID",
|
||
"in": "query",
|
||
"name": "company_id",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードの件数（デフォルト：50, 最小：1, 最大：100）",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 100
|
||
}
|
||
},
|
||
{
|
||
"description": "取得レコードのオフセット（デフォルト：0）",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"maximum": 9223372036854776000
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "成功時",
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"workload_tag_groups": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/components/schemas/workload_tag_group"
|
||
}
|
||
},
|
||
"meta": {
|
||
"$ref": "#/paths/~1projects/get/responses/200/content/application~1json/schema/properties/meta"
|
||
}
|
||
},
|
||
"required": [
|
||
"workload_tag_groups",
|
||
"meta"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/400"
|
||
},
|
||
"401": {
|
||
"$ref": "#/paths/~1projects/post/responses/401"
|
||
},
|
||
"403": {
|
||
"$ref": "#/paths/~1projects/post/responses/403"
|
||
},
|
||
"500": {
|
||
"$ref": "#/paths/~1users~1me/get/responses/500"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"components": {
|
||
"securitySchemes": {
|
||
"oauth2": {
|
||
"type": "oauth2",
|
||
"flows": {
|
||
"authorizationCode": {
|
||
"authorizationUrl": "https://accounts.secure.freee.co.jp/public_api/authorize",
|
||
"tokenUrl": "https://accounts.secure.freee.co.jp/public_api/token",
|
||
"scopes": {
|
||
"write": "データの書き込み",
|
||
"read": "データの読み取り"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schemas": {
|
||
"user": {
|
||
"type": "object",
|
||
"description": "ログインユーザー情報",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "ユーザーID",
|
||
"example": 1
|
||
},
|
||
"companies": {
|
||
"type": "array",
|
||
"description": "ユーザーが属する事業所の一覧",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "事業所ID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "事業所名",
|
||
"example": "フリー株式会社"
|
||
},
|
||
"display_name": {
|
||
"type": "string",
|
||
"description": "事業所に所属する従業員の表示名",
|
||
"example": "フリー株式会社"
|
||
},
|
||
"role": {
|
||
"type": "string",
|
||
"description": "事業所におけるロール",
|
||
"example": "company_admin"
|
||
},
|
||
"external_cid": {
|
||
"type": "string",
|
||
"description": "事業所番号(半角英数字10桁)",
|
||
"example": "1234567890"
|
||
},
|
||
"person_me": {
|
||
"type": "object",
|
||
"description": "ログインユーザー情報",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "従業員ID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "氏名",
|
||
"example": "“田中太郎”"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"description": "メールアドレス",
|
||
"example": "test@example.com"
|
||
},
|
||
"role": {
|
||
"type": "string",
|
||
"description": "事業所におけるロール",
|
||
"example": "company_admin"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "ステータス",
|
||
"example": "accepted"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"project": {
|
||
"type": "object",
|
||
"description": "プロジェクト",
|
||
"allOf": [
|
||
{
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "プロジェクトID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "プロジェクト名",
|
||
"example": "PJ-AAA"
|
||
},
|
||
"code": {
|
||
"type": "string",
|
||
"description": "プロジェクトコード",
|
||
"example": "PJ-AAA"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"description": "プロジェクト概要",
|
||
"example": "プロジェクトの概要",
|
||
"nullable": true
|
||
},
|
||
"manager": {
|
||
"type": "object",
|
||
"description": "プロジェクトマネージャー",
|
||
"properties": {
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "ユーザID",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "氏名",
|
||
"example": "テスト太郎"
|
||
}
|
||
}
|
||
},
|
||
"color": {
|
||
"type": "string",
|
||
"description": "カラー",
|
||
"example": "#c8790f"
|
||
},
|
||
"from_date": {
|
||
"type": "string",
|
||
"description": "期間from",
|
||
"example": "2021-01-01"
|
||
},
|
||
"thru_date": {
|
||
"type": "string",
|
||
"description": "期間to",
|
||
"example": "2021-12-31"
|
||
},
|
||
"publish_to_employee": {
|
||
"type": "boolean",
|
||
"description": "従業員への公開設定",
|
||
"example": true
|
||
},
|
||
"assignment_url_enabled": {
|
||
"type": "boolean",
|
||
"description": "招待リンク",
|
||
"example": false
|
||
},
|
||
"operational_status": {
|
||
"type": "string",
|
||
"description": "運用ステータス",
|
||
"example": "in_progress"
|
||
},
|
||
"sales_order_status": {
|
||
"type": "string",
|
||
"description": "受注ステータス",
|
||
"example": "受注済み"
|
||
},
|
||
"members": {
|
||
"type": "array",
|
||
"description": "プロジェクトメンバー",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "ユーザID",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "氏名",
|
||
"example": "田中太郎"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"workload_tag_groups": {
|
||
"type": "array",
|
||
"description": "プロジェクトで使える工数タグのグループ",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_id": {
|
||
"type": "integer",
|
||
"description": "タググループID",
|
||
"example": 1
|
||
},
|
||
"tag_group_name": {
|
||
"type": "string",
|
||
"description": "タググループ名",
|
||
"example": "タググループA"
|
||
},
|
||
"required": {
|
||
"type": "boolean",
|
||
"description": "工数登録時に必須かどうかのフラグ",
|
||
"example": true
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"description": "タグ",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "タグID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "タグ名",
|
||
"example": "タグA"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"orderers": {
|
||
"type": "array",
|
||
"description": "発注元",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"partner_id": {
|
||
"type": "integer",
|
||
"description": "取引先ID",
|
||
"example": 1
|
||
},
|
||
"partner_name": {
|
||
"type": "string",
|
||
"description": "取引先名",
|
||
"example": "XX株式会社"
|
||
},
|
||
"partner_code": {
|
||
"type": "string",
|
||
"description": "取引先コード",
|
||
"example": "CORP-XX",
|
||
"nullable": true
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"contractors": {
|
||
"type": "array",
|
||
"description": "発注先",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"partner_id": {
|
||
"type": "integer",
|
||
"description": "取引先ID",
|
||
"example": 2
|
||
},
|
||
"partner_name": {
|
||
"type": "string",
|
||
"description": "取引先名",
|
||
"example": "CORP-YY"
|
||
},
|
||
"partner_code": {
|
||
"type": "string",
|
||
"description": "取引先コード",
|
||
"example": "YY株式会社",
|
||
"nullable": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"type": "object",
|
||
"properties": {
|
||
"project_tags": {
|
||
"type": "array",
|
||
"description": "プロジェクトタグ",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_name": {
|
||
"type": "string",
|
||
"description": "タググループ名",
|
||
"example": "タググループA"
|
||
},
|
||
"tag_name": {
|
||
"type": "string",
|
||
"description": "タグ名",
|
||
"example": "タグA",
|
||
"nullable": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"create_project_param": {
|
||
"type": "object",
|
||
"description": "プロジェクト情報",
|
||
"properties": {
|
||
"company_id": {
|
||
"description": "事業所ID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"description": "プロジェクト名",
|
||
"type": "string"
|
||
},
|
||
"code": {
|
||
"description": "プロジェクトコード\n案件マスタの自動採番機能が利用可能な場合、指定は任意です。",
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"description": "プロジェクト概要",
|
||
"type": "string"
|
||
},
|
||
"from_date": {
|
||
"description": "プロジェクト開始日",
|
||
"type": "string"
|
||
},
|
||
"thru_date": {
|
||
"description": "プロジェクト終了日",
|
||
"type": "string"
|
||
},
|
||
"publish_to_employee": {
|
||
"description": "従業員への公開設定\n公開するとプロジェクト一覧に表示され、従業員がアサインリクエストを送れるようになります。（詳細画面は閲覧不可）",
|
||
"type": "boolean"
|
||
},
|
||
"assignment_url_enabled": {
|
||
"description": "プロジェクトの招待リンク機能設定\nプロジェクトの招待リンクを発行できるようにするかどうかを設定します。",
|
||
"type": "boolean"
|
||
},
|
||
"sales_order_status_id": {
|
||
"description": "受注ステータスID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 2
|
||
},
|
||
"manager_person_id": {
|
||
"description": "プロジェクトマネージャーの従業員ID\nこのパラメータはシステム管理者かプロジェクトマネージャーでログインしているときのみ指定可能。\n（デフォルト：指定しない場合はログインユーザ）",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 10,
|
||
"nullable": true
|
||
},
|
||
"pm_budgets_cost": {
|
||
"description": "プロジェクトマネージャーのコスト(円)",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 4000
|
||
},
|
||
"color_id": {
|
||
"description": "プロジェクトの色を指定可能（デフォルト：orange）\n{ orange: 1, blue_green: 2, green: 3, blue: 4, purple: 5, red: 6, yellow: 7 }",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"members": {
|
||
"description": "プロジェクトメンバーの配列。\n※プロジェクトマネージャーは `members` ではなく `manager_person_id` で指定する必要があります。",
|
||
"type": "array",
|
||
"nullable": true,
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"person_id": {
|
||
"description": "従業員ID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 11
|
||
},
|
||
"unit_cost_id": {
|
||
"description": "このプロジェクトで使用する従業員単価マスタID\n`use_standard_unit_cost: true` の場合は無視されます",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"budgets_cost": {
|
||
"description": "予算計算用の単価(円)",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 2000
|
||
},
|
||
"use_standard_unit_cost": {
|
||
"description": "標準の従業員単価マスタの単価を利用（デフォルト：false）",
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
},
|
||
"required": [
|
||
"person_id",
|
||
"unit_cost_id",
|
||
"budgets_cost"
|
||
]
|
||
}
|
||
},
|
||
"orderer_ids": {
|
||
"description": "発注元として指定する取引先IDの配列",
|
||
"items": {
|
||
"type": "integer",
|
||
"example": 20
|
||
},
|
||
"type": "array"
|
||
},
|
||
"contractor_ids": {
|
||
"description": "発注先として指定する取引先IDの配列",
|
||
"items": {
|
||
"type": "integer",
|
||
"example": 10
|
||
},
|
||
"type": "array"
|
||
},
|
||
"workload_tag_groups": {
|
||
"description": "プロジェクトに指定可能な工数タグリスト",
|
||
"type": "array",
|
||
"nullable": true,
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_id": {
|
||
"description": "工数タググループID",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"required": {
|
||
"description": "工数登録時の入力を必須とするか",
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"tag_ids": {
|
||
"description": "当該タググループ配下で指定可能とする工数タグIDの配列（1件以上必要）",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "integer",
|
||
"example": 10
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"tag_group_id",
|
||
"required",
|
||
"tag_ids"
|
||
]
|
||
}
|
||
},
|
||
"common_business_id": {
|
||
"description": "案件マスタの案件ID（ULID形式）\n指定した場合は既存案件にプロジェクトを紐付けます。指定しない場合は新規案件を作成します。",
|
||
"type": "string",
|
||
"nullable": true,
|
||
"minLength": 26,
|
||
"maxLength": 26,
|
||
"example": "01KF06JSKZ8TXZZVG7842F0VEM"
|
||
}
|
||
},
|
||
"required": [
|
||
"company_id",
|
||
"name",
|
||
"from_date",
|
||
"thru_date",
|
||
"pm_budgets_cost"
|
||
]
|
||
},
|
||
"partial_update_project_param": {
|
||
"type": "object",
|
||
"description": "プロジェクト更新情報。\nリクエストに含まれているフィールドのみ更新され、含まれていないフィールドは更新されません。\n配列項目（members / orderer_ids / contractor_ids / workload_tag_groups）は、キーを指定すると指定内容で全置換され、空配列やnullを指定するとすべて解除されます。",
|
||
"properties": {
|
||
"company_id": {
|
||
"description": "事業所ID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"description": "プロジェクト名",
|
||
"type": "string"
|
||
},
|
||
"code": {
|
||
"description": "プロジェクトコード",
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"description": "プロジェクト概要",
|
||
"type": "string",
|
||
"nullable": true
|
||
},
|
||
"from_date": {
|
||
"description": "プロジェクト開始日",
|
||
"type": "string"
|
||
},
|
||
"thru_date": {
|
||
"description": "プロジェクト終了日",
|
||
"type": "string"
|
||
},
|
||
"publish_to_employee": {
|
||
"description": "従業員への公開設定\n公開するとプロジェクト一覧に表示され、従業員がアサインリクエストを送れるようになります。（詳細画面は閲覧不可）",
|
||
"type": "boolean"
|
||
},
|
||
"assignment_url_enabled": {
|
||
"description": "プロジェクトの招待リンク機能設定\nプロジェクトの招待リンクを発行できるようにするかどうかを設定します。",
|
||
"type": "boolean"
|
||
},
|
||
"sales_order_status_id": {
|
||
"description": "受注ステータスID。nullの場合「指定なし」になります。",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 2,
|
||
"nullable": true
|
||
},
|
||
"manager_person_id": {
|
||
"description": "プロジェクトマネージャーの従業員ID\nこのパラメータはシステム管理者かプロジェクトマネージャーでログインしているときのみ指定可能。",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 10
|
||
},
|
||
"pm_budgets_cost": {
|
||
"description": "プロジェクトマネージャーのコスト(円)",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 4000
|
||
},
|
||
"color_id": {
|
||
"description": "プロジェクトの色を指定可能\n{ orange: 1, blue_green: 2, green: 3, blue: 4, purple: 5, red: 6, yellow: 7 }",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"members": {
|
||
"description": "プロジェクトメンバーの配列。\n指定するとメンバーが指定内容で全置換され、空配列やnullを指定するとすべて解除されます。\n※プロジェクトマネージャーは `members` ではなく `manager_person_id` で指定する必要があります。",
|
||
"type": "array",
|
||
"nullable": true,
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"person_id": {
|
||
"description": "従業員ID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 11
|
||
},
|
||
"unit_cost_id": {
|
||
"description": "このプロジェクトで使用する従業員単価マスタID\n`use_standard_unit_cost: true` の場合は無視されます",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"budgets_cost": {
|
||
"description": "予算計算用の単価(円)",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 2000
|
||
},
|
||
"use_standard_unit_cost": {
|
||
"description": "標準の従業員単価マスタの単価を利用（デフォルト：false）",
|
||
"type": "boolean",
|
||
"example": true
|
||
}
|
||
},
|
||
"required": [
|
||
"person_id",
|
||
"unit_cost_id",
|
||
"budgets_cost"
|
||
]
|
||
}
|
||
},
|
||
"orderer_ids": {
|
||
"description": "発注元として指定する取引先IDの配列\n指定すると発注元が指定内容で全置換され、空配列やnullを指定するとすべて解除されます。",
|
||
"type": "array",
|
||
"nullable": true,
|
||
"items": {
|
||
"type": "integer",
|
||
"example": 20
|
||
}
|
||
},
|
||
"contractor_ids": {
|
||
"description": "発注先として指定する取引先IDの配列\n指定すると発注先が指定内容で全置換され、空配列やnullを指定するとすべて解除されます。",
|
||
"type": "array",
|
||
"nullable": true,
|
||
"items": {
|
||
"type": "integer",
|
||
"example": 10
|
||
}
|
||
},
|
||
"workload_tag_groups": {
|
||
"description": "プロジェクトに指定可能な工数タグリスト\n指定すると指定内容で全置換され、空配列やnullを指定するとすべて解除されます。",
|
||
"type": "array",
|
||
"nullable": true,
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_id": {
|
||
"description": "工数タググループID",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"required": {
|
||
"description": "工数登録時の入力を必須とするか",
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"tag_ids": {
|
||
"description": "当該タググループ配下で指定可能とする工数タグIDの配列（1件以上必要）",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "integer",
|
||
"example": 10
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"tag_group_id",
|
||
"required",
|
||
"tag_ids"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"company_id"
|
||
]
|
||
},
|
||
"project_detail": {
|
||
"type": "object",
|
||
"description": "プロジェクト",
|
||
"allOf": [
|
||
{
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "プロジェクトID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "プロジェクト名",
|
||
"example": "PJ-AAA"
|
||
},
|
||
"code": {
|
||
"type": "string",
|
||
"description": "プロジェクトコード",
|
||
"example": "PJ-AAA"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"description": "プロジェクト概要",
|
||
"example": "プロジェクトの概要",
|
||
"nullable": true
|
||
},
|
||
"manager": {
|
||
"type": "object",
|
||
"description": "プロジェクトマネージャー",
|
||
"properties": {
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "ユーザID",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "氏名",
|
||
"example": "テスト太郎"
|
||
}
|
||
}
|
||
},
|
||
"color": {
|
||
"type": "string",
|
||
"description": "カラー",
|
||
"example": "#c8790f"
|
||
},
|
||
"from_date": {
|
||
"type": "string",
|
||
"description": "期間from",
|
||
"example": "2021-01-01"
|
||
},
|
||
"thru_date": {
|
||
"type": "string",
|
||
"description": "期間to",
|
||
"example": "2021-12-31"
|
||
},
|
||
"publish_to_employee": {
|
||
"type": "boolean",
|
||
"description": "従業員への公開設定",
|
||
"example": true
|
||
},
|
||
"assignment_url_enabled": {
|
||
"type": "boolean",
|
||
"description": "招待リンク",
|
||
"example": false
|
||
},
|
||
"operational_status": {
|
||
"type": "string",
|
||
"description": "運用ステータス",
|
||
"example": "in_progress"
|
||
},
|
||
"sales_order_status": {
|
||
"type": "string",
|
||
"description": "受注ステータス",
|
||
"example": "受注済み"
|
||
},
|
||
"members": {
|
||
"type": "array",
|
||
"description": "プロジェクトメンバー",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "ユーザID",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "氏名",
|
||
"example": "田中太郎"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"workload_tag_groups": {
|
||
"type": "array",
|
||
"description": "プロジェクトで使える工数タグのグループ",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_id": {
|
||
"type": "integer",
|
||
"description": "タググループID",
|
||
"example": 1
|
||
},
|
||
"tag_group_name": {
|
||
"type": "string",
|
||
"description": "タググループ名",
|
||
"example": "タググループA"
|
||
},
|
||
"required": {
|
||
"type": "boolean",
|
||
"description": "工数登録時に必須かどうかのフラグ",
|
||
"example": true
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"description": "タグ",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "タグID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "タグ名",
|
||
"example": "タグA"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"orderers": {
|
||
"type": "array",
|
||
"description": "発注元",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"partner_id": {
|
||
"type": "integer",
|
||
"description": "取引先ID",
|
||
"example": 1
|
||
},
|
||
"partner_name": {
|
||
"type": "string",
|
||
"description": "取引先名",
|
||
"example": "XX株式会社"
|
||
},
|
||
"partner_code": {
|
||
"type": "string",
|
||
"description": "取引先コード",
|
||
"example": "CORP-XX",
|
||
"nullable": true
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"contractors": {
|
||
"type": "array",
|
||
"description": "発注先",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"partner_id": {
|
||
"type": "integer",
|
||
"description": "取引先ID",
|
||
"example": 2
|
||
},
|
||
"partner_name": {
|
||
"type": "string",
|
||
"description": "取引先名",
|
||
"example": "CORP-YY"
|
||
},
|
||
"partner_code": {
|
||
"type": "string",
|
||
"description": "取引先コード",
|
||
"example": "YY株式会社",
|
||
"nullable": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"type": "object",
|
||
"properties": {
|
||
"common_business_id": {
|
||
"type": "string",
|
||
"description": "紐づいている案件マスタの案件ID",
|
||
"example": "01KRFQNTZAWSQF1284WE58ZS5K"
|
||
},
|
||
"balance": {
|
||
"type": "object",
|
||
"description": "収支管理詳細",
|
||
"properties": {
|
||
"labor_costs": {
|
||
"type": "object",
|
||
"description": "人件費",
|
||
"properties": {
|
||
"total": {
|
||
"type": "object",
|
||
"description": "全体",
|
||
"properties": {
|
||
"budget": {
|
||
"type": "integer",
|
||
"description": "予算",
|
||
"example": 100000
|
||
},
|
||
"actual_result": {
|
||
"type": "integer",
|
||
"description": "実績",
|
||
"example": 100000
|
||
}
|
||
}
|
||
},
|
||
"monthly": {
|
||
"type": "array",
|
||
"description": "各月",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"year_month": {
|
||
"type": "string",
|
||
"description": "年月（YYYY-MM）",
|
||
"example": "2021-01"
|
||
},
|
||
"budget": {
|
||
"type": "integer",
|
||
"description": "予算",
|
||
"example": 100000
|
||
},
|
||
"actual_result": {
|
||
"type": "integer",
|
||
"description": "実績",
|
||
"example": 100000
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"details": {
|
||
"type": "array",
|
||
"description": "各メンバーの内訳",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "ユーザーID",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "ユーザー名",
|
||
"example": "テスト太郎"
|
||
},
|
||
"total": {
|
||
"type": "object",
|
||
"properties": {
|
||
"budget": {
|
||
"type": "object",
|
||
"description": "予算",
|
||
"properties": {
|
||
"cost": {
|
||
"type": "integer",
|
||
"description": "金額",
|
||
"example": 100000
|
||
},
|
||
"minutes": {
|
||
"type": "integer",
|
||
"description": "時間",
|
||
"example": 9600
|
||
}
|
||
}
|
||
},
|
||
"actual_result": {
|
||
"type": "object",
|
||
"description": "実績",
|
||
"properties": {
|
||
"cost": {
|
||
"type": "integer",
|
||
"description": "金額",
|
||
"example": 100000
|
||
},
|
||
"minutes": {
|
||
"type": "integer",
|
||
"description": "時間",
|
||
"example": 9600
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"monthly": {
|
||
"type": "array",
|
||
"description": "各月",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"year_month": {
|
||
"type": "string",
|
||
"description": "年月（YYYY-MM）",
|
||
"example": "2021-01"
|
||
},
|
||
"budget": {
|
||
"type": "object",
|
||
"description": "予算",
|
||
"properties": {
|
||
"cost": {
|
||
"type": "integer",
|
||
"description": "金額",
|
||
"example": 100000
|
||
},
|
||
"minutes": {
|
||
"type": "integer",
|
||
"description": "時間",
|
||
"example": 9600
|
||
}
|
||
}
|
||
},
|
||
"actual_result": {
|
||
"type": "object",
|
||
"description": "実績",
|
||
"properties": {
|
||
"cost": {
|
||
"type": "integer",
|
||
"description": "金額",
|
||
"example": 100000
|
||
},
|
||
"minutes": {
|
||
"type": "integer",
|
||
"description": "時間",
|
||
"example": 9600
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"unit_cost": {
|
||
"type": "object",
|
||
"description": "従業員単価マスタ",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "単価マスタID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "単価マスタ名",
|
||
"example": "サンプル単価"
|
||
},
|
||
"current_cost": {
|
||
"type": "integer",
|
||
"description": "取得時点での適用金額",
|
||
"example": 2000
|
||
},
|
||
"rules": {
|
||
"type": "array",
|
||
"description": "期間ごとの適用金額の配列",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"from_date": {
|
||
"description": "適用開始日",
|
||
"type": "string",
|
||
"format": "date",
|
||
"example": "2020-01-01"
|
||
},
|
||
"thru_date": {
|
||
"description": "適用日終了日",
|
||
"type": "string",
|
||
"format": "date",
|
||
"example": "2020-12-31"
|
||
},
|
||
"cost": {
|
||
"type": "integer",
|
||
"description": "適用期間の金額",
|
||
"example": 3000
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"person": {
|
||
"type": "object",
|
||
"description": "従業員情報",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "従業員ID",
|
||
"example": 1
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "ステータス",
|
||
"example": "accepted"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "氏名",
|
||
"example": "田中太郎"
|
||
},
|
||
"role": {
|
||
"type": "string",
|
||
"description": "事業所におけるロール",
|
||
"example": "company_admin"
|
||
},
|
||
"role_display_name": {
|
||
"type": "string",
|
||
"description": "事業所におけるロールの表示名",
|
||
"example": "システム管理者"
|
||
},
|
||
"unit_cost": {
|
||
"type": "object",
|
||
"description": "標準単価",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "標準の従業員単価マスタID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "名前",
|
||
"example": "サンプル単価"
|
||
}
|
||
}
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"description": "メールアドレス",
|
||
"example": "test@example.com"
|
||
},
|
||
"payroll_employee_id": {
|
||
"type": "integer",
|
||
"description": "人事労務側従業員ID",
|
||
"example": 1
|
||
}
|
||
}
|
||
},
|
||
"partner": {
|
||
"type": "object",
|
||
"description": "取引先情報",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "取引先ID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "取引先名前",
|
||
"example": "〇〇株式会社"
|
||
},
|
||
"code": {
|
||
"type": "string",
|
||
"description": "取引先code",
|
||
"example": "001-〇〇株式会社-B",
|
||
"nullable": true
|
||
},
|
||
"projects_as_orderer": {
|
||
"type": "array",
|
||
"description": "発注元として登録されているプロジェクト一覧",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"project_id": {
|
||
"type": "integer",
|
||
"description": "プロジェクトID",
|
||
"example": 1
|
||
},
|
||
"project_name": {
|
||
"type": "string",
|
||
"description": "プロジェクト名",
|
||
"example": "プロジェクトX"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"projects_as_contractor": {
|
||
"type": "array",
|
||
"description": "発注先として登録されているプロジェクト一覧",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"project_id": {
|
||
"type": "integer",
|
||
"description": "プロジェクトID",
|
||
"example": 1
|
||
},
|
||
"project_name": {
|
||
"type": "string",
|
||
"description": "プロジェクト名",
|
||
"example": "プロジェクトX"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"workload": {
|
||
"type": "object",
|
||
"description": "工数実績詳細",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "工数実績ID",
|
||
"example": 1
|
||
},
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "対象従業員のユーザーID",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "対象従業員氏名",
|
||
"example": "テスト太郎"
|
||
},
|
||
"date": {
|
||
"type": "string",
|
||
"format": "date",
|
||
"description": "工数登録日",
|
||
"example": "2021-01-01"
|
||
},
|
||
"project_id": {
|
||
"description": "対象プロジェクトID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 100
|
||
},
|
||
"project_name": {
|
||
"type": "string",
|
||
"description": "プロジェクト名",
|
||
"example": "プロジェクトA"
|
||
},
|
||
"project_code": {
|
||
"type": "string",
|
||
"description": "プロジェクトコード",
|
||
"example": "PRJ-A"
|
||
},
|
||
"memo": {
|
||
"type": "string",
|
||
"description": "業務内容",
|
||
"example": "会議"
|
||
},
|
||
"minutes": {
|
||
"type": "integer",
|
||
"description": "工数実績（分）",
|
||
"example": 9600
|
||
},
|
||
"workload_tags": {
|
||
"type": "array",
|
||
"description": "工数タグ",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_id": {
|
||
"type": "integer",
|
||
"description": "タググループのID",
|
||
"example": 11
|
||
},
|
||
"tag_group_name": {
|
||
"type": "string",
|
||
"description": "タググループ名",
|
||
"example": "タググループA"
|
||
},
|
||
"tag_id": {
|
||
"type": "integer",
|
||
"description": "タグのID",
|
||
"example": 12,
|
||
"nullable": true
|
||
},
|
||
"tag_name": {
|
||
"type": "string",
|
||
"description": "タグ名",
|
||
"example": "タグA",
|
||
"nullable": true
|
||
}
|
||
},
|
||
"required": [
|
||
"tag_group_id",
|
||
"tag_group_name"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"person_id",
|
||
"person_name",
|
||
"project_id",
|
||
"project_name",
|
||
"project_code",
|
||
"date",
|
||
"minutes"
|
||
]
|
||
},
|
||
"create_workload_param": {
|
||
"type": "object",
|
||
"description": "工数情報",
|
||
"properties": {
|
||
"company_id": {
|
||
"description": "事業所ID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"person_id": {
|
||
"description": "\n対象従業員ID\nこのパラメータは管理者かチームリーダーでログインしているときのみ指定可能。\n指定しない場合はログインユーザに登録",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 10
|
||
},
|
||
"project_id": {
|
||
"description": "対象プロジェクトID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 100
|
||
},
|
||
"date": {
|
||
"description": "対象日",
|
||
"type": "string",
|
||
"format": "date",
|
||
"example": "2020-12-15"
|
||
},
|
||
"minutes": {
|
||
"description": "記録時間（分）",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"example": 120
|
||
},
|
||
"memo": {
|
||
"description": "業務内容",
|
||
"type": "string",
|
||
"maxLength": 255,
|
||
"example": "コーディング"
|
||
},
|
||
"workload_tags": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_id": {
|
||
"description": "工数タググループID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 11
|
||
},
|
||
"tag_id": {
|
||
"description": "工数タグID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 12
|
||
}
|
||
},
|
||
"required": [
|
||
"tag_group_id",
|
||
"tag_id"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"company_id",
|
||
"project_id",
|
||
"date",
|
||
"minutes"
|
||
]
|
||
},
|
||
"partial_update_workload_param": {
|
||
"type": "object",
|
||
"description": "工数更新情報。リクエストに含まれていないフィールドは更新されません。",
|
||
"properties": {
|
||
"company_id": {
|
||
"description": "事業所ID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"project_id": {
|
||
"description": "対象プロジェクトID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 100
|
||
},
|
||
"date": {
|
||
"description": "対象日",
|
||
"type": "string",
|
||
"format": "date",
|
||
"example": "2020-12-15"
|
||
},
|
||
"minutes": {
|
||
"description": "記録時間（分）",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"minimum": 1,
|
||
"maximum": 1440,
|
||
"example": 120
|
||
},
|
||
"memo": {
|
||
"description": "業務内容。null または空文字を指定すると削除されます。",
|
||
"type": "string",
|
||
"nullable": true,
|
||
"maxLength": 255,
|
||
"example": "コーディング"
|
||
},
|
||
"workload_tags": {
|
||
"description": "工数タグ。配列全体が指定内容で置き換えられます。null または空配列を指定すると削除されます。",
|
||
"type": "array",
|
||
"nullable": true,
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tag_group_id": {
|
||
"description": "工数タググループID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 11
|
||
},
|
||
"tag_id": {
|
||
"description": "工数タグID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 12
|
||
}
|
||
},
|
||
"required": [
|
||
"tag_group_id",
|
||
"tag_id"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"company_id"
|
||
]
|
||
},
|
||
"workload_summary": {
|
||
"type": "object",
|
||
"description": "工数実績サマリ",
|
||
"properties": {
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "対象従業員のユーザーid",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "対象従業員氏名",
|
||
"example": "テスト太郎"
|
||
},
|
||
"from_date": {
|
||
"type": "string",
|
||
"description": "工数登録期間from",
|
||
"example": "2021-01-01"
|
||
},
|
||
"thru_date": {
|
||
"type": "string",
|
||
"description": "工数登録期間to",
|
||
"example": "2021-12-31"
|
||
},
|
||
"minutes": {
|
||
"type": "integer",
|
||
"description": "工数実績（分）",
|
||
"example": 9600
|
||
},
|
||
"productive_minutes": {
|
||
"type": "integer",
|
||
"description": "生産時間実績（分）",
|
||
"example": 6000
|
||
}
|
||
}
|
||
},
|
||
"labor_budget": {
|
||
"type": "object",
|
||
"description": "人件費予算",
|
||
"properties": {
|
||
"project_id": {
|
||
"type": "integer",
|
||
"description": "対象プロジェクトID",
|
||
"example": 100
|
||
},
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "対象従業員ID",
|
||
"example": 1
|
||
},
|
||
"year_month": {
|
||
"type": "string",
|
||
"description": "対象年月（YYYY-MM）",
|
||
"example": "2026-06"
|
||
},
|
||
"cost": {
|
||
"type": "integer",
|
||
"description": "人件費予算の金額（円）",
|
||
"example": 40000
|
||
},
|
||
"hours": {
|
||
"type": "integer",
|
||
"description": "予定工数（時間）",
|
||
"example": 8
|
||
}
|
||
},
|
||
"required": [
|
||
"project_id",
|
||
"person_id",
|
||
"year_month",
|
||
"cost",
|
||
"hours"
|
||
]
|
||
},
|
||
"update_labor_budget_param": {
|
||
"type": "object",
|
||
"description": "人件費予算更新情報",
|
||
"properties": {
|
||
"company_id": {
|
||
"description": "事業所ID",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"hours": {
|
||
"description": "予定工数（時間）",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"minimum": 0,
|
||
"example": 8
|
||
}
|
||
},
|
||
"required": [
|
||
"company_id",
|
||
"hours"
|
||
]
|
||
},
|
||
"team": {
|
||
"type": "object",
|
||
"description": "チーム情報",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "チームID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "チーム名",
|
||
"example": "プロジェクトX開発チーム"
|
||
},
|
||
"memo": {
|
||
"type": "string",
|
||
"description": "memo",
|
||
"example": "社長室直轄",
|
||
"nullable": true
|
||
},
|
||
"member_count": {
|
||
"type": "integer",
|
||
"description": "メンバー数",
|
||
"example": 10
|
||
},
|
||
"members": {
|
||
"type": "array",
|
||
"description": "チームに登録されているメンバーの配列",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"person_id": {
|
||
"type": "integer",
|
||
"description": "チームに所属している従業員ID",
|
||
"example": 1
|
||
},
|
||
"person_name": {
|
||
"type": "string",
|
||
"description": "チームに所属している従業員名",
|
||
"example": "田中太郎"
|
||
},
|
||
"is_leader": {
|
||
"type": "boolean",
|
||
"description": "リーダフラグ、リーダならばtrue",
|
||
"example": true
|
||
}
|
||
},
|
||
"required": [
|
||
"person_id",
|
||
"person_name",
|
||
"is_leader"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"id",
|
||
"name",
|
||
"member_count"
|
||
]
|
||
},
|
||
"workload_tag_group": {
|
||
"type": "object",
|
||
"description": "工数タググループ（配下の工数タグを含む）",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "工数タググループID",
|
||
"example": 1
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "工数タググループ名",
|
||
"example": "工程"
|
||
},
|
||
"workload_tags": {
|
||
"type": "array",
|
||
"description": "配下の工数タグ",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "integer",
|
||
"description": "工数タグID",
|
||
"example": 10
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"description": "工数タグ名",
|
||
"example": "設計"
|
||
}
|
||
},
|
||
"required": [
|
||
"id",
|
||
"name"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"id",
|
||
"name",
|
||
"workload_tags"
|
||
]
|
||
},
|
||
"error": {
|
||
"type": "object",
|
||
"properties": {
|
||
"status_code": {
|
||
"type": "integer",
|
||
"example": 400,
|
||
"enum": [
|
||
400,
|
||
401,
|
||
402,
|
||
403,
|
||
404,
|
||
500
|
||
]
|
||
},
|
||
"errors": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"messages": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"example": "リクエストの形式が不正です。"
|
||
}
|
||
},
|
||
"type": {
|
||
"type": "string",
|
||
"example": "validate",
|
||
"enum": [
|
||
"status",
|
||
"validate",
|
||
"error",
|
||
"unauthorized",
|
||
"forbidden",
|
||
"record_not_found",
|
||
"resource_not_found",
|
||
"payment_required",
|
||
"bad_request",
|
||
"internal_server_error"
|
||
]
|
||
},
|
||
"codes": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"example": "company_not_found"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"meta": {
|
||
"type": "object",
|
||
"description": "ページネーションのメタ情報",
|
||
"properties": {
|
||
"current_offset": {
|
||
"type": "integer",
|
||
"description": "リクエストのオフセット件数",
|
||
"example": 50
|
||
},
|
||
"next_offset": {
|
||
"type": "integer",
|
||
"description": "次ページのオフセット件数",
|
||
"example": 100,
|
||
"nullable": true
|
||
},
|
||
"prev_offset": {
|
||
"type": "integer",
|
||
"description": "前ページのオフセット件数",
|
||
"example": 0,
|
||
"nullable": true
|
||
},
|
||
"total_count": {
|
||
"type": "integer",
|
||
"description": "全レコード件数",
|
||
"example": 200
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
} |