メインコンテンツまでスキップ
API docs by Redocly

nimaruJA API Draft (0.0.1)

Download OpenAPI specification:Download

nimaruJA の連携用 API の仕様案です。

マスタデータ

すべての生産者を取得する

Responses

Response samples

Content type
application/json
[
  • {
    }
]

すべての生産者グループを取得する

Responses

Response samples

Content type
application/json
[
  • {
    }
]

すべての職員を取得する

Responses

Response samples

Content type
application/json
[
  • {
    }
]

すべての商品を取得する [実装予定]

商品の一覧を取得します。最大で同時に 1000 件まで取得できます。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

すべての等級を取得する [実装予定]

等級の一覧を取得します。最大で同時に 1000 件まで取得できます。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

すべての階級を取得する [実装予定]

階級の一覧を取得します。最大で同時に 1000 件まで取得できます。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

すべてのコミュニティを取得する [実装予定]

コミュニティの一覧を取得します。最大で同時に 1000 件まで取得できます。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

共販

共販の入荷情報を取得する [実装予定]

共販の入荷情報を取得します。最大で同時に 1000 件まで取得できます。

query Parameters
date
required
string <date>
Example: date=2023-03-29

入荷日

Responses

Response samples

Content type
application/json
[
  • {
    }
]

共販の出荷情報を取得する [実装予定]

共販の出荷情報を取得します。最大で同時に 1000 件まで取得できます。

query Parameters
date
required
string <date>
Example: date=2023-03-29

出荷日

Responses

Response samples

Content type
application/json
[
  • {
    }
]

お知らせ

すべてのお知らせカテゴリを取得する

Responses

Response samples

Content type
application/json
[
  • {
    }
]

お知らせの下書きを作成する

配信専用(返信不可)のお知らせの下書きを作成します。

Request Body schema: application/json
title
required
string

タイトル

body
required
string

本文

authorUserId
required
string

お知らせを作成した職員 ID

categoryId
required
string <uuid>

お知らせカテゴリ ID

required
AnnouncementTargetAll (object) or AnnouncementTargetGroup (object) or AnnouncementTargetIndividual (object) (AnnouncementTarget)

お知らせ送信先

Responses

Request samples

Content type
application/json
{
  • "title": "お知らせタイトル",
  • "body": "お知らせ本文",
  • "authorUserId": "7a8e7a82-8cdb-4cb8-926c-0a7d08518530",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "お知らせタイトル",
  • "body": "お知らせ本文",
  • "authorUserId": "7a8e7a82-8cdb-4cb8-926c-0a7d08518530",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "target": {
    }
}

お知らせにファイルを添付する

作成済みのお知らせ下書きにファイルを添付します。

path Parameters
announcementId
required
string <uuid>

お知らせ ID

Request Body schema: multipart/form-data
files
required
string <binary>

ファイルの本体。複数指定可。filename と Content-Type が必須です。1つのリクエストでアップロードするファイルの合計は10個以下にしてください。また、1つのファイルの容量は10MB以下にしてください。

Responses

お知らせの下書きを送信する

path Parameters
announcementId
required
string <uuid>

お知らせ ID

Responses

Response samples

Content type
application/json
{
  • "id": "4e9b545a-60da-4ea5-ad65-d148c64d72de",
  • "deliveredAt": "2019-08-24T14:15:22Z"
}

情報連絡

コミュニティのお知らせ配信カテゴリを取得する [実装予定]

コミュニティのお知らせ配信カテゴリを取得します。最大で同時に 1000 件まで取得できます。

query Parameters
communityId
required
string <uuid>

コミュニティ ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

コミュニティに所属する生産者を取得する [実装予定]

コミュニティに所属する生産者の一覧を取得します。最大で同時に 1000 件まで取得できます。

query Parameters
communityId
required
string <uuid>

コミュニティ ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

コミュニティに所属する生産者グループを取得する [実装予定]

コミュニティに所属する生産者グループの一覧を取得します。最大で同時に 1000 件まで取得できます。

query Parameters
communityId
required
string <uuid>

コミュニティ ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

お知らせの下書きを作成する

配信専用(返信不可)のお知らせの下書きを作成します。

path Parameters
communityId
required
string <uuid>

お知らせを配信するコミュニティの ID

Request Body schema: application/json
title
required
string

タイトル

body
string

本文

authorUserId
required
string

お知らせを作成した職員の ID

categoryId
required
string <uuid>

お知らせカテゴリ ID

required
CommunityAnnouncementTargetAll (object) or CommunityAnnouncementTargetGroup (object) or CommunityAnnouncementTargetIndividual (object) (CommunityAnnouncementTarget)

お知らせ送信先

Responses

Request samples

Content type
application/json
{
  • "title": "お知らせタイトル",
  • "body": "お知らせ本文",
  • "authorUserId": "7a8e7a82-8cdb-4cb8-926c-0a7d08518530",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "target": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "お知らせタイトル",
  • "body": "お知らせ本文",
  • "authorUserId": "7a8e7a82-8cdb-4cb8-926c-0a7d08518530",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "target": {
    }
}

お知らせにファイルを添付する

作成済みのお知らせ下書きにファイルを添付します。

path Parameters
communityId
required
string <uuid>

お知らせを配信するコミュニティの ID

announcementId
required
string <uuid>

お知らせ ID

Request Body schema: multipart/form-data
files
required
string <binary>

ファイルの本体。複数指定可。filename と Content-Type が必須です。1つのリクエストでアップロードするファイルの合計は10個以下にしてください。また、1つのファイルの容量は10MB以下にしてください。

Responses

お知らせの下書きを送信する

path Parameters
communityId
required
string <uuid>

お知らせを配信するコミュニティの ID

announcementId
required
string <uuid>

お知らせ ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deliveredAt": "2019-08-24T14:15:22Z"
}

選果機連携 (草案)

すべての選果プロジェクトを取得する [草案]

既存の選果プロジェクトを一覧表示します。GUI でも同様の操作が可能です。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

選果プロジェクトを作成する [草案]

新たな選果プロジェクトを作成します。GUI でも同様の操作が可能です。

Request Body schema: application/json
name
required
string

プロジェクト名

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

選果プロジェクトを取得する [草案]

指定したプロジェクト ID の詳細情報を取得します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

選果プロジェクトを更新する [草案]

プロジェクト名などを変更します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

選果プロジェクトを削除する [草案]

指定したプロジェクトを削除します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string

Responses

選果プロジェクト内のすべての規格を取得する [草案]

指定したプロジェクトの規格を一覧表示します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

選果プロジェクトに規格を作成する [草案]

指定したプロジェクトに新たな規格を追加します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
Request Body schema: application/json
name
required
string

規格名

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string"
}

選果プロジェクトの規格を取得する [草案]

指定した規格の情報を取得します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
productClassId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string"
}

選果プロジェクトの規格を更新する [草案]

規格名などの情報を更新します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
productClassId
required
string
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string"
}

選果プロジェクトの規格を削除する [草案]

指定した規格を削除します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
productClassId
required
string

Responses

選果プロジェクトのすべての選果機を取得する [草案]

指定したプロジェクトに所属する選果機の一覧を取得します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

選果プロジェクトに選果機を追加する [草案]

指定したプロジェクトに新たな選果機を登録します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
Request Body schema: application/json
name
required
string

選果機名（例：第1レーン など）

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string"
}

選果プロジェクトの選果機を取得する [草案]

指定した選果機の情報を取得します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
machineId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string"
}

選果プロジェクトの選果機を更新する [草案]

指定した選果機の情報を更新します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
machineId
required
string
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "name": "string"
}

選果プロジェクト内の選果機を削除する [草案]

指定した選果機を削除します。GUI でも同様の操作が可能です。

path Parameters
projectId
required
string
machineId
required
string

Responses

すべての選果セッションを取得する [草案]

指定したプロジェクトに属するセッションの一覧を取得します。

path Parameters
projectId
required
string
query Parameters
status
string
Enum: "active" "completed" "failed"

ステータスでフィルタリングする場合に使用

Responses

Response samples

Content type
application/json
[
  • {
    }
]

選果セッションを開始する [草案]

指定したプロジェクト内で新しいセッションを開始します。1つの選果機につきアクティブなセッションは同時に1つだけとなるよう実装上で制御してください。

path Parameters
projectId
required
string
Request Body schema: application/json
machineId
required
string

セッションを開始する選果機のID

producerId
string or null

生産者ID。分からない場合は null で開始し、後で更新します。

Responses

Request samples

Content type
application/json
{
  • "machineId": "string",
  • "producerId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "machineId": "9f61f395-8150-4531-9240-2cb221ad2692",
  • "producerId": "09cbf28b-153f-46c1-af4f-7ee5a3a319fc",
  • "evaluation": {
    },
  • "status": "active"
}

選果セッションを取得する [草案]

指定したセッションの詳細を取得します。

path Parameters
projectId
required
string
sessionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "machineId": "9f61f395-8150-4531-9240-2cb221ad2692",
  • "producerId": "09cbf28b-153f-46c1-af4f-7ee5a3a319fc",
  • "evaluation": {
    },
  • "status": "active"
}

選果セッションを更新する [草案]

セッションに紐づく生産者ID (producerId) などを更新します。ステータス変更は別途 /status エンドポイントを使用してください。

path Parameters
projectId
required
string
sessionId
required
string
Request Body schema: application/json
producerId
string or null

Responses

Request samples

Content type
application/json
{
  • "producerId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "machineId": "9f61f395-8150-4531-9240-2cb221ad2692",
  • "producerId": "09cbf28b-153f-46c1-af4f-7ee5a3a319fc",
  • "evaluation": {
    },
  • "status": "active"
}

選果セッションのステータスを変更する [草案]

セッションのステータスを "active" / "completed" / "failed" に変更します。"active" に変更する場合は、既に同じ選果機でアクティブなセッションが無いことを保証してください。

path Parameters
projectId
required
string
sessionId
required
string
Request Body schema: application/json
status
required
string
Enum: "active" "completed" "failed"

変更先のステータス

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "machineId": "9f61f395-8150-4531-9240-2cb221ad2692",
  • "producerId": "09cbf28b-153f-46c1-af4f-7ee5a3a319fc",
  • "evaluation": {
    },
  • "status": "active"
}

選果セッションの評価情報を設定する [草案]

セッションの evaluation フィールドに対して、単一階層の JSON オブジェクトをマージします。同じキーが既にある場合は上書きされます。

path Parameters
projectId
required
string
sessionId
required
string
Request Body schema: application/json
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "machineId": "9f61f395-8150-4531-9240-2cb221ad2692",
  • "producerId": "09cbf28b-153f-46c1-af4f-7ee5a3a319fc",
  • "evaluation": {
    },
  • "status": "active"
}

選果セッションのすべての出来高を取得する [草案]

指定したセッションに含まれる出来高を取得します。

path Parameters
projectId
required
string
sessionId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

選果セッションに出来高を登録する [草案]

選果された結果（個数や重量）をまとめて登録します。1回のリクエストで複数アイテムを一括で追加できます。

path Parameters
projectId
required
string
sessionId
required
string
Request Body schema: application/json
Array
productClassId
string <uuid>
count
integer
weight
number

グラム（g）

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]