ミラサポ事例調査アシスタント
ミラサポ事例調査アシスタント · GPT-Aktionen
事例ナビ Data API (外部公開向け)
事例ナビのデータを扱う REST API のうち、 ミラサポplus が利用する想定の path およびパラメータを抜粋したものです。
GET /case_studies「事例」の検索指定した条件で「事例」を検索します。
GET /case_studies/{id}「事例」の取得「事例」を取得します。
GET /categories/industries「標準産業分類」の一覧取得「標準産業分類」の一覧を取得します。
GET /categories/purposes「お困りごと分類」の一覧取得「お困りごと分類」の一覧を取得します。
GET /categories/services「行政サービス分類」の一覧取得「行政サービス分類」の一覧を取得します。
GET /categories/specific_measures「特定施策区分」の一覧取得「特定施策区分」の一覧を取得します。
GET /regions「地方」の一覧取得「地方」の一覧を取得します。
GET /prefectures「都道府県」の一覧取得「都道府県」の一覧を取得します。
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "事例ナビ Data API (外部公開向け)",
"version": "1.0",
"description": "事例ナビのデータを扱う REST API のうち、 \nミラサポplus が利用する想定の path およびパラメータを抜粋したものです。 \n"
},
"servers": [
{
"url": "https://jirei-seido-api.mirasapo-plus.go.jp"
}
],
"paths": {
"/case_studies": {
"get": {
"tags": [
"「事例」"
],
"summary": "「事例」の検索",
"description": "指定した条件で「事例」を検索します。",
"operationId": "searchCaseStudies",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchCaseStudiesResult"
}
}
}
}
},
"parameters": [
{
"name": "keywords",
"in": "query",
"description": "検索するキーワード。 \nカンマ (,) 区切りで複数の値を指定できます。(最大 3 件、1 つあたり 50 文字以内) \n複数の値を指定した場合、AND検索となります。",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "industry_category",
"in": "query",
"description": "検索対象の「標準産業分類」(業種) の ID (industry_category.id)。 \nカンマ (,) 区切りで複数の値を指定できます。",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "service_category",
"in": "query",
"description": "検索対象の「行政サービス分類」(業種) の ID (stage_category.id)。 \nカンマ (,) 区切りで複数の値を指定できます。\n「行政サービス中分類」を指定する際は ID (stage_category.sub_categories.id) の前に S を付加します。",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": "1,2,S2,S3"
},
{
"name": "purpose_category",
"in": "query",
"description": "検索対象の「お困りごと分類」の ID (purpose_category.id)。 \nカンマ (,) 区切りで複数の値を指定できます。",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "specific_measure_category",
"in": "query",
"description": "検索対象の「特定施策区分」(活用施策) の ID (specific_measure_category.id)。 \nカンマ (,) 区切りで複数の値を指定できます。",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "organization.capital.from",
"in": "query",
"description": "資本金 (from)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
}
},
{
"name": "organization.capital.to",
"in": "query",
"description": "資本金 (to)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
}
},
{
"name": "organization.permanent_employees_count.from",
"in": "query",
"description": "従業員数 (from)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
}
},
{
"name": "organization.permanent_employees_count.to",
"in": "query",
"description": "従業員数 (to)",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer"
}
},
{
"name": "prefecture.name",
"in": "query",
"description": "検索対象の地域 (都道府県名) (prefecture.name)。 \nカンマ (,) 区切りで複数の値を指定できます。\n",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "sort",
"in": "query",
"description": "検索結果の並び順のキー。 \n以下の値を指定できます。 \ntimestamp: 公開日順 \npopularity: 人気順 \nnumber: 事例番号順 \nupdate: 最終更新日順 \nname: 事例タイトルの文字コード順",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"timestamp",
"popularity",
"number",
"update",
"name"
]
}
},
{
"name": "order",
"in": "query",
"description": "検索結果の並び順の方向。 \n以下の値を指定できます。 \nasc: 昇順 \ndesc: 降順",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "limit",
"in": "query",
"description": "検索結果の最大件数。 \n1 - 100 の値を指定できます。 \n省略すると、10 が指定されます。",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"example": 10
}
},
{
"name": "offset",
"in": "query",
"description": "検索結果の取得開始インデックス。 \n0-base でインデックス付けされます。",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"example": 20
}
}
]
}
},
"/case_studies/{id}": {
"get": {
"tags": [
"「事例」"
],
"summary": "「事例」の取得",
"description": "「事例」を取得します。\n",
"operationId": "getCaseStudy",
"parameters": [
{
"name": "id",
"in": "path",
"description": "取得する「事例」の `id`",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CaseStudy"
}
}
}
},
"404": {
"description": "Not Found (Resource with the specified Id is not found.)"
}
}
}
},
"/categories/industries": {
"get": {
"tags": [
"「カテゴリ」"
],
"summary": "「標準産業分類」の一覧取得",
"description": "「標準産業分類」の一覧を取得します。",
"operationId": "getIndustryCategories",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustryCategory"
}
}
}
}
}
}
}
},
"/categories/purposes": {
"get": {
"tags": [
"「カテゴリ」"
],
"summary": "「お困りごと分類」の一覧取得",
"description": "「お困りごと分類」の一覧を取得します。",
"operationId": "getPurposeCategories",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurposeCategory"
}
}
}
}
}
}
}
},
"/categories/services": {
"get": {
"tags": [
"「カテゴリ」"
],
"summary": "「行政サービス分類」の一覧取得",
"description": "「行政サービス分類」の一覧を取得します。",
"operationId": "getServiceCategories",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceCategory"
}
}
}
}
}
}
}
},
"/categories/specific_measures": {
"get": {
"tags": [
"「カテゴリ」"
],
"summary": "「特定施策区分」の一覧取得",
"description": "「特定施策区分」の一覧を取得します。",
"operationId": "getSpecificMeasureCategories",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SpecificMeasureCategory"
}
}
}
}
}
}
}
},
"/regions": {
"get": {
"tags": [
"「地域」"
],
"summary": "「地方」の一覧取得",
"description": "「地方」の一覧を取得します。",
"operationId": "getRegions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
}
}
}
}
}
},
"/prefectures": {
"get": {
"tags": [
"「地域」"
],
"summary": "「都道府県」の一覧取得",
"description": "「都道府県」の一覧を取得します。",
"operationId": "getPrefectures",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prefecture"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AreaList": {
"title": "AreaList",
"type": "object",
"description": "対象地域群",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "名前"
},
"content": {
"type": "string",
"format": "markdown",
"description": "テキスト"
},
"update_info": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateInfo"
}
],
"readOnly": true,
"description": "更新情報"
}
}
},
"CaseStudy": {
"title": "CaseStudy",
"type": "object",
"description": "事例",
"required": [
"title"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"number": {
"type": "string",
"description": "事例番号"
},
"title": {
"type": "string",
"description": "事例タイトル(キャッチコピー)"
},
"summary": {
"type": "string",
"description": "事例概要"
},
"year": {
"type": "string",
"description": "事例年（制度利用年）"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/Prefecture"
}
],
"description": "事例所在地（都道府県）"
},
"used_support_refs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
},
"description": "利用した制度"
},
"specific_measure_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SpecificMeasureCategory"
},
"description": "活用施策"
},
"partners": {
"type": "array",
"items": {
"type": "string"
},
"description": "協力者"
},
"background": {
"type": "string",
"format": "markdown",
"description": "取組理由・課題・きっかけ"
},
"challenges": {
"type": "string",
"format": "markdown",
"description": "挑戦したことや解決策"
},
"results": {
"type": "string",
"format": "markdown",
"description": "結果"
},
"prospect": {
"type": "string",
"format": "markdown",
"description": "展望（普及）"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CaseStudyImage"
},
"description": "画像"
},
"movies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
},
"description": "動画"
},
"related_sites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
},
"description": "関連サイト"
},
"organization": {
"allOf": [
{
"$ref": "#/components/schemas/Organization"
}
],
"description": "企業情報"
},
"contact": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true,
"description": "連絡先"
},
"industry_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustryCategory"
},
"description": "標準産業分類"
},
"service_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceCategory"
},
"description": "行政サービス分類"
},
"purpose_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PurposeCategory"
},
"description": "お困りごと分類"
},
"themes": {
"type": "array",
"items": {
"type": "string"
},
"description": "テーマ・キーワード"
},
"language": {
"type": "string",
"description": "言語"
},
"catalog": {
"allOf": [
{
"$ref": "#/components/schemas/Catalog"
}
],
"description": "データカタログ"
},
"published_date": {
"type": "string",
"format": "date",
"description": "公開日"
},
"unpublish_date": {
"type": "string",
"format": "date",
"description": "公開終了日"
},
"update_info": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateInfo"
}
],
"readOnly": true,
"description": "更新情報"
},
"mng_groups": {
"type": "array",
"items": {
"type": "string"
},
"description": "管理グループ の id"
},
"published": {
"type": "boolean",
"description": "公開状態"
},
"deleted": {
"type": "boolean",
"description": "削除状態"
},
"user_evaluation": {
"allOf": [
{
"$ref": "#/components/schemas/UserEvaluation"
}
],
"readOnly": true,
"description": "ユーザー評価"
}
}
},
"CaseStudyImage": {
"title": "CaseStudyImage",
"description": "事例画像",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "タイトル (image.title より優先)"
},
"image": {
"allOf": [
{
"$ref": "#/components/schemas/Image"
}
],
"description": "画像"
}
}
},
"Catalog": {
"title": "Catalog",
"type": "object",
"description": "データカタログ",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"for": {
"type": "string",
"enum": [
"case_studies",
"supports"
],
"description": "事例集か制度集か",
"example": "case_studies"
},
"name": {
"type": "string",
"description": "データカタログ名"
},
"description": {
"type": "string",
"description": "データカタログ説明"
},
"publisher": {
"type": "string",
"description": "データカタログ作成者"
},
"image": {
"allOf": [
{
"$ref": "#/components/schemas/Image"
}
],
"description": "表紙・イメージ画像"
},
"publish_date": {
"type": "string",
"format": "date",
"description": "公開日"
},
"unpublish_date": {
"type": "string",
"format": "date",
"description": "公開終了日"
},
"published": {
"type": "boolean",
"description": "公開状態"
},
"deletable": {
"type": "boolean",
"readOnly": true,
"description": "削除可否 (制度、事例、またはお問合せ先リストに紐付いている場合削除不可)"
},
"update_info": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateInfo"
}
],
"readOnly": true,
"description": "更新情報"
}
}
},
"Contact": {
"title": "Contact",
"type": "object",
"description": "連絡先",
"properties": {
"name": {
"type": "string",
"description": "連絡先（名前）"
},
"email": {
"type": "string",
"format": "email",
"description": "連絡先（メール）"
},
"address": {
"type": "string",
"description": "連絡先（住所）"
},
"tel": {
"type": "string",
"description": "連絡先（電話）"
},
"url": {
"type": "string",
"format": "uri",
"description": "連絡先（url）"
}
}
},
"Image": {
"title": "Image",
"description": "画像",
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true,
"description": "ファイル名 (アップロード時のファイル名)"
},
"title": {
"type": "string",
"description": "タイトル"
},
"mng_group": {
"type": "string",
"description": "管理グループ の id"
},
"url": {
"type": "string",
"readOnly": true,
"description": "画像 URL (CDN ドメイン名含む URL 全体)"
},
"thumbnail_url": {
"type": "string",
"readOnly": true,
"description": "サムネイル画像 URL (CDN ドメイン名含む URL 全体)"
},
"update_info": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateInfo"
}
],
"readOnly": true,
"description": "更新情報"
}
}
},
"IndustryCategory": {
"title": "IndustryCategory",
"type": "object",
"description": "標準産業分類 (大分類)",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "大分類名"
},
"number": {
"type": "string",
"description": "大分類番号"
},
"sub_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustrySubCategory"
},
"description": "中分類のリスト。空の場合、大分類が選択されているとみなす。"
}
}
},
"IndustrySubCategory": {
"title": "IndustrySubCategory",
"type": "object",
"description": "標準産業分類 (中分類)",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "中分類名"
},
"number": {
"type": "string",
"description": "中分類番号"
}
}
},
"Link": {
"title": "Link",
"type": "object",
"description": "リンク",
"required": [
"url"
],
"properties": {
"title": {
"type": "string",
"description": "タイトル"
},
"url": {
"type": "string",
"format": "uri",
"description": "URL"
}
}
},
"Operator": {
"title": "Operator",
"type": "object",
"description": "データ編集者",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
}
}
},
"Organization": {
"title": "Organization",
"type": "object",
"description": "事例の「企業情報」(case_study.organization) に用いられる組織",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "組織名"
},
"industry": {
"type": "string",
"description": "業種"
},
"description": {
"type": "string",
"description": "企業概要"
},
"corporate_number": {
"type": "string",
"description": "法人番号"
},
"type": {
"type": "string",
"description": "組織種別"
},
"permanent_employees_count": {
"type": "integer",
"description": "常時使用する従業員数"
},
"sales_amount": {
"type": "integer",
"description": "売上高"
},
"address": {
"type": "string",
"description": "所在地"
},
"capital": {
"type": "integer",
"description": "資本金"
},
"established_date": {
"type": "string",
"format": "date",
"description": "設立年月日"
}
}
},
"Prefecture": {
"title": "Prefecture",
"type": "object",
"description": "都道府県",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "都道府県名"
},
"region_name": {
"type": "string",
"description": "地方名"
}
}
},
"PurposeCategory": {
"title": "PurposeCategory",
"type": "object",
"description": "お困りごと分類",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "名称"
}
}
},
"Region": {
"title": "Region",
"type": "object",
"description": "地方（東北、関東など）",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "地方名"
},
"prefectures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Prefecture"
},
"description": "地方に含まれる都道府県"
}
}
},
"SearchCaseStudiesResult": {
"title": "SearchCaseStudiesResult",
"type": "object",
"description": "「事例」の検索結果",
"required": [
"total",
"items"
],
"properties": {
"total": {
"type": "integer",
"readOnly": true,
"description": "検索ヒット数 (1000 件を超える場合、1001 固定となります。)"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CaseStudy"
},
"description": "offset, limit が反映された検索結果のデータ配列 (0 件の場合、空の配列)"
}
}
},
"SearchCatalogsResult": {
"title": "SearchCatalogsResult",
"type": "object",
"description": "「カタログ」の検索結果",
"required": [
"total",
"items"
],
"properties": {
"total": {
"type": "integer",
"readOnly": true,
"description": "検索ヒット数 (1000 件を超える場合、1001 固定となります。)"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Catalog"
},
"description": "offset, limit が反映された検索結果のデータ配列 (0 件の場合、空の配列)"
}
}
},
"ServiceCategory": {
"title": "ServiceCategory",
"type": "object",
"description": "行政サービス分類（大分類）",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "名称"
},
"sub_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceSubCategory"
},
"description": "中分類のリスト。空の場合、大分類が選択されているとみなす。"
}
}
},
"ServiceSubCategory": {
"title": "ServiceSubCategory",
"type": "object",
"description": "行政サービス分類（中分類）",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "名称"
}
}
},
"SpecificMeasureCategory": {
"title": "SpecificMeasureCategory",
"type": "object",
"description": "特定施策区分",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"description": "名称"
}
}
},
"UpdateInfo": {
"title": "UpdateInfo",
"type": "object",
"description": "更新情報",
"properties": {
"created_by": {
"allOf": [
{
"$ref": "#/components/schemas/Operator"
}
],
"readOnly": true,
"description": "作成者"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "作成日"
},
"last_modified_by": {
"allOf": [
{
"$ref": "#/components/schemas/Operator"
}
],
"readOnly": true,
"description": "最終更新者"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "最終更新日"
}
}
},
"UserEvaluation": {
"title": "UserEvaluation",
"type": "object",
"description": "ユーザー評価",
"properties": {
"bookmarked": {
"type": "boolean",
"readOnly": true,
"description": "ブックマーク済み (visible only for authenticated users.)"
}
}
}
},
"responses": {
"UnauthorizedError": {
"description": "Access token is missing or invalid"
},
"ForbiddenError": {
"description": "Access denied"
}
}
}
}