{ "openapi": "3.0.0", "info": { "title": "kouro.ai Public API", "version": "1.0.0", "description": "kouro.ai の申請ワークフローを、自作 UI・BFF・AI クライアントから操作するための公開 API です。\n\n- 認証は Bearer（個人アクセストークン、または組織サービストークン）。\n 組織サービストークンでは `X-Acting-User` で実行主体を表明します。\n- 一覧のうち `items` と `pageInfo` を返すものは `limit` / `cursor` のカーソルページングで返します。\n ページングを持たない収集系の operation もあります（打ち切ることがあるものを含む。各 operation の説明を参照）。\n- エラーは `{code, messageId, fieldErrors?}` の共通封筒で返します。\n\n実際に呼ぶ前に「はじめかた」と「共通の約束」を読んでください。" }, "servers": [ { "url": "https://api.kouro.ai", "description": "本番" } ], "components": { "schemas": { "PublicMessageCatalog": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1 }, "locale": { "type": "string", "enum": [ "ja" ] }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "httpStatusMessageIds": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "version", "locale", "messages", "httpStatusMessageIds" ], "additionalProperties": false }, "PublicErrorEnvelope": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "METHOD_NOT_ALLOWED", "AUTHENTICATION_REQUIRED", "INVALID_CREDENTIAL", "FORBIDDEN", "NOT_FOUND", "DATA_TYPE_NOT_FOUND", "DATA_NOT_FOUND", "CONFLICT", "IDEMPOTENCY_KEY_REUSED", "PRECONDITION_FAILED", "PAYLOAD_TOO_LARGE", "UNPROCESSABLE_ENTITY", "RATE_LIMITED", "SINGLE_PENDING", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT", "PRECONDITION_REQUIRED" ] }, "messageId": { "type": "string", "enum": [ "IU01000", "IU01001", "IU01002", "IU01003", "IU01004", "IU01005", "IU01006", "IU01007", "IU01008", "IU01009", "IU01010", "IU01011", "IU01012", "IU01013", "IU01014", "IU01015", "IU01016", "IU01017", "IU01018", "IU01019", "IU01020", "IU01021", "IU01022", "IU01023", "IU01024", "IU01025", "IU01026", "IU01027", "IU01028", "IU01029", "IU01030", "IU01031", "IU01032", "IU01033", "IU01034", "IU01035", "IU01036", "IU01037", "IU01038", "IU01039", "IU01040", "IU01041", "IU01042", "IU01043", "IU01044", "EU00001", "EU00002", "EU00003", "EU00004", "EU00005", "EU00006", "EU00007", "EU00008", "EU00009", "VU00001", "VU00002", "VU00003", "VU00004", "VU00005", "VU00006", "VU00007", "VU00008", "VU00010", "IU00200", "EU00080", "EU00084", "EU00085", "IU00229", "EU00081", "EU00082", "EU00083", "IU00201", "IU00202", "IU00203", "IU00204", "IU00205", "IU00206", "IU00207", "IU00208", "IU00209", "IU00210", "IU00211", "IU00212", "IU00213", "IU00214", "IU00215", "IU00216", "IU00217", "IU00218", "IU00219", "IU00220", "IU00221", "IU00222", "IU00223", "IU00224", "IU00225", "IU00226", "IU00227", "IU00228", "VU00011", "VU00009", "EU00055", "UI00001", "UI00002", "UI00003", "UI00004", "UI00005", "UI00006", "UI00007", "UI00008", "UI00009", "UI00010", "UI00011", "UI00012", "UI00013", "UI00014", "UI00015", "UI00016", "UI00017", "UI00018", "UI00019", "UI00020", "UI00021", "UI00022", "UI00023", "UI00024", "UI00025", "UI00026", "UI00027", "UI00028", "UI00029", "UI00030", "UI00031", "UI00032", "UI00033", "UI00034", "UI00035", "UI00036", "UI00037", "UI00038", "UI00039", "UI00040", "UI00041", "UI00042", "UI00043", "UI00044", "UI00045", "UI00046", "UI00047", "UI00048", "UI00049", "UI00050", "UI00051", "UI00052", "UI00053", "UI00054", "UI00055", "UI00056", "UI00057", "UI00058", "UI00059", "UI00060", "UI00061", "UI00062", "UI00063", "UI00064", "UI00065", "UI00066", "UI00067", "UI00068", "UI00069", "UI00070", "UI00071", "UI00072", "UI00073", "UI00074", "UI00075", "UI00076", "UI00102", "UI00103", "UI00077", "UI00078", "UI00079", "UI00080", "UI00081", "UI00082", "UI00083", "UI00084", "UI00085", "UI00086", "UI00087", "UI00088", "UI00089", "UI00090", "UI00091", "UI00092", "UI00093", "UI00094", "UI00095", "UI00096", "UI00097", "UI00098", "UI00099", "UI00100", "UI00101", "UI00104", "SU00033", "UI00105", "UI00106", "UI00107", "UI00108", "UI00109", "EU00010", "EU00011", "EU00012", "EU00013", "EU00014", "EU00015", "EU00016", "EU00017", "EU00018", "EU00019", "EU00020", "EU00021", "EU00022", "EU00023", "EU00024", "EU00025", "EU00026", "EU00027", "EU00028", "EU00029", "EU00030", "EU00031", "EU00032", "EU00033", "EU00034", "EU00035", "EU00036", "EU00037", "EU00038", "EU00039", "EU00040", "EU00041", "EU00042", "EU00043", "EU00044", "EU00045", "EU00046", "EU00047", "EU00048", "EU00049", "EU00050", "EU00051", "EU00052", "EU00053", "EU00054", "EU00056", "EU00057", "EU00058", "EU00059", "EU00060", "EU00061", "EU00062", "EU00063", "EU00066", "EU00064", "EU00065", "EU00067", "EU00068", "IU00001", "IU00002", "IU00003", "IU00004", "IU00005", "IU00006", "IU00007", "IU00008", "IU00009", "IU00010", "IU00011", "IU00012", "IU00013", "IU00014", "IU00015", "IU00016", "IU00017", "IU00018", "IU00019", "IU00020", "IU00021", "IU00022", "IU00023", "IU00024", "IU00025", "IU00026", "IU00027", "IU00028", "IU00029", "IU00030", "IU00031", "IU00032", "IU00033", "IU00034", "IU00035", "IU00036", "IU00037", "IU00038", "IU00039", "IU00040", "IU00041", "IU00042", "IU00043", "IU00044", "IU00045", "IU00046", "IU00047", "IU00048", "IU00049", "IU00050", "IU00051", "IU00052", "IU00053", "IU00054", "IU00055", "IU00056", "IU00057", "IU00058", "IU00059", "IU00060", "IU00061", "IU00062", "IU00063", "IU00064", "IU00065", "IU00066", "IU00067", "IU00068", "IU00069", "IU00070", "IU00071", "IU00072", "IU00073", "IU00074", "IU00075", "IU00076", "IU00077", "IU00078", "IU00079", "IU00080", "IU00081", "IU00082", "IU00083", "IU00084", "IU00085", "IU00086", "IU00087", "IU00088", "IU00089", "IU00090", "IU00091", "IU00092", "IU00093", "IU00094", "IU00095", "IU00096", "IU00097", "IU00098", "IU00099", "IU00100", "IU00101", "IU00102", "IU00103", "IU00104", "IU00105", "IU00106", "IU00107", "IU00108", "IU00109", "IU00110", "IU00111", "IU00112", "IU00113", "IU00114", "IU00115", "IU00116", "IU00117", "IU00118", "IU00119", "IU00120", "IU00121", "IU00122", "IU00123", "IU00124", "IU00125", "IU00126", "IU00127", "IU00128", "IU00129", "IU00130", "IU00131", "IU00132", "IU00133", "IU00134", "IU00135", "IU00136", "IU00137", "IU00138", "IU00139", "SU00001", "SU00002", "SU00003", "SU00004", "SU00005", "SU00006", "SU00007", "SU00008", "SU00009", "SU00010", "SU00011", "SU00012", "SU00013", "SU00014", "SU00015", "SU00016", "SU00017", "SU00018", "SU00019", "SU00020", "SU00021", "SU00022", "SU00023", "SU00024", "SU00025", "SU00026", "SU00027", "SU00028", "SU00029", "SU00030", "SU00031", "SU00032" ] }, "fieldErrors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "pattern": "^(?:\\/(?:[^~/]|~[01])*)*$" }, "messageId": { "type": "string", "enum": [ "IU01000", "IU01001", "IU01002", "IU01003", "IU01004", "IU01005", "IU01006", "IU01007", "IU01008", "IU01009", "IU01010", "IU01011", "IU01012", "IU01013", "IU01014", "IU01015", "IU01016", "IU01017", "IU01018", "IU01019", "IU01020", "IU01021", "IU01022", "IU01023", "IU01024", "IU01025", "IU01026", "IU01027", "IU01028", "IU01029", "IU01030", "IU01031", "IU01032", "IU01033", "IU01034", "IU01035", "IU01036", "IU01037", "IU01038", "IU01039", "IU01040", "IU01041", "IU01042", "IU01043", "IU01044", "EU00001", "EU00002", "EU00003", "EU00004", "EU00005", "EU00006", "EU00007", "EU00008", "EU00009", "VU00001", "VU00002", "VU00003", "VU00004", "VU00005", "VU00006", "VU00007", "VU00008", "VU00010", "IU00200", "EU00080", "EU00084", "EU00085", "IU00229", "EU00081", "EU00082", "EU00083", "IU00201", "IU00202", "IU00203", "IU00204", "IU00205", "IU00206", "IU00207", "IU00208", "IU00209", "IU00210", "IU00211", "IU00212", "IU00213", "IU00214", "IU00215", "IU00216", "IU00217", "IU00218", "IU00219", "IU00220", "IU00221", "IU00222", "IU00223", "IU00224", "IU00225", "IU00226", "IU00227", "IU00228", "VU00011", "VU00009", "EU00055", "UI00001", "UI00002", "UI00003", "UI00004", "UI00005", "UI00006", "UI00007", "UI00008", "UI00009", "UI00010", "UI00011", "UI00012", "UI00013", "UI00014", "UI00015", "UI00016", "UI00017", "UI00018", "UI00019", "UI00020", "UI00021", "UI00022", "UI00023", "UI00024", "UI00025", "UI00026", "UI00027", "UI00028", "UI00029", "UI00030", "UI00031", "UI00032", "UI00033", "UI00034", "UI00035", "UI00036", "UI00037", "UI00038", "UI00039", "UI00040", "UI00041", "UI00042", "UI00043", "UI00044", "UI00045", "UI00046", "UI00047", "UI00048", "UI00049", "UI00050", "UI00051", "UI00052", "UI00053", "UI00054", "UI00055", "UI00056", "UI00057", "UI00058", "UI00059", "UI00060", "UI00061", "UI00062", "UI00063", "UI00064", "UI00065", "UI00066", "UI00067", "UI00068", "UI00069", "UI00070", "UI00071", "UI00072", "UI00073", "UI00074", "UI00075", "UI00076", "UI00102", "UI00103", "UI00077", "UI00078", "UI00079", "UI00080", "UI00081", "UI00082", "UI00083", "UI00084", "UI00085", "UI00086", "UI00087", "UI00088", "UI00089", "UI00090", "UI00091", "UI00092", "UI00093", "UI00094", "UI00095", "UI00096", "UI00097", "UI00098", "UI00099", "UI00100", "UI00101", "UI00104", "SU00033", "UI00105", "UI00106", "UI00107", "UI00108", "UI00109", "EU00010", "EU00011", "EU00012", "EU00013", "EU00014", "EU00015", "EU00016", "EU00017", "EU00018", "EU00019", "EU00020", "EU00021", "EU00022", "EU00023", "EU00024", "EU00025", "EU00026", "EU00027", "EU00028", "EU00029", "EU00030", "EU00031", "EU00032", "EU00033", "EU00034", "EU00035", "EU00036", "EU00037", "EU00038", "EU00039", "EU00040", "EU00041", "EU00042", "EU00043", "EU00044", "EU00045", "EU00046", "EU00047", "EU00048", "EU00049", "EU00050", "EU00051", "EU00052", "EU00053", "EU00054", "EU00056", "EU00057", "EU00058", "EU00059", "EU00060", "EU00061", "EU00062", "EU00063", "EU00066", "EU00064", "EU00065", "EU00067", "EU00068", "IU00001", "IU00002", "IU00003", "IU00004", "IU00005", "IU00006", "IU00007", "IU00008", "IU00009", "IU00010", "IU00011", "IU00012", "IU00013", "IU00014", "IU00015", "IU00016", "IU00017", "IU00018", "IU00019", "IU00020", "IU00021", "IU00022", "IU00023", "IU00024", "IU00025", "IU00026", "IU00027", "IU00028", "IU00029", "IU00030", "IU00031", "IU00032", "IU00033", "IU00034", "IU00035", "IU00036", "IU00037", "IU00038", "IU00039", "IU00040", "IU00041", "IU00042", "IU00043", "IU00044", "IU00045", "IU00046", "IU00047", "IU00048", "IU00049", "IU00050", "IU00051", "IU00052", "IU00053", "IU00054", "IU00055", "IU00056", "IU00057", "IU00058", "IU00059", "IU00060", "IU00061", "IU00062", "IU00063", "IU00064", "IU00065", "IU00066", "IU00067", "IU00068", "IU00069", "IU00070", "IU00071", "IU00072", "IU00073", "IU00074", "IU00075", "IU00076", "IU00077", "IU00078", "IU00079", "IU00080", "IU00081", "IU00082", "IU00083", "IU00084", "IU00085", "IU00086", "IU00087", "IU00088", "IU00089", "IU00090", "IU00091", "IU00092", "IU00093", "IU00094", "IU00095", "IU00096", "IU00097", "IU00098", "IU00099", "IU00100", "IU00101", "IU00102", "IU00103", "IU00104", "IU00105", "IU00106", "IU00107", "IU00108", "IU00109", "IU00110", "IU00111", "IU00112", "IU00113", "IU00114", "IU00115", "IU00116", "IU00117", "IU00118", "IU00119", "IU00120", "IU00121", "IU00122", "IU00123", "IU00124", "IU00125", "IU00126", "IU00127", "IU00128", "IU00129", "IU00130", "IU00131", "IU00132", "IU00133", "IU00134", "IU00135", "IU00136", "IU00137", "IU00138", "IU00139", "SU00001", "SU00002", "SU00003", "SU00004", "SU00005", "SU00006", "SU00007", "SU00008", "SU00009", "SU00010", "SU00011", "SU00012", "SU00013", "SU00014", "SU00015", "SU00016", "SU00017", "SU00018", "SU00019", "SU00020", "SU00021", "SU00022", "SU00023", "SU00024", "SU00025", "SU00026", "SU00027", "SU00028", "SU00029", "SU00030", "SU00031", "SU00032" ] }, "args": { "type": "array", "items": { "type": "string" } } }, "required": [ "path", "messageId" ], "additionalProperties": false } } }, "required": [ "code", "messageId" ], "additionalProperties": false }, "PublicFormField": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "text" ] }, "maxLength": { "type": "integer", "minimum": 1 }, "pattern": { "type": "string" }, "defaultValueSource": { "type": "string", "minLength": 1 }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "textarea" ] }, "maxLength": { "type": "integer", "minimum": 1 }, "defaultValue": { "type": "string" }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "number" ] }, "min": { "type": "number" }, "max": { "type": "number" }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "number" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "money" ] }, "min": { "type": "integer" }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "number" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label", "format" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "date" ] }, "format": { "type": "string", "enum": [ "YYYY-MM-DD", "YYYY-MM" ] }, "defaultToday": { "type": "boolean" }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "datetime" ] }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "time" ] }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "postal" ] }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label", "options" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "select" ] }, "options": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "value", "label" ], "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } } }, "optionsSource": { "type": "string", "minLength": 1 }, "optionsQuery": { "type": "object", "additionalProperties": false, "required": [ "source", "labelColumn", "valueColumn", "orderColumn" ], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } }, "creatable": { "type": "boolean" }, "defaultValue": { "type": "string", "minLength": 1 }, "defaultValueSource": { "type": "string", "minLength": 1 }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label", "options" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "multiselect" ] }, "options": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "value", "label" ], "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } } }, "optionsSource": { "type": "string", "minLength": 1 }, "optionsQuery": { "type": "object", "additionalProperties": false, "required": [ "source", "labelColumn", "valueColumn", "orderColumn" ], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "checkbox" ] }, "mustBeTrue": { "type": "boolean" }, "defaultValue": { "type": "boolean" }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "boolean" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "file" ] }, "multiple": { "type": "boolean" }, "accept": { "type": "string" }, "maxBytes": { "type": "integer", "minimum": 1 } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label", "fields" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "group" ] }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } }, "maxItems": { "type": "integer", "minimum": 1 }, "readOnly": { "type": "boolean" }, "removalTracking": { "type": "object", "additionalProperties": false, "required": [ "target" ], "properties": { "target": { "type": "string", "minLength": 1 }, "idKey": { "type": "string", "minLength": 1 }, "carry": { "type": "array", "items": { "type": "string", "minLength": 1 } } } }, "rowIdentityKey": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "defaultValueSource": { "type": "string", "minLength": 1 }, "persistedEditableKeys": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label", "options" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "select" ] }, "options": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "value", "label" ], "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } } }, "optionsSource": { "type": "string", "minLength": 1 }, "optionsQuery": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "source", "labelColumn", "valueColumn", "orderColumn" ], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } }, { "type": "array", "minItems": 1, "maxItems": 64, "items": { "type": "object", "additionalProperties": false, "required": [ "when", "query" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "query": { "type": "object", "additionalProperties": false, "required": [ "source", "labelColumn", "valueColumn", "orderColumn" ], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } } } } } ] }, "selectedLabelTarget": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "creatable": { "type": "boolean" }, "defaultValue": { "type": "string", "minLength": 1 }, "defaultValueSource": { "type": "string", "minLength": 1 }, "defaultValueWhen": { "type": "object", "additionalProperties": false, "required": [ "when", "value" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "value": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "type", "key", "label", "options" ], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "enabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "disabledWhen": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "type": { "type": "string", "enum": [ "multiselect" ] }, "options": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "value", "label" ], "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } } }, "optionsSource": { "type": "string", "minLength": 1 }, "optionsQuery": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "source", "labelColumn", "valueColumn", "orderColumn" ], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } }, { "type": "array", "minItems": 1, "maxItems": 64, "items": { "type": "object", "additionalProperties": false, "required": [ "when", "query" ], "properties": { "when": { "$ref": "#/components/schemas/PublicRequiredWhen" }, "query": { "type": "object", "additionalProperties": false, "required": [ "source", "labelColumn", "valueColumn", "orderColumn" ], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } } } } } ] } } } ] }, "PublicFormSchema": { "type": "object", "properties": { "applicant": { "type": "object", "properties": { "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "title": { "type": "string", "minLength": 1 }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } } }, "required": [ "key", "title", "fields" ], "additionalProperties": false } } }, "required": [ "sections" ], "additionalProperties": false }, "nodeForms": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } } }, "required": [ "fields" ], "additionalProperties": false } }, "rules": { "type": "string", "minLength": 1 } }, "required": [ "applicant", "nodeForms", "rules" ], "additionalProperties": false }, "PublicApplicationType": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "HR", "GA", "SALES" ] }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" }, "initiationType": { "type": "string", "enum": [ "USER", "BUSINESS_SCREEN" ] }, "mode": { "type": "string", "enum": [ "STANDARD", "IMMEDIATE" ] } }, "required": [ "code", "name", "category", "formSchema" ], "additionalProperties": false }, "PublicApplicationTarget": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false }, "PublicImmediateExecutionResponse": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "COMPLETED" ] }, "application": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "APPROVED" ] }, "completedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "serialNo", "status", "completedAt" ] } }, "required": [ "outcome", "application" ], "additionalProperties": false }, "PublicImmediateExecutionRequest": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 60 }, "expectedFlowDefinitionId": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "executionId", "expectedFlowDefinitionId", "data" ], "additionalProperties": false }, "PublicImmediateExecutionMultipart": { "type": "object", "properties": { "payload": { "type": "string", "minLength": 1, "description": "JSON execution input; multipart also accepts fileSlots: [{part, groupKey, rowKey, fieldKey}] to address row files. Each part and slot is unique; multiple files may repeat a declared part." } }, "required": [ "payload" ] }, "PublicApplicationTargetDetail": { "type": "object", "properties": { "applicationType": { "type": "string", "minLength": 1 }, "targetId": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "editableKeys": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "string", "minLength": 1 } }, "required": [ "applicationType", "targetId", "data", "editableKeys", "revision" ], "additionalProperties": false }, "PublicFormOption": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "value", "label" ], "additionalProperties": false }, "PublicFieldEffectValues": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": { "nullable": true } }, "revision": { "type": "string", "minLength": 1 } }, "required": [ "values", "revision" ], "additionalProperties": false }, "PublicApplicationTypeInitiation": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "STANDARD" ] }, "flowDefinitionId": { "type": "string", "minLength": 1 }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" } }, "required": [ "mode", "flowDefinitionId", "formSchema" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "IMMEDIATE" ] }, "flowDefinitionId": { "type": "string", "minLength": 1 }, "capabilityKey": { "type": "string", "minLength": 1 }, "actionLabel": { "type": "string", "minLength": 1 }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" } }, "required": [ "mode", "flowDefinitionId", "capabilityKey", "actionLabel", "formSchema" ], "additionalProperties": false } ] }, "PublicApplicationSummary": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "applicationType": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": [ "IMMEDIATE", "WORKFLOW" ] }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "completedAt": { "type": "string", "nullable": true, "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "serialNo", "title", "applicationType", "status", "approvalMode", "submittedAt", "completedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "PublicApplicationRuntimeView": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": [ "IMMEDIATE", "WORKFLOW" ] }, "applicationType": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "resourceId": { "type": "string", "minLength": 1 }, "relation": { "type": "string", "minLength": 1 }, "isProvisional": { "type": "boolean" } }, "required": [ "resourceType", "resourceId", "relation", "isProvisional" ] } }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" }, "currentNodeKey": { "type": "string" }, "currentTaskId": { "type": "string", "minLength": 1 }, "currentNodeForm": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } } }, "required": [ "fields" ], "additionalProperties": false }, "currentNodeType": { "type": "string", "enum": [ "APPROVAL", "INPUT", "APPROVAL_WITH_INPUT", "TASK", "AWAIT", "NOTIFY" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "completedAt": { "type": "string", "nullable": true, "format": "date-time" }, "availableActions": { "type": "array", "items": { "type": "string", "enum": [ "withdraw", "approve", "sendBack", "reject", "reapply", "edit", "discard", "submitInput", "provideInput" ] } }, "lastComment": { "type": "string" }, "taskInputs": { "type": "array", "items": { "type": "object", "properties": { "taskId": { "type": "string", "minLength": 1 }, "inputFace": { "type": "string", "enum": [ "applicant" ] }, "formKey": { "type": "string" }, "nodeKey": { "type": "string", "minLength": 1 }, "taskName": { "type": "string", "minLength": 1 }, "actorName": { "type": "string", "nullable": true }, "actedAt": { "type": "string", "format": "date-time" }, "inputData": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "nodeKey", "taskName", "actorName", "actedAt", "inputData" ] } } }, "required": [ "id", "serialNo", "title", "status", "approvalMode", "applicationType", "data", "targets", "formSchema", "createdAt", "updatedAt", "submittedAt", "availableActions" ], "additionalProperties": false }, "PublicApplicationSummaryCounts": { "type": "object", "properties": { "approvalMode": { "type": "string", "enum": [ "WORKFLOW" ] }, "draft": { "type": "integer", "minimum": 0 }, "inReview": { "type": "integer", "minimum": 0 }, "sentBack": { "type": "integer", "minimum": 0 }, "approvedThisMonth": { "type": "integer", "minimum": 0 } }, "required": [ "approvalMode", "draft", "inReview", "sentBack", "approvedThisMonth" ], "additionalProperties": false }, "PublicUpcomingApproval": { "type": "object", "properties": { "applicationId": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "SENT_BACK", "BLOCKED" ] }, "applicantId": { "type": "string", "minLength": 1 }, "applicantName": { "type": "string" }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "nodeKey": { "type": "string", "minLength": 1 }, "nodeName": { "type": "string", "minLength": 1 }, "canOpenDetail": { "type": "boolean" } }, "required": [ "applicationId", "serialNo", "title", "status", "applicantId", "applicantName", "submittedAt", "nodeKey", "nodeName", "canOpenDetail" ], "additionalProperties": false }, "PublicNotificationSummary": { "type": "object", "properties": { "sentBack": { "type": "integer", "minimum": 0 }, "pendingApproval": { "type": "integer", "minimum": 0 }, "completedUnread": { "type": "integer", "minimum": 0 } }, "required": [ "sentBack", "pendingApproval", "completedUnread" ], "additionalProperties": false }, "PublicApplicationEvents": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SUBMITTED", "APPROVED", "SENT_BACK", "REJECTED", "WITHDRAWN", "COMMENTED", "TASK_INPUT", "REAPPLIED", "RECOVERED", "BLOCKED", "SKIPPED", "CHILDREN_SELECTED", "CHILD_FIRED", "CHILD_FIRE_SKIPPED", "CHILD_COMPLETED", "AWAIT_SATISFIED", "AWAIT_ESCALATED", "PARENT_CANCELLED", "INPUT_REQUIRED", "INPUT_SUBMITTED", "CREATED", "DRAFT_UPDATED" ] }, "actorName": { "type": "string", "nullable": true }, "isOwn": { "type": "boolean" }, "comment": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "actorName", "isOwn", "occurredAt" ], "additionalProperties": false } } }, "required": [ "events" ], "additionalProperties": false }, "PublicApplicationFlow": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "nodeKey": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "approval", "approval_with_input", "input", "task", "await", "notify", "terminal" ] }, "status": { "type": "string", "enum": [ "approved", "current", "pending", "skipped", "blocked", "rejected", "sentBack" ] }, "assigneeName": { "type": "string", "nullable": true }, "actedAt": { "type": "string", "format": "date-time" }, "linkedApplicationId": { "type": "string", "minLength": 1 } }, "required": [ "nodeKey", "name", "kind", "status", "assigneeName" ], "additionalProperties": false } } }, "required": [ "steps" ], "additionalProperties": false }, "PublicCreateApplicationRequest": { "type": "object", "properties": { "applicationType": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "applicationType", "data" ], "additionalProperties": false }, "PublicApprovalTask": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "applicationId": { "type": "string", "minLength": 1 }, "nodeKey": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "APPROVAL", "INPUT", "APPROVAL_WITH_INPUT", "TASK", "AWAIT", "NOTIFY" ] }, "createdAt": { "type": "string", "format": "date-time" }, "inputSchema": { "nullable": true }, "availableActions": { "type": "array", "items": { "type": "string", "enum": [ "approve", "reject", "sendBack" ] } } }, "required": [ "id", "applicationId", "nodeKey", "name", "type", "createdAt", "availableActions" ], "additionalProperties": false }, "PublicApplication": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "applicationType": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": [ "IMMEDIATE", "WORKFLOW" ] }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "completedAt": { "type": "string", "nullable": true, "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" }, "currentTask": { "$ref": "#/components/schemas/PublicApprovalTask" }, "availableActions": { "type": "array", "items": { "type": "string", "enum": [ "update", "delete", "submit", "withdraw", "reapply" ] } } }, "required": [ "id", "serialNo", "title", "applicationType", "status", "approvalMode", "submittedAt", "completedAt", "createdAt", "updatedAt", "data", "formSchema", "currentTask", "availableActions" ], "additionalProperties": false }, "PublicUpdateApplicationRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "data" ], "additionalProperties": false }, "PublicReapplyApplicationRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "nullable": true } }, "comment": { "type": "string", "minLength": 1 } }, "additionalProperties": false }, "PublicApplicationHistoryItem": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "SUBMITTED", "APPROVED", "SENT_BACK", "REJECTED", "WITHDRAWN", "COMMENTED", "TASK_INPUT", "REAPPLIED", "RECOVERED", "BLOCKED", "SKIPPED", "CHILDREN_SELECTED", "CHILD_FIRED", "CHILD_FIRE_SKIPPED", "CHILD_COMPLETED", "AWAIT_SATISFIED", "AWAIT_ESCALATED", "PARENT_CANCELLED", "INPUT_REQUIRED", "INPUT_SUBMITTED", "CREATED", "DRAFT_UPDATED" ] }, "actorName": { "type": "string", "nullable": true }, "comment": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "type", "actorName", "occurredAt" ], "additionalProperties": false }, "PublicSendBackTarget": { "type": "object", "properties": { "nodeKey": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "nodeKey", "label" ], "additionalProperties": false }, "PublicApproveTaskRequest": { "type": "object", "properties": { "inputData": { "type": "object", "additionalProperties": { "nullable": true } } }, "additionalProperties": false }, "PublicRejectTaskRequest": { "type": "object", "properties": { "comment": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "comment" ], "additionalProperties": false }, "PublicSendBackTaskRequest": { "type": "object", "properties": { "toNodeKey": { "type": "string", "minLength": 1 }, "comment": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "toNodeKey", "comment" ], "additionalProperties": false }, "PublicApplicationComment": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "body": { "type": "string", "nullable": true }, "authorId": { "type": "string", "minLength": 1 }, "authorName": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "deletedAt": { "type": "string", "nullable": true }, "isOwn": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } }, "required": [ "id", "body", "authorId", "authorName", "createdAt", "updatedAt", "version", "deletedAt", "isOwn", "canEdit", "canDelete" ], "additionalProperties": false }, "PublicPostApplicationComment": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "body" ], "additionalProperties": false }, "PublicUpdateApplicationComment": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 2000 }, "expectedVersion": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": [ "body", "expectedVersion" ], "additionalProperties": false }, "PublicApplicationInput": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "nullable": true } }, "inputData": { "type": "object", "additionalProperties": { "nullable": true } }, "comment": { "type": "string" } }, "additionalProperties": false }, "PublicApprovalInput": { "type": "object", "properties": { "inputData": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "inputData" ], "additionalProperties": false }, "PublicAttachment": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "minLength": 1 }, "fileName": { "type": "string", "minLength": 1 }, "mimeType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "taskId": { "type": "string", "nullable": true, "minLength": 1 }, "groupKey": { "type": "string", "nullable": true, "minLength": 1 }, "rowKey": { "type": "string", "nullable": true, "minLength": 1 }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "fieldKey", "fileName", "mimeType", "sizeBytes", "createdAt" ], "additionalProperties": false }, "PublicMe": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "email": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": [ "id", "organizationId", "email", "sei", "mei" ], "additionalProperties": false }, "availableOperations": { "type": "array", "items": { "type": "string" } } }, "required": [ "user", "availableOperations" ], "additionalProperties": false }, "PublicNotification": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string", "nullable": true }, "applicationId": { "type": "string", "nullable": true }, "approvalMode": { "type": "string", "nullable": true, "enum": [ "IMMEDIATE", "WORKFLOW" ] }, "isRead": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "readAt": { "type": "string", "nullable": true, "format": "date-time" } }, "required": [ "id", "kind", "title", "body", "applicationId", "approvalMode", "isRead", "createdAt", "readAt" ], "additionalProperties": false }, "PublicNotificationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicNotification" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicDepartment": { "type": "object", "properties": { "id": { "type": "string" }, "parentId": { "type": "string", "nullable": true }, "code": { "type": "string" }, "name": { "type": "string" }, "sortOrder": { "type": "integer" } }, "required": [ "id", "parentId", "code", "name", "sortOrder" ], "additionalProperties": false }, "PublicDepartmentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDepartment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicPosition": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": "integer" } }, "required": [ "id", "code", "name", "rank" ], "additionalProperties": false }, "PublicPositionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPosition" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicEmployeeSummary": { "type": "object", "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "ACTIVE", "ON_LEAVE", "PENDING_RETIREMENT", "RETIRED" ] }, "personType": { "type": "string", "enum": [ "EMPLOYEE", "BP_MEMBER" ] }, "company": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "position": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "departments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "isLead": { "type": "boolean" } }, "required": [ "id", "path", "isLead" ], "additionalProperties": false } } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "status", "personType", "company", "position", "departments" ], "additionalProperties": false }, "PublicEmployeePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicEmployeeSummary" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicEmployeeDetail": { "type": "object", "properties": { "employeeId": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "employeeId", "values" ], "additionalProperties": false }, "PublicEmployeeField": { "type": "object", "properties": { "key": { "type": "string" }, "valueType": { "type": "string", "enum": [ "string", "date", "enum", "object" ] }, "cardinality": { "type": "string", "enum": [ "one", "many" ] }, "nullable": { "type": "boolean" }, "pii": { "type": "boolean" }, "display": { "type": "object", "properties": { "label": { "type": "string" }, "group": { "type": "string" }, "order": { "type": "integer" } }, "required": [ "label", "group", "order" ], "additionalProperties": false } }, "required": [ "key", "valueType", "cardinality", "nullable", "pii", "display" ], "additionalProperties": false }, "PublicEmployeeFieldCatalog": { "type": "object", "properties": { "version": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "order": { "type": "integer" } }, "required": [ "key", "label", "order" ], "additionalProperties": false } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicEmployeeField" } } }, "required": [ "version", "groups", "fields" ], "additionalProperties": false }, "PublicOrganizationChartDepartment": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parentId": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer" } }, "required": [ "id", "name", "parentId", "sortOrder" ], "additionalProperties": false }, "PublicOrganizationChartDepartmentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOrganizationChartDepartment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicOrganizationChartMember": { "type": "object", "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "positionName": { "type": "string", "nullable": true }, "departmentIds": { "type": "array", "items": { "type": "string" } }, "leadDepartmentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "positionName", "departmentIds", "leadDepartmentIds" ], "additionalProperties": false }, "PublicOrganizationChartMemberPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOrganizationChartMember" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicProject": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "clientName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "ACTIVE", "CLOSED" ] } }, "required": [ "id", "name", "clientName", "startDate", "endDate", "status" ], "additionalProperties": false }, "PublicProjectPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicProject" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicProjectCustomerLoan": { "type": "object", "properties": { "id": { "type": "string" }, "equipmentId": { "type": "string" }, "equipmentName": { "type": "string" }, "lentOn": { "type": "string" }, "dueOn": { "type": "string", "nullable": true }, "returnedOn": { "type": "string", "nullable": true } }, "required": [ "id", "equipmentId", "equipmentName", "lentOn", "dueOn", "returnedOn" ], "additionalProperties": false }, "PublicProjectCustomerLoanAssignment": { "type": "object", "properties": { "assignmentId": { "type": "string" }, "userId": { "type": "string" }, "userName": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "LEFT" ] }, "lendings": { "type": "array", "items": { "$ref": "#/components/schemas/PublicProjectCustomerLoan" } } }, "required": [ "assignmentId", "userId", "userName", "status", "lendings" ], "additionalProperties": false }, "PublicProjectCustomerLoanRecords": { "type": "object", "properties": { "projectId": { "type": "string" }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "assignmentId": { "type": "string" }, "userId": { "type": "string" }, "userName": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "LEFT" ] }, "canLend": { "type": "boolean" }, "lendings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "itemName": { "type": "string" }, "lentOn": { "type": "string" }, "dueOn": { "type": "string", "nullable": true }, "returnedOn": { "type": "string", "nullable": true } }, "required": [ "id", "itemName", "lentOn", "dueOn", "returnedOn" ], "additionalProperties": false } } }, "required": [ "assignmentId", "userId", "userName", "status", "canLend", "lendings" ], "additionalProperties": false } } }, "required": [ "projectId", "assignments" ], "additionalProperties": false, "description": "Current customer-loan records, independent of the equipment inventory. Always returned by the current service." }, "PublicProjectCustomerLoans": { "type": "object", "properties": { "projectId": { "type": "string" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/PublicProjectCustomerLoanAssignment" }, "description": "Deprecated inventory-linked assignments; empty after customer-loan cutover." }, "records": { "$ref": "#/components/schemas/PublicProjectCustomerLoanRecords" }, "availableEquipment": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "projectId", "assignments", "availableEquipment" ], "additionalProperties": false }, "PublicOffice": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "postalCode": { "type": "string", "nullable": true }, "prefecture": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "otherAddress": { "type": "string", "nullable": true }, "building": { "type": "string", "nullable": true } }, "required": [ "id", "code", "name", "postalCode", "prefecture", "city", "otherAddress", "building" ], "additionalProperties": false }, "PublicOfficePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOffice" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicWorkingHours": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "breakStartTime": { "type": "string", "nullable": true }, "breakEndTime": { "type": "string", "nullable": true }, "breaks": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "endTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "startTime", "endTime" ], "additionalProperties": false }, "maxItems": 10 }, "workingMinutes": { "type": "integer" }, "breakMinutes": { "type": "integer" } }, "required": [ "id", "name", "startTime", "endTime", "breakStartTime", "breakEndTime", "workingMinutes", "breakMinutes" ], "additionalProperties": false }, "PublicWorkingHoursPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicWorkingHours" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicExpense": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "accountTitle": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "id", "name" ], "additionalProperties": false }, "subAccountTitle": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "name", "accountTitle", "subAccountTitle" ], "additionalProperties": false }, "PublicExpensePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicExpense" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicInternalAnnouncement": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "body": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "nullable": true, "format": "date-time" } }, "required": [ "id", "title", "body", "publishedAt", "expiresAt" ], "additionalProperties": false }, "PublicInternalAnnouncementPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicInternalAnnouncement" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicEquipment": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER" ] }, "productName": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "managementNo": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "enum": [ "PURCHASED", "CLIENT_LOAN" ] }, "clientDedicated": { "type": "boolean" }, "remarks": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 2000 }, "id": { "type": "string" }, "company": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "IN_STOCK", "LENT", "DELETED" ] }, "currentHolder": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": [ "id", "sei", "mei" ], "additionalProperties": false }, "lentUntil": { "type": "string", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "category", "productName", "name", "managementNo", "source", "clientDedicated", "remarks", "id", "company", "status", "currentHolder", "lentUntil", "createdAt", "updatedAt" ], "additionalProperties": false }, "PublicEquipmentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicEquipment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicEquipmentDetail": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER" ] }, "productName": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "managementNo": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "enum": [ "PURCHASED", "CLIENT_LOAN" ] }, "clientDedicated": { "type": "boolean" }, "remarks": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 2000 }, "id": { "type": "string" }, "company": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "IN_STOCK", "LENT", "DELETED" ] }, "currentHolder": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": [ "id", "sei", "mei" ], "additionalProperties": false }, "lentUntil": { "type": "string", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "originApplication": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "serialNo": { "type": "string" }, "title": { "type": "string" }, "typeName": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "applicant": { "type": "object", "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": [ "id", "sei", "mei" ], "additionalProperties": false }, "completedAt": { "type": "string", "nullable": true, "format": "date-time" } }, "required": [ "id", "serialNo", "title", "typeName", "status", "applicant", "completedAt" ], "additionalProperties": false }, "canReadOriginApplication": { "type": "boolean" } }, "required": [ "category", "productName", "name", "managementNo", "source", "clientDedicated", "remarks", "id", "company", "status", "currentHolder", "lentUntil", "createdAt", "updatedAt", "originApplication", "canReadOriginApplication" ], "additionalProperties": false }, "PublicEquipmentLendingStatus": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER" ] }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "IN_STOCK", "LENT" ] }, "dueAt": { "type": "string", "nullable": true } }, "required": [ "category", "name", "status", "dueAt" ] } } }, "required": [ "items" ], "additionalProperties": false }, "PublicCompany": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "shortName": { "type": "string", "nullable": true }, "nameKana": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "CLIENT", "PARTNER" ] }, "orderer": { "type": "boolean" }, "supplier": { "type": "boolean" }, "supplierType": { "type": "string", "nullable": true, "enum": [ "SES", "AGENT_NEW_GRAD", "AGENT_MID_INEXPERIENCED", "AGENT_MID_EXPERIENCED" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] } }, "required": [ "id", "code", "name", "shortName", "nameKana", "type", "orderer", "supplier", "supplierType", "status" ], "additionalProperties": false }, "PublicCompanyPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCompany" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicCompanyDetail": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "shortName": { "type": "string", "nullable": true }, "nameKana": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "CLIENT", "PARTNER" ] }, "orderer": { "type": "boolean" }, "supplier": { "type": "boolean" }, "supplierType": { "type": "string", "nullable": true, "enum": [ "SES", "AGENT_NEW_GRAD", "AGENT_MID_INEXPERIENCED", "AGENT_MID_EXPERIENCED" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "salesRepId": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "prefecture": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "otherAddress": { "type": "string", "nullable": true }, "building": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "toEmailAddress": { "type": "string", "nullable": true }, "ccEmailAddresses": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "methodOfSendingDocuments": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "corporateNumber": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "codeForAccounting": { "type": "string", "nullable": true }, "nameForAccounting": { "type": "string", "nullable": true }, "bankCode": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "branchCode": { "type": "string", "nullable": true }, "branchName": { "type": "string", "nullable": true }, "ordererPaymentTerms": { "type": "string", "nullable": true }, "supplierPaymentTerms": { "type": "string", "nullable": true }, "supplierWithholdingTax": { "type": "string", "nullable": true }, "companyContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "currentProfileApplicationId": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "post": { "type": "string", "nullable": true }, "lastName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "nullable": true }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "memo": { "type": "string", "nullable": true }, "businessCard": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": [ "businessCard", "profilePhoto" ] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false }, "profilePhoto": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": [ "businessCard", "profilePhoto" ] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false } }, "required": [ "id", "currentProfileApplicationId", "department", "post", "lastName", "firstName", "lastNameKana", "firstNameKana", "phoneNumber", "email", "memo", "businessCard", "profilePhoto" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": [ "ndaFile", "masterContract" ] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes" ], "additionalProperties": false } } }, "required": [ "id", "code", "name", "shortName", "nameKana", "type", "orderer", "supplier", "supplierType", "status", "salesRepId", "startDate", "endDate", "postalCode", "prefecture", "city", "otherAddress", "building", "phoneNumber", "remarks", "toEmailAddress", "ccEmailAddresses", "url", "methodOfSendingDocuments", "tag", "corporateNumber", "invoiceNumber", "codeForAccounting", "nameForAccounting", "bankCode", "bankName", "branchCode", "branchName", "ordererPaymentTerms", "supplierPaymentTerms", "supplierWithholdingTax", "companyContacts", "documents" ], "additionalProperties": false }, "PublicCompanyContactHistoryItem": { "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "serialNo": { "type": "string" }, "applicantName": { "type": "string" }, "completedAt": { "type": "string" }, "companyContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "currentProfileApplicationId": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "post": { "type": "string", "nullable": true }, "lastName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "nullable": true }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "memo": { "type": "string", "nullable": true }, "businessCard": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": [ "businessCard", "profilePhoto" ] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false }, "profilePhoto": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": [ "businessCard", "profilePhoto" ] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false } }, "required": [ "id", "currentProfileApplicationId", "department", "post", "lastName", "firstName", "lastNameKana", "firstNameKana", "phoneNumber", "email", "memo", "businessCard", "profilePhoto" ], "additionalProperties": false } }, "removedCompanyContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "lastName": { "type": "string", "default": "" }, "firstName": { "type": "string", "default": "" }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "businessCard": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": [ "businessCard", "profilePhoto" ] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false }, "profilePhoto": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": [ "businessCard", "profilePhoto" ] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false } }, "required": [ "id", "businessCard", "profilePhoto" ], "additionalProperties": false } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "type": "string", "enum": [ "ADDED", "UPDATED", "REMOVED" ] }, "before": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "currentProfileApplicationId": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "post": { "type": "string", "nullable": true }, "lastName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "nullable": true }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "memo": { "type": "string", "nullable": true } }, "required": [ "id", "currentProfileApplicationId", "department", "post", "lastName", "firstName", "lastNameKana", "firstNameKana", "phoneNumber", "email", "memo" ], "additionalProperties": false }, "after": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "currentProfileApplicationId": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "post": { "type": "string", "nullable": true }, "lastName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "nullable": true }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "memo": { "type": "string", "nullable": true } }, "required": [ "id", "currentProfileApplicationId", "department", "post", "lastName", "firstName", "lastNameKana", "firstNameKana", "phoneNumber", "email", "memo" ], "additionalProperties": false } }, "required": [ "id", "action", "before", "after" ], "additionalProperties": false } } }, "required": [ "id", "applicationId", "serialNo", "applicantName", "completedAt", "companyContacts", "removedCompanyContacts" ], "additionalProperties": false }, "PublicCompanyContactHistoryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCompanyContactHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicOfficeHistoryItem": { "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "serialNo": { "type": "string" }, "applicantName": { "type": "string" }, "completedAt": { "type": "string" }, "lifecycleAction": { "type": "string", "enum": [ "ARCHIVED", "RESTORED" ] }, "offices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "postalCode": { "type": "string", "nullable": true }, "prefecture": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "otherAddress": { "type": "string", "nullable": true }, "building": { "type": "string", "nullable": true } }, "required": [ "id", "code", "name", "postalCode", "prefecture", "city", "otherAddress", "building" ], "additionalProperties": false } }, "removedOffices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "code", "name" ], "additionalProperties": false } } }, "required": [ "id", "applicationId", "serialNo", "applicantName", "completedAt", "offices", "removedOffices" ], "additionalProperties": false }, "PublicOfficeHistoryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOfficeHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicWorkingHoursHistoryItem": { "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "serialNo": { "type": "string" }, "applicantName": { "type": "string" }, "completedAt": { "type": "string" }, "lifecycleAction": { "type": "string", "enum": [ "ARCHIVED", "RESTORED" ] }, "workingHours": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 21 }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "breaks": { "type": "array", "items": { "type": "object", "properties": { "startTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" }, "endTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "startTime", "endTime" ], "additionalProperties": false }, "maxItems": 10 }, "breakStartTime": { "type": "string", "nullable": true }, "breakEndTime": { "type": "string", "nullable": true }, "workingMinutes": { "type": "integer", "minimum": 0 }, "breakMinutes": { "type": "integer", "minimum": 0 } }, "required": [ "id", "name", "startTime", "endTime", "breakStartTime", "breakEndTime", "workingMinutes", "breakMinutes" ], "additionalProperties": false } }, "removedWorkingHours": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "applicationId", "serialNo", "applicantName", "completedAt", "workingHours", "removedWorkingHours" ], "additionalProperties": false }, "PublicWorkingHoursHistoryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicWorkingHoursHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicEmployeeApplicationsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": [ "IMMEDIATE", "WORKFLOW" ] }, "updatedAt": { "type": "string", "format": "date-time" }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "currentNodeName": { "type": "string", "nullable": true }, "targets": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "resourceId": { "type": "string", "minLength": 1 }, "relation": { "type": "string", "minLength": 1 }, "isProvisional": { "type": "boolean" } }, "required": [ "resourceType", "resourceId", "relation", "isProvisional" ] } } }, "required": [ "id", "serialNo", "title", "status", "approvalMode", "updatedAt", "submittedAt", "createdAt", "currentNodeName", "targets" ] } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false }, "availableTypes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "code", "name" ], "additionalProperties": false } } }, "required": [ "items", "pageInfo", "availableTypes" ], "additionalProperties": false }, "PublicManagerDescendants": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sei": { "type": "string", "minLength": 1 }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "positionName": { "type": "string" }, "depth": { "type": "integer", "minimum": 1 } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "positionName", "depth" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": [ "items", "truncated" ], "additionalProperties": false }, "PublicManagerChain": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sei": { "type": "string", "minLength": 1 }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "positionName": { "type": "string" } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "positionName" ] } } }, "required": [ "items" ], "additionalProperties": false }, "PublicQaInquiryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "applicationId": { "type": "string" }, "question": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "applicationId", "question", "status", "updatedAt" ], "additionalProperties": false } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicQaStarterPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "question": { "type": "string" } }, "required": [ "id", "question" ], "additionalProperties": false } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicQaChatResponse": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "answered" ] }, "answer": { "type": "string" }, "weak": { "type": "boolean" }, "citations": { "type": "array", "items": { "type": "string" }, "maxItems": 3 }, "citationRefs": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "sourceDocId": { "type": "string", "nullable": true }, "canOpen": { "type": "boolean" } }, "required": [ "title", "sourceDocId", "canOpen" ], "additionalProperties": false }, "maxItems": 3 }, "question": { "type": "string" }, "contextRefs": { "type": "array", "items": { "type": "string" } } }, "required": [ "status", "answer", "weak", "citations", "question", "contextRefs" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "not_ready" ] } }, "required": [ "status" ], "additionalProperties": false } ] }, "PublicQaChatRequest": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "starterId": { "type": "string" } }, "required": [ "question" ], "additionalProperties": false }, "PublicPostalAddress": { "type": "object", "properties": { "prefecture": { "type": "string" }, "city": { "type": "string" } }, "required": [ "prefecture", "city" ], "additionalProperties": false }, "PublicBank": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "code", "name" ], "additionalProperties": false }, "PublicBankPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicBank" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicQualification": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "defaultAllowance": { "type": "number", "nullable": true }, "defaultValidMonths": { "type": "integer", "nullable": true }, "isEnabled": { "type": "boolean" } }, "required": [ "id", "code", "name", "defaultAllowance", "defaultValidMonths", "isEnabled" ], "additionalProperties": false }, "PublicQualificationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicQualification" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ], "additionalProperties": false }, "PublicDataTypeSummary": { "type": "object", "properties": { "dataType": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "dataType", "name", "description" ], "additionalProperties": false }, "PublicDataTypeList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDataTypeSummary" } } }, "required": [ "items" ], "additionalProperties": false }, "PublicDataTypeField": { "type": "object", "properties": { "key": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "boolean", "date", "datetime", "enum", "id", "object" ] }, "nullable": { "type": "boolean" }, "filterable": { "type": "boolean" }, "sortable": { "type": "boolean" }, "searchable": { "type": "boolean" }, "pii": { "type": "boolean" }, "cardinality": { "type": "string", "enum": [ "one", "many" ] }, "enumValues": { "type": "array", "items": { "type": "string" } }, "referenceDataType": { "type": "string" } }, "required": [ "key", "type", "nullable", "filterable", "sortable", "searchable", "pii" ], "additionalProperties": false }, "PublicDataTypeDescriptor": { "type": "object", "properties": { "dataType": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "version": { "type": "string" }, "labelField": { "type": "string" }, "defaultSort": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "field", "direction" ], "additionalProperties": false } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDataTypeField" } } }, "required": [ "dataType", "name", "description", "version", "labelField", "defaultSort", "fields" ], "additionalProperties": false }, "PublicDataAttributeValue": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "nullable": true }, { "type": "array", "items": { "nullable": true } }, { "type": "object", "additionalProperties": { "nullable": true } }, { "nullable": true } ] }, "PublicDataRecord": { "type": "object", "properties": { "dataType": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PublicDataAttributeValue" } } }, "required": [ "dataType", "id", "label", "attributes" ], "additionalProperties": false }, "PublicDataPage": { "type": "object", "properties": { "dataType": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDataRecord" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "hasNext", "nextCursor" ], "additionalProperties": false } }, "required": [ "dataType", "items", "pageInfo" ], "additionalProperties": false }, "PublicRequiredWhen": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "field", "equals" ], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, { "type": "object", "additionalProperties": false, "required": [ "all" ], "properties": { "all": { "type": "array", "minItems": 2, "maxItems": 64, "items": { "$ref": "#/components/schemas/PublicRequiredWhen" } } } }, { "type": "object", "additionalProperties": false, "required": [ "any" ], "properties": { "any": { "type": "array", "minItems": 2, "maxItems": 64, "items": { "$ref": "#/components/schemas/PublicRequiredWhen" } } } } ] } }, "parameters": { "actingUser": { "name": "X-Acting-User", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "bearerAuth に組織サービストークンを使うときは必須。個人アクセストークンでは指定できません（指定すると 400 になります）。" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "kouro.ai PAT or organization service token" } } }, "paths": { "/v1/messages": { "get": { "operationId": "getPublicV1Messages", "summary": "メッセージカタログを取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "responses": { "200": { "description": "公開メッセージカタログの現在版", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicMessageCatalog" } } } }, "304": { "description": "カタログは変わっていない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "401": { "description": "認証情報が無いか無効", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "呼び出し元の scope ではカタログを読めない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/application-types": { "get": { "operationId": "listPublicV1ApplicationTypes", "summary": "申請できる種別を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "起票できる公開済みの申請種別", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationType" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/targets": { "get": { "operationId": "searchPublicV1ApplicationTargets", "summary": "申請の対象を検索する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請の対象にできるもの", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationTarget" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/immediate-executions": { "post": { "operationId": "executePublicV1ImmediateApplication", "summary": "即時完了の申請を実行する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionRequest" } } } }, "responses": { "201": { "description": "即時完了の申請が完了した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionResponse" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/immediate-executions/multipart": { "post": { "operationId": "executePublicV1ImmediateApplicationMultipart", "summary": "ファイルを添えて即時完了の申請を実行する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionMultipart" } } } }, "responses": { "201": { "description": "ファイル付きの即時完了申請が完了した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionResponse" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/targets/{targetId}": { "get": { "operationId": "getPublicV1ApplicationTarget", "summary": "申請の対象を 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "targetId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請対象の時点情報", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationTargetDetail" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/form-options": { "get": { "operationId": "searchPublicV1FormOptions", "summary": "フォームの選択肢を検索する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "fieldKey", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "フォームの選択肢", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormOption" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/field-effect-values/{targetId}": { "get": { "operationId": "getPublicV1FieldEffectValues", "summary": "選択した申請対象の項目値を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "targetId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "サーバーが確定した連動値", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicFieldEffectValues" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/initiation": { "get": { "operationId": "getPublicV1ApplicationTypeInitiation", "summary": "申請の起票方式（通常／即時完了）を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "呼び出し元が使える起票方式", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationTypeInitiation" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/form": { "get": { "operationId": "getPublicV1ApplicationTypeFormGuide", "summary": "申請フォームの定義を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "呼び出し元が使える公開済みの申請フォーム", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicFormSchema" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications": { "get": { "operationId": "listPublicV1Applications", "summary": "申請を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "pattern": "^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])$" }, "required": false, "name": "completedMonth", "in": "query" }, { "schema": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "呼び出し元が見られる申請", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationSummary" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "post": { "operationId": "createPublicV1Application", "summary": "申請の下書きをつくる", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCreateApplicationRequest" } } } }, "responses": { "201": { "description": "下書きをつくった", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummary" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/view": { "get": { "operationId": "getPublicV1ApplicationView", "summary": "申請の表示用ビューを取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請の表示用ビュー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationRuntimeView" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-summary": { "get": { "operationId": "getPublicV1ApplicationSummary", "summary": "申請状況の件数サマリを取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "responses": { "200": { "description": "呼び出し元の申請状況サマリ", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummaryCounts" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/upcoming-approvals": { "get": { "operationId": "listPublicV1UpcomingApprovals", "summary": "これから自分に回ってくる承認を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "これから呼び出し元に回ってくる見込みの承認タスク", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUpcomingApproval" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/notification-summary": { "get": { "operationId": "getPublicV1NotificationSummary", "summary": "未読通知の件数を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "notification:read", "responses": { "200": { "description": "未読通知の件数サマリ", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicNotificationSummary" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/applications/{applicationId}/events": { "get": { "operationId": "listPublicV1ApplicationEvents", "summary": "申請の履歴を全件まとめて取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請の履歴（全 event 種別。各件に自分の操作かどうかの isOwn が付く。ページングせず全件返す）", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationEvents" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/flow": { "get": { "operationId": "getPublicV1ApplicationFlow", "summary": "申請のフロー進行状況を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請のフロー進行状況", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationFlow" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}": { "get": { "operationId": "getPublicV1Application", "summary": "申請を 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請の詳細", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplication" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "patch": { "operationId": "updatePublicV1Application", "summary": "申請の下書きを更新する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUpdateApplicationRequest" } } } }, "responses": { "200": { "description": "下書きを更新した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummary" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "delete": { "operationId": "deletePublicV1Application", "summary": "申請の下書きを破棄する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "更新が完了した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/submit": { "post": { "operationId": "submitPublicV1Application", "summary": "申請を提出する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請を提出した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummary" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/withdraw": { "post": { "operationId": "withdrawPublicV1Application", "summary": "申請を取り下げる", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "更新が完了した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/reapply": { "post": { "operationId": "reapplyPublicV1Application", "summary": "差し戻された申請を再提出する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicReapplyApplicationRequest" } } } }, "responses": { "204": { "description": "申請を再提出した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/history": { "get": { "operationId": "listPublicV1ApplicationHistory", "summary": "申請の履歴をページングで取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請の履歴（全 event 種別。1 件ごとに安定した id が付く）", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks": { "get": { "operationId": "listPublicV1ApprovalTasks", "summary": "自分の承認待ちを一覧し、includeUpcoming=true で将来担当を統合する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "pattern": "^(?!0000)[0-9]{4}-(0[1-9]|1[0-2])$" }, "required": false, "name": "completedMonth", "in": "query" }, { "schema": { "type": "string", "enum": [ "true" ] }, "required": false, "name": "includeSummary", "in": "query" }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "required": false, "name": "includeUpcoming", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "default": "PENDING" }, "required": false, "name": "statuses", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "承認待ちの一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PublicApprovalTask" }, { "oneOf": [ { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "subjectName": { "type": "string", "minLength": 1 }, "applicationId": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "applicantId": { "type": "string", "minLength": 1 }, "applicantName": { "type": "string" }, "subjectUserId": { "type": "string", "minLength": 1 }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "taskId": { "type": "string", "minLength": 1 }, "nodeKey": { "type": "string", "minLength": 1 }, "taskName": { "type": "string" }, "taskType": { "type": "string", "enum": [ "APPROVAL", "INPUT", "APPROVAL_WITH_INPUT", "TASK", "AWAIT", "NOTIFY" ] }, "taskCreatedAt": { "type": "string", "format": "date-time" }, "kind": { "type": "string", "enum": [ "pending" ] } }, "required": [ "isProxy", "applicationId", "serialNo", "title", "status", "applicantId", "subjectUserId", "submittedAt", "taskId", "nodeKey", "taskName", "taskType", "taskCreatedAt", "kind" ] }, { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "subjectName": { "type": "string", "minLength": 1 }, "applicationId": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "applicantId": { "type": "string", "minLength": 1 }, "applicantName": { "type": "string" }, "subjectUserId": { "type": "string", "minLength": 1 }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "actedNodeKey": { "type": "string", "minLength": 1 }, "actedTaskName": { "type": "string" }, "actedAction": { "type": "string", "enum": [ "APPROVED", "SENT_BACK", "REJECTED" ] }, "actedAt": { "type": "string", "format": "date-time" }, "currentNodeName": { "type": "string", "nullable": true }, "kind": { "type": "string", "enum": [ "acted" ] }, "isUpcoming": { "type": "boolean" }, "upcomingNodeName": { "type": "string", "minLength": 1 } }, "required": [ "isProxy", "applicationId", "serialNo", "title", "status", "applicantId", "subjectUserId", "submittedAt", "actedNodeKey", "actedTaskName", "actedAction", "actedAt", "currentNodeName", "kind" ] }, { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "subjectName": { "type": "string", "minLength": 1 }, "applicationId": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "SENT_BACK", "BLOCKED" ] }, "applicantId": { "type": "string", "minLength": 1 }, "applicantName": { "type": "string" }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "nodeKey": { "type": "string", "minLength": 1 }, "nodeName": { "type": "string", "minLength": 1 }, "canOpenDetail": { "type": "boolean" }, "kind": { "type": "string", "enum": [ "upcoming" ] } }, "required": [ "isProxy", "applicationId", "serialNo", "title", "status", "applicantId", "applicantName", "submittedAt", "nodeKey", "nodeName", "canOpenDetail", "kind" ] } ] } ] } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] }, "summary": { "type": "object", "properties": { "upcoming": { "type": "integer", "minimum": 0, "description": "承認中＝関与する進行中申請すべて。PENDING / SENT_BACK / BLOCKED のうち、現担当・対応済み・将来候補のいずれかに該当する申請を申請IDで重複排除した件数。" }, "pending": { "type": "integer", "minimum": 0 }, "sentBack": { "type": "integer", "minimum": 0 }, "approvedThisMonth": { "type": "integer", "minimum": 0 } }, "required": [ "upcoming", "pending", "sentBack", "approvedThisMonth" ], "additionalProperties": false } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}": { "get": { "operationId": "getPublicV1ApprovalTask", "summary": "承認タスクを 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "承認タスクの詳細", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApprovalTask" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/send-back-targets": { "get": { "operationId": "listPublicV1SendBackTargets", "summary": "差し戻し先に指定できる段を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "差し戻し先に指定できる段", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicSendBackTarget" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/approve": { "post": { "operationId": "approvePublicV1ApprovalTask", "summary": "承認タスクを承認する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:approve", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApproveTaskRequest" } } } }, "responses": { "204": { "description": "承認タスクの更新が完了した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/reject": { "post": { "operationId": "rejectPublicV1ApprovalTask", "summary": "承認タスクを却下する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:reject", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicRejectTaskRequest" } } } }, "responses": { "204": { "description": "承認タスクの更新が完了した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/send-back": { "post": { "operationId": "sendBackPublicV1ApprovalTask", "summary": "承認タスクを差し戻す", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:sendback", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSendBackTaskRequest" } } } }, "responses": { "204": { "description": "承認タスクの更新が完了した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qa/inquiries/{applicationId}/reuse-exclusion": { "get": { "operationId": "getPublicV1QaInquiryExclusion", "summary": "問い合わせのナレッジ再利用対象外設定を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "問い合わせの対象外状態と変更可否", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "excluded": { "type": "boolean" }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "canChange": { "type": "boolean" } }, "required": [ "excluded", "version", "canChange" ], "additionalProperties": false } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "patch": { "operationId": "changePublicV1QaInquiryExclusion", "summary": "問い合わせのナレッジ再利用対象外設定を変更する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "excluded": { "type": "boolean" }, "expectedVersion": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": [ "excluded", "expectedVersion" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "変更後の対象外状態。過去の処理は再開しない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "excluded": { "type": "boolean" }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "canChange": { "type": "boolean" } }, "required": [ "excluded", "version", "canChange" ], "additionalProperties": false } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/comments": { "get": { "operationId": "listPublicV1ApplicationComments", "summary": "申請のコメントを一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請のコメント", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationComment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "post": { "operationId": "createPublicV1ApplicationComment", "summary": "申請にコメントを投稿する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPostApplicationComment" } } } }, "responses": { "201": { "description": "コメントを投稿した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationComment" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/comments/{commentId}": { "patch": { "operationId": "updatePublicV1ApplicationComment", "summary": "コメントを編集する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "commentId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUpdateApplicationComment" } } } }, "responses": { "204": { "description": "コメントを更新した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "delete": { "operationId": "deletePublicV1ApplicationComment", "summary": "コメントを削除する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "commentId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "コメントを削除した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/input": { "post": { "operationId": "submitPublicV1ApplicationInput", "summary": "申請者として追加入力を提出する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationInput" } } } }, "responses": { "204": { "description": "申請者の追加入力を受け付けた", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/submit-input": { "post": { "operationId": "submitPublicV1ApprovalInput", "summary": "入力担当者として承認段の入力を提出する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:approve", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApprovalInput" } } } }, "responses": { "204": { "description": "入力担当者の入力を受け付けた", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/attachments": { "post": { "operationId": "uploadPublicV1ApplicationAttachment", "summary": "申請に添付ファイルを追加する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fieldKey": { "type": "string", "minLength": 1 }, "taskId": { "type": "string", "minLength": 1 }, "groupKey": { "type": "string", "minLength": 1 }, "rowKey": { "type": "string", "minLength": 1 }, "file": { "type": "string", "format": "binary" } }, "required": [ "fieldKey", "file" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "添付ファイルを追加した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicAttachment" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "get": { "operationId": "listPublicV1ApplicationAttachments", "summary": "申請の添付ファイルを一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請の添付ファイル", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicAttachment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "hasNext", "nextCursor" ] } }, "required": [ "items", "pageInfo" ] } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/attachments/{attachmentId}": { "get": { "operationId": "downloadPublicV1ApplicationAttachment", "summary": "添付ファイルをダウンロードする", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "attachmentId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "添付ファイルの実体", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "delete": { "operationId": "deletePublicV1ApplicationAttachment", "summary": "添付ファイルを削除する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "attachmentId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "taskId", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "添付ファイルを削除した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "リクエストが大きすぎる", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "内容が業務ルールに反する", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/me": { "get": { "operationId": "getPublicV1Me", "summary": "呼び出し元の情報を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "me:read", "responses": { "200": { "description": "呼び出し元の情報", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicMe" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/notifications": { "get": { "operationId": "listPublicV1Notifications", "summary": "通知を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "notification:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "required": false, "name": "unread", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "通知の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicNotificationPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/notifications/{notificationId}/read": { "put": { "operationId": "markPublicV1NotificationRead", "summary": "通知を既読にする", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "notification:write", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "notificationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "通知を既読にした", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "競合して処理できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/departments": { "get": { "operationId": "listPublicV1Departments", "summary": "組織を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "department:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "組織の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDepartmentPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/positions": { "get": { "operationId": "listPublicV1Positions", "summary": "役職を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "position:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "役職の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPositionPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees": { "get": { "operationId": "listPublicV1Employees", "summary": "社員を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "q", "in": "query" }, { "schema": { "type": "string", "enum": [ "ACTIVE", "ON_LEAVE", "PENDING_RETIREMENT", "RETIRED" ] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "enum": [ "EMPLOYEE", "BP_MEMBER" ] }, "required": false, "name": "personType", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "departmentId", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "positionId", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "社員の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeePage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}": { "get": { "operationId": "getPublicV1Employee", "summary": "社員を 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "社員の詳細", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeeDetail" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employee-field-catalog": { "get": { "operationId": "getPublicV1EmployeeFieldCatalog", "summary": "社員項目のカタログを取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "responses": { "200": { "description": "社員項目のカタログ", "headers": { "ETag": { "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeeFieldCatalog" } } } }, "304": { "description": "カタログは変わっていない", "headers": { "ETag": { "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/organization-chart/departments": { "get": { "operationId": "listPublicV1OrganizationChartDepartments", "summary": "組織図の組織を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "org:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "組織図の組織", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOrganizationChartDepartmentPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/organization-chart/members": { "get": { "operationId": "listPublicV1OrganizationChartMembers", "summary": "組織図の所属メンバーを一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "org:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "組織図の所属メンバー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOrganizationChartMemberPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/projects": { "get": { "operationId": "listPublicV1Projects", "summary": "プロジェクトを一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "project:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": [ "ACTIVE", "CLOSED" ] }, "required": false, "name": "status", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "プロジェクトの一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicProjectPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/projects/{projectId}/customer-loans": { "get": { "operationId": "getPublicV1ProjectCustomerLoans", "summary": "プロジェクトの客先貸与状況を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "project:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "プロジェクトの客先貸与状況", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicProjectCustomerLoans" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/offices": { "get": { "operationId": "listPublicV1Offices", "summary": "勤務地を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "勤務地の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOfficePage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/working-hours": { "get": { "operationId": "listPublicV1WorkingHours", "summary": "勤務時間を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "勤務時間の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkingHoursPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/expenses": { "get": { "operationId": "listPublicV1Expenses", "summary": "経費種目を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "expense:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "経費種目の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicExpensePage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/announcements": { "get": { "operationId": "listPublicV1Announcements", "summary": "お知らせを一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "announcement:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "お知らせの一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInternalAnnouncementPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/equipment": { "get": { "operationId": "listPublicV1Equipment", "summary": "備品を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "equipment:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": [ "SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER" ] }, "required": false, "name": "category", "in": "query" }, { "schema": { "type": "string", "enum": [ "IN_STOCK", "LENT", "DELETED" ] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "enum": [ "PURCHASED", "CLIENT_LOAN" ] }, "required": false, "name": "source", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": false, "name": "search", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "備品の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEquipmentPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/equipment/{equipmentId}": { "get": { "operationId": "getPublicV1Equipment", "summary": "備品を 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "equipment:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "equipmentId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "備品の詳細", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEquipmentDetail" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/equipment-lending-status": { "get": { "operationId": "getPublicV1ApplicationEquipmentLendingStatus", "summary": "申請に紐づく備品の貸出状況を取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "申請に紐づく備品の貸出状況", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEquipmentLendingStatus" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/companies": { "get": { "operationId": "listPublicV1Companies", "summary": "会社を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "会社の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/companies/{companyId}": { "get": { "operationId": "getPublicV1Company", "summary": "会社を 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "companyId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "会社の詳細", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyDetail" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/companies/{companyId}/contact-history": { "get": { "operationId": "listPublicV1CompanyContactHistory", "summary": "取引先の連絡履歴を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "取引先の連絡履歴", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyContactHistoryPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/offices/history": { "get": { "operationId": "listPublicV1OfficeHistory", "summary": "勤務地の変更履歴を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "勤務地の変更履歴", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOfficeHistoryPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/working-hours/history": { "get": { "operationId": "listPublicV1WorkingHoursHistory", "summary": "勤務時間の変更履歴を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "勤務時間の変更履歴", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkingHoursHistoryPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}/applications": { "get": { "operationId": "listPublicV1EmployeeApplications", "summary": "特定の社員の申請を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": [ "department", "address", "commute", "bankAccount", "projects", "equipment", "emergencyContact" ] }, "required": false, "name": "field", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "statuses", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "typeCodes", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "from", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "to", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "その社員の申請", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeeApplicationsPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}/descendants": { "get": { "operationId": "listPublicV1EmployeeDescendants", "summary": "特定の社員の配下を取得する（深さ上限あり）", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "その社員の配下（深さの上限で打ち切る。打ち切った枝が残ると truncated が true になる。続きを取る手段は無い）", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicManagerDescendants" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}/manager-chain": { "get": { "operationId": "listPublicV1EmployeeManagerChain", "summary": "特定の社員の上長の連なりを取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "その社員の上長の連なり（深さの上限で打ち切ることがある。打ち切りを示す印は返らない）", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicManagerChain" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qa/inquiries": { "get": { "operationId": "listPublicV1QaInquiries", "summary": "Q&A の問い合わせを一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "問い合わせの一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaInquiryPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qa/starters": { "get": { "operationId": "listPublicV1QaStarters", "summary": "Q&A の質問例を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "質問例の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaStarterPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qa/chat": { "post": { "operationId": "createPublicV1QaChat", "summary": "Q&A に質問する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaChatRequest" } } } }, "responses": { "200": { "description": "社内資料に基づく回答", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaChatResponse" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "回答生成の外部サービスが応答しない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/postal-addresses/{postalCode}": { "get": { "operationId": "lookupPublicV1PostalAddress", "summary": "郵便番号から住所を引く", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "string", "pattern": "^(?:\\d{7}|\\d{3}-\\d{4})$" }, "required": true, "name": "postalCode", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "郵便番号に対応する住所", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPostalAddress" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "外部参照先が応答しない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks": { "get": { "operationId": "listPublicV1Banks", "summary": "銀行を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "銀行の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBankPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "外部参照先が応答しない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks/{bankCode}": { "get": { "operationId": "getPublicV1Bank", "summary": "銀行を 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bankCode", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "銀行", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBank" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "外部参照先が応答しない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks/{bankCode}/branches": { "get": { "operationId": "listPublicV1BankBranches", "summary": "支店を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "支店の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBankPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "外部参照先が応答しない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks/{bankCode}/branches/{branchCode}": { "get": { "operationId": "getPublicV1BankBranch", "summary": "支店を 1 件取得する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bankCode", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "branchCode", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "支店", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBank" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "外部参照先が応答しない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qualifications": { "get": { "operationId": "listPublicV1Qualifications", "summary": "資格を一覧する", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qualification:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "資格の一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQualificationPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/data-types": { "get": { "operationId": "listPublicV1DataTypes", "summary": "参照できるデータ種別を取得する", "description": "呼び出し元が参照できる dataType だけを返す（小さく固定された集合のためページングしない）。", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "me:read", "x-upflow-data-types": [ "department", "position", "employee", "qualification", "equipment", "equipment_category", "expense", "account_title", "sub_account_title", "announcement", "company", "company_contact", "project", "office", "working_hours", "department_assignment", "project_assignment", "equipment_lending" ], "responses": { "200": { "description": "データ種別の集合", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDataTypeList" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/data-types/{dataType}": { "get": { "operationId": "describePublicV1DataType", "summary": "データ種別の定義を取得する", "description": "attributes の項目（型・nullable・filterable / sortable / searchable・PII）と既定順序を返す。内容由来の version を ETag として返す。", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "dynamic", "x-upflow-scope-selector": { "property": "dataType", "scopes": { "account_title": "expense:read", "announcement": "announcement:read", "company": "company:read", "company_contact": "company:read", "department": "department:read", "department_assignment": "department:read", "employee": "user:read", "equipment": "equipment:read", "equipment_category": "equipment:read", "equipment_lending": "equipment:read", "expense": "expense:read", "office": "company:read", "position": "position:read", "project": "project:read", "project_assignment": "project:read", "qualification": "qualification:read", "sub_account_title": "expense:read", "working_hours": "company:read" } }, "x-upflow-data-types": [ "department", "position", "employee", "qualification", "equipment", "equipment_category", "expense", "account_title", "sub_account_title", "announcement", "company", "company_contact", "project", "office", "working_hours", "department_assignment", "project_assignment", "equipment_lending" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "dataType", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "データ種別の定義", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDataTypeDescriptor" } } } }, "304": { "description": "変更なし（If-None-Match が一致）", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/data/{dataType}": { "get": { "operationId": "listPublicV1Data", "summary": "データを一覧する", "description": "現在有効な確定済みデータを cursor ページングで返す。絞り込みは `filter[][]=`（op: eq / ne / in / contains / startsWith。in はカンマ区切り。eq / ne の `null` は未設定）。同じ field を複数回指定すると AND。使える field と op は `GET /v1/data-types/{dataType}` の fields が示す。`isArchived` は全種別の正規化 attribute で既定は false（archived を含めるには明示する）。", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "dynamic", "x-upflow-scope-selector": { "property": "dataType", "scopes": { "account_title": "expense:read", "announcement": "announcement:read", "company": "company:read", "company_contact": "company:read", "department": "department:read", "department_assignment": "department:read", "employee": "user:read", "equipment": "equipment:read", "equipment_category": "equipment:read", "equipment_lending": "equipment:read", "expense": "expense:read", "office": "company:read", "position": "position:read", "project": "project:read", "project_assignment": "project:read", "qualification": "qualification:read", "sub_account_title": "expense:read", "working_hours": "company:read" } }, "x-upflow-data-types": [ "department", "position", "employee", "qualification", "equipment", "equipment_category", "expense", "account_title", "sub_account_title", "announcement", "company", "company_contact", "project", "office", "working_hours", "department_assignment", "project_assignment", "equipment_lending" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "dataType", "in": "path" }, { "schema": { "type": "string", "description": "`:` をカンマ区切り（最大 2）。省略時は種別の既定順" }, "required": false, "name": "sort", "in": "query" }, { "schema": { "type": "string", "description": "簡易検索（searchable 列の部分一致・大文字小文字を区別しない・1〜200 文字）" }, "required": false, "name": "query", "in": "query" }, { "schema": { "type": "string", "description": "1〜100（省略時 20）" }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "description": "前ページの pageInfo.nextCursor（同じ filters / sort / query / limit でのみ有効）" }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "データの一覧", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDataPage" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/data/{dataType}/{id}": { "get": { "operationId": "getPublicV1Data", "summary": "データを 1 件取得する", "description": "現在有効な確定済みの 1 件を返す。archived や別テナントの行は存在しないものとして扱う。", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "dynamic", "x-upflow-scope-selector": { "property": "dataType", "scopes": { "account_title": "expense:read", "announcement": "announcement:read", "company": "company:read", "company_contact": "company:read", "department": "department:read", "department_assignment": "department:read", "employee": "user:read", "equipment": "equipment:read", "equipment_category": "equipment:read", "equipment_lending": "equipment:read", "expense": "expense:read", "office": "company:read", "position": "position:read", "project": "project:read", "project_assignment": "project:read", "qualification": "qualification:read", "sub_account_title": "expense:read", "working_hours": "company:read" } }, "x-upflow-data-types": [ "department", "position", "employee", "qualification", "equipment", "equipment_category", "expense", "account_title", "sub_account_title", "announcement", "company", "company_contact", "project", "office", "working_hours", "department_assignment", "project_assignment", "equipment_lending" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "dataType", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "id", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "データ 1 件", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDataRecord" } } } }, "400": { "description": "リクエストが不正", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "認証が必要", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "権限が足りない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "対象が見つからない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "レート制限に達した", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "再試行できるようになるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "サーバー内部エラー", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "一時的に利用できない", "headers": { "RateLimit-Limit": { "description": "現在の窓で許可される最大リクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "現在の窓で残っているリクエスト数", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "現在の窓がリセットされるまでの秒数", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } } }, "x-upflow-error-registry": { "VALIDATION_ERROR": { "status": 400, "messageId": "EU00001" }, "INVALID_CURSOR": { "status": 400, "messageId": "EU00001" }, "METHOD_NOT_ALLOWED": { "status": 405, "messageId": "EU00001" }, "AUTHENTICATION_REQUIRED": { "status": 401, "messageId": "EU00047" }, "INVALID_CREDENTIAL": { "status": 401, "messageId": "EU00048" }, "FORBIDDEN": { "status": 403, "messageId": "EU00002" }, "NOT_FOUND": { "status": 404, "messageId": "EU00003" }, "DATA_TYPE_NOT_FOUND": { "status": 404, "messageId": "EU00003" }, "DATA_NOT_FOUND": { "status": 404, "messageId": "EU00003" }, "CONFLICT": { "status": 409, "messageId": "EU00027" }, "IDEMPOTENCY_KEY_REUSED": { "status": 409, "messageId": "EU00027" }, "PRECONDITION_FAILED": { "status": 412, "messageId": "EU00027" }, "PAYLOAD_TOO_LARGE": { "status": 413, "messageId": "EU00004" }, "UNPROCESSABLE_ENTITY": { "status": 422, "messageId": "EU00001" }, "RATE_LIMITED": { "status": 429, "messageId": "EU00005" }, "SINGLE_PENDING": { "status": 400, "messageId": "EU00036" }, "INTERNAL_ERROR": { "status": 500, "messageId": "EU00006" }, "BAD_GATEWAY": { "status": 502, "messageId": "EU00007" }, "SERVICE_UNAVAILABLE": { "status": 503, "messageId": "EU00008" }, "GATEWAY_TIMEOUT": { "status": 504, "messageId": "EU00009" }, "PRECONDITION_REQUIRED": { "status": 428, "messageId": "EU00001" } } }