nexudus

Nexudus CLI エージェントスキル

nexudus CLI ツールを使用して、Nexudus のコワーキングスペースを管理できます。このスキルでは、Nexudus プラットフォーム API に対する認証、データの照会、CRUD 操作の実行方法を説明します。

エージェントの必須ルール

1. すべての CLI 呼び出しで、必ず --agent フラグを使用してください。機械処理に最適化された構造化 JSON エンベロープが返されます。

2. 結果に基づいて操作する前に、JSON エンベロープを解析してください。エンベロープの形式は次のとおりです。

   {
     "ok": true,
     "data": { ... },
     "summary": "Human-readable summary",
     "breadcrumbs": ["entity", "action"],
     "meta": { "total": 10, "page": 1, "pageSize": 25, "totalPages": 1 }
   }
   

3. 最初に ok を確認してください。ok が false の場合は、summary でエラーメッセージを確認し、処理を中止してください。

4. 認証情報を対話形式でユーザーに求めないでください。認証エラーにより ok が false の場合は、ユーザーに手動で nexudus login を実行するよう伝えてください。

5. 削除コマンドでは --yes または -y を使用して、対話形式の確認プロンプトをスキップしてください。

6. スクリプトで生データが必要な場合は --json を使用してください。概要付きのエンベロープが必要な場合は --agent を使用してください。

7. 一覧のレスポンスにはコレクションプロパティが含まれません。API は、単一のエンティティを ID で取得する場合（get <id>）にのみ、リスト／配列フィールド（例：Tariffs、Teams、LinkedResources）を返します。一覧コマンドは、これらのフィールドを含まない簡易化されたデータを返します。コレクションプロパティの読み取りや確認が必要な場合は、必ず最初に個別のエンティティを取得してください。

8. ビジネス、通貨、国、タイムゾーンには、現在のユーザーのデフォルト値を使用してください。ビジネス（場所）、通貨、国、タイムゾーンが必要なエンティティを作成または更新する前に、nexudus whoami --agent を実行し、レスポンスにあるデフォルト値を使用してください。

   • DefaultBusinessId — 場所に関連付けられたエンティティを作成するときに、--business として使用します。
   • DefaultCurrencyId — 通貨が必要な場合に、--currency-id として使用します。
   • DefaultCurrencyCode — 表示／参照用に使用します。
   • DefaultCountryId — 国が必要な場合に、--country-id として使用します。
   • DefaultSimpleTimeZoneId — タイムゾーンが必要な場合に、--timezone-id として使用します。

   ユーザーがデフォルト値を明示的に上書きしたい場合にのみ、これらの値を指定するよう求めてください。

9. リストプロパティには、--added-{list}／--removed-{list} よりも --{list} を優先してください。リストフィールド（例：--tariffs、--resource-types、--teams、--linked-resources）を設定する場合は、通常の --{list} フラグを使用して、指定した値でリスト全体を置き換えてください。既存のリストのほかの内容に触れず、個別の項目を追加または削除する必要がある場合にのみ、--added-{list} または --removed-{list} を使用してください。リスト全体を設定するつもりで --added-{list} を渡すのはよくある間違いで、古い項目が残ってしまいます。

10. フィールドが不明な場合は、まず --help を実行してください。このスキルファイルでエンティティやオプションが十分に説明されていない場合は、コマンドを組み立てる前に nexudus <entity> <command> --help を実行して、利用可能なオプションとその説明を確認してください。

11. DateTime 値には ISO 8601 形式を使用する必要があります。すべての DateTime フィールドには、YYYY-MM-DDTHH:MM:SSZ（UTC）の形式で値を渡してください。例：2025-06-15T09:00:00Z。June 15, 2025、15/06/2025、Unix タイムスタンプなど、ロケール固有の形式は使用しないでください。エンティティのリファレンスファイルでは、DateTime オプションに (DateTime) と注記されているため、識別できます。

12. すべての CLI 呼び出しで、必ずテレメトリコンテキストフラグを渡してください。必要なフラグと値の生成方法については、以下のテレメトリコンテキストセクションを参照してください。

初期設定

まず診断を実行して、CLI を使用できる状態か確認してください。

nexudus doctor --agent

CLI のバージョン、.NET ランタイム、OS、認証情報の状態、設定ファイルの場所、API 接続状態、および利用可能なすべてのコマンドが返されます。続行する前に data.CredentialsStored と data.ApiStatus を確認してください。

認証情報がない場合は、ユーザーに次のように案内してください。

Nexudus アカウントで認証するには、nexudus login を実行してください。

CLI の確認

利用可能なコマンドとオプションは、いつでも確認できます。

nexudus --help
nexudus businesses --help
nexudus products --help
nexudus config --help

各コマンドでは、詳細なオプション情報を確認するために --help も使用できます。

nexudus businesses update --help
nexudus products create --help

コマンドリファレンス

認証

コマンド	説明
nexudus login	認証します（対話型プロンプト）
nexudus logout	保存済みの認証情報を消去します
nexudus whoami	現在認証されているユーザーを表示します

設定

コマンド	説明
nexudus config get <key>	設定値を読み取ります
nexudus config set <key> <value>	設定値を設定します

設定キー：base-url

診断

nexudus doctor --agent

グローバルフラグ

フラグ	説明
--agent	要約を含む JSON エンベロープ（これを使用）
--json	生の JSON エンベロープ
--md	Markdown 出力
--base-url <url>	API のベース URL を上書きします
--trace-id <uuid>	1 つのタスク内でコマンドを関連付けるトレース ID
--caller <name>	呼び出し元エージェントの名前（例：copilot、claude）
--intent <text>	ユーザーのリクエストの1行要約
--attempt <n>	このコマンドの試行回数（1 = 初回）

テレメトリコンテキスト

エージェントからのすべての CLI 呼び出しには、コマンドの使用状況を追跡、関連付け、デバッグできるように、4 つのテレメトリフラグを必ず含めてください。

フラグ	設定方法	例
--trace-id	ユーザータスクごとに1つの UUID を生成し、そのタスク内のすべての CLI 呼び出しで再利用します。	--trace-id a1b2c3d4-e5f6-7890-abcd-ef1234567890
--caller	エージェントを識別する固定文字列です。エージェント名を小文字で使用します。	--caller copilot
--intent	ユーザーの依頼内容を簡潔に（120文字以内で）要約します。タスク内のすべての呼び出しで同じ値を使用します。スペースを含む場合は引用符で囲みます。	--intent "list all products for the London business"
--attempt	1 から始めます。失敗後に同じコマンドを再試行する場合は値を増やします。別のコマンドでは 1 に戻します。	--attempt 1

例：テレメトリを含む完全な呼び出し

nexudus products list --agent --trace-id a1b2c3d4-e5f6-7890-abcd-ef1234567890 --caller copilot --intent "list all products" --attempt 1

ルール

• 同じユーザータスク／会話ターン内のすべての呼び出しで、同じ --trace-id を使用します。
• 失敗後に完全に同じコマンドを再試行する場合にのみ、--attempt を増やします。
• --caller はエージェントの稼働中、同じ値を維持する必要があります（例：copilot、claude、custom-bot）。
• --intent には CLI コマンドの説明ではなく、ユーザーの元の依頼内容を指定します。
• --agent が設定され、テレメトリフラグが指定されている場合、レスポンスエンベロープには参考情報として traceId、durationMs、attempt を含む telemetry オブジェクトが含まれます。

出力エンベロープ

--agent または --json を使用すると、すべてのコマンドで JSON エンベロープが生成されます。

{
  "ok": true,
  "data": [ ... ],
  "summary": "Found 3 businesses (page 1/1)",
  "breadcrumbs": ["businesses", "list"],
  "meta": {
    "total": 3,
    "page": 1,
    "pageSize": 25,
    "totalPages": 1
  }
}

• ok：成功時は true、失敗時は false です。
• data：レスポンスのペイロードです。単一エンティティの操作ではオブジェクト、一覧では配列、一部の失敗時には null になります。
• summary：結果を人が読める形式で説明します。
• breadcrumbs：出力を生成したコマンドパスです（例：["products", "create"]）。
• meta：一覧操作のページネーションメタデータです（一覧コマンドでのみ存在します）。

PII のマスキング

CLI は、非対話モードで個人を特定できる情報を自動的にマスキングします。この動作は構造上のものであり、呼び出し元のフラグでは制御できません。

• リダイレクト／エージェント向けの出力では、PII の値は «PII:EMAIL:a3f2b1c9» のような決定的トークンとして表示されます。
• 同じマシンでは、同じ元の値に対して常に同じトークンが生成されます。
• トークンを create/update コマンドに渡すことができます。CLI は API 呼び出しの前に、トークンを実際の値に解決します。
• 非対話型の応答には piiRedaction と piiRedactionReason が含まれるため、モードを確認できます。

トークンの往復処理の例：

nexudus coworkers update 12345 --email "«PII:EMAIL:a3f2b1c9»" --agent

トークンを実際の値として扱ったり、元に戻そうとしたりしないでください。

エラーエンベロープ

{
  "ok": false,
  "data": null,
  "summary": "Not logged in. Run 'nexudus login' first.",
  "breadcrumbs": ["businesses", "list"]
}

判断ツリー

「ビジネスを検索して表示する」

1. nexudus businesses list --agent を実行します（検索する場合は --name "value" などのフィルターオプションを使用します）。
2. data 配列を解析し、対象のビジネスを見つけます。
3. 詳細を取得するには、nexudus businesses get <id> --agent を実行します。

「エンティティを作成する」

1. まずビジネス ID を確認します：nexudus businesses list --agent
2. nexudus <entity> create --name "Day Pass" --price 25.00 --business <businessId> --agent
3. ok が true であることを確認し、新しいエンティティ ID を data.Id から読み取ります。

「エンティティのプロパティを更新する」

1. nexudus <entity> get <id> --agent を実行し、エンティティが存在することを確認します。
2. nexudus <entity> update <id> --<property> <value> --agent
3. 返された data を確認して、更新を検証します。

「エンティティを削除する」

1. nexudus <entity> get <id> --agent を実行し、エンティティが存在することを確認します。
2. nexudus <entity> delete <id> --yes --agent
3. ok が true であることを確認します。

「特定のビジネスのエンティティを一覧表示する」

1. nexudus <entity> list --business <businessId> --agent
2. ページネーションには、--page-number N --page-size M を追加します。

「エンティティに対してエンティティコマンドを実行する」

1. nexudus <entity> commands --agent を実行し、使用できるコマンドを確認します。
2. nexudus <entity> run-command <commandKey> <id1,id2> --agent
3. コマンドでパラメーターが必要な場合は、-p Name=Value で追加します。

「CLI の稼働状況を確認する」

1. nexudus doctor --agent
2. data.CredentialsStored が true であることを確認します。
3. data.ApiStatus が "OK" であることを確認します。

エンティティ固有のワークフロー（例：商品へのパスの追加、価格設定）は、references/entities/ にある対応するエンティティのリファレンスファイルに記載されています。

エラー処理

エラー	意味	対応
ok: false、summary に "Not logged in" が含まれる	保存済みの認証情報がありません	nexudus login を実行するようユーザーに伝えます
ok: false、summary に "Unauthorized" が含まれる	認証情報が無効です	nexudus login をもう一度実行するようユーザーに伝えます
ok: false、summary に "Forbidden" が含まれる	権限が不足しています	API の権限がないことをユーザーに伝えます
ok: false、summary に "not found" が含まれる	エンティティが存在しません	ID を確認して、もう一度試します
ok: false、summary に "Failed to create" が含まれる	作成時の検証エラーです	必須フィールド（name、business、price）を確認します
終了コードがゼロ以外	コマンドが失敗しました	詳細について stderr または JSON エンベロープを確認します

エンティティインデックス

エンティティを操作する前に、そのリファレンスファイルを読み込み、コマンド、オプション、主要なフィールド、列挙値、エンティティ固有のワークフローなどの詳細を確認してください。

エンティティ	CLI コマンド	操作	参照
AccessToken	accesstokens	一覧取得、取得、作成、更新、削除	accesstokens.md
AdminAgentMessage	adminagentmessages	一覧取得、取得、作成、更新、削除	adminagentmessages.md
AdminAgentSession	adminagentsessions	一覧取得、取得、作成、更新、削除	adminagentsessions.md
AdminAgentSessionParticipant	adminagentsessionparticipants	一覧取得、取得、作成、更新、削除	adminagentsessionparticipants.md
AiChannelSession	aichannelsessions	一覧取得、取得、作成、更新、削除	aichannelsessions.md
Application	applications	一覧取得、取得、作成、更新、削除	applications.md
AudioFile	audiofiles	一覧取得、取得、作成、更新、削除	audiofiles.md
AuditTrailEntry	audittrailentries	一覧取得、取得	audittrailentries.md
AutomationTile	automationtiles	一覧取得、取得、作成、更新、削除	automationtiles.md
AutomationTileAudit	automationtileaudits	一覧取得、取得、作成、更新、削除	automationtileaudits.md
BasketSession	basketsessions	一覧取得、取得、作成、更新、削除	basketsessions.md
BlogCategory	blogcategories	一覧取得、取得、作成、更新、削除	blogcategories.md
BlogPost	blogposts	一覧取得、取得、作成、更新、削除	blogposts.md
BlogPostComment	blogpostcomments	一覧取得、取得、作成、更新、削除	blogpostcomments.md
Booking	bookings	一覧取得、取得、作成、更新、削除	bookings.md
BookingAvailabilityException	bookingavailabilityexceptions	一覧取得、取得、作成、更新、削除	bookingavailabilityexceptions.md
BookingNote	bookingnotes	一覧取得、取得、作成、更新、削除	bookingnotes.md
BookingProduct	bookingproducts	一覧取得、取得、作成、更新、削除	bookingproducts.md
BookingVisitor	bookingvisitors	一覧取得、取得、作成、更新、削除	bookingvisitors.md
Business	businesses	一覧取得、取得、更新	businesses.md
BusinessAnnouncement	businessannouncements	一覧取得、取得、作成、更新、削除	businessannouncements.md
BusinessBackgroundJob	businessbackgroundjobs	一覧取得、取得	businessbackgroundjobs.md
BusinessCharge	businesscharges	一覧取得、取得、作成、更新、削除	businesscharges.md
BusinessDomain	businessdomains	一覧取得、取得、作成、更新、削除	businessdomains.md
BusinessRedirection	businessredirections	一覧取得、取得、作成、更新、削除	businessredirections.md
BusinessSetting	businesssettings	一覧取得、取得、作成、更新、削除	businesssettings.md
BusinessTimeSlot	businesstimeslots	一覧取得、取得、作成、更新、削除	businesstimeslots.md
CalendarEvent	calendarevents	一覧取得、取得、作成、更新、削除	calendarevents.md
CalendarEventCategory	calendareventcategories	一覧取得、取得、作成、更新、削除	calendareventcategories.md
CancelledBooking	cancelledbookings	一覧取得、取得、作成、更新、削除	cancelledbookings.md
CannedResponse	cannedresponses	一覧取得、取得、作成、更新、削除	cannedresponses.md
Charge	charges	一覧取得、取得、作成、更新、削除	charges.md
ChatRoom	chatrooms	一覧取得、取得、作成、更新、削除	chatrooms.md
ChatUserMessage	chatusermessages	一覧取得、取得、作成、更新、削除	chatusermessages.md
Checkin	checkins	一覧取得、取得、作成、更新、削除	checkins.md
CommunityGroup	communitygroups	一覧取得、取得、作成、更新、削除	communitygroups.md
CommunityMessage	communitymessages	一覧取得、取得、作成、更新、削除	communitymessages.md
CommunityMessageLike	communitymessagelikes	一覧取得、取得、作成、更新、削除	communitymessagelikes.md
CommunityMessageRead	communitymessagereads	一覧取得、取得、作成、更新、削除	communitymessagereads.md
CommunityPerk	communityperks	一覧取得、取得、作成、更新、削除	communityperks.md
CommunityThread	communitythreads	一覧取得、取得、作成、更新、削除	communitythreads.md
CommunityThreadFile	communitythreadfiles	一覧取得、取得、作成、更新、削除	communitythreadfiles.md
CommunityThreadFollow	communitythreadfollows	一覧取得、取得、作成、更新、削除	communitythreadfollows.md
CommunityThreadLike	communitythreadlikes	一覧取得、取得、作成、更新、削除	communitythreadlikes.md
CommunityThreadMute	communitythreadmutes	一覧取得、取得、作成、更新、削除	communitythreadmutes.md
CommunityThreadRead	communitythreadreads	一覧取得、取得、作成、更新、削除	communitythreadreads.md
ContractContact	contractcontacts	一覧取得、取得、作成、更新、削除	contractcontacts.md
ContractDeposit	contractdeposits	一覧取得、取得、作成、更新、削除	contractdeposits.md
ContractPausedPeriod	contractpausedperiods	一覧取得、取得、作成、更新、削除	contractpausedperiods.md
ContractProduct	contractproducts	一覧取得、取得、作成、更新、削除	contractproducts.md
ContractSchedule	contractschedules	一覧取得、取得、作成、更新、削除	contractschedules.md
Country	countries	一覧取得、取得	countries.md
Course	courses	一覧取得、取得、作成、更新、削除	courses.md
CourseCompletedLesson	coursecompletedlessons	一覧取得、取得、作成、更新、削除	coursecompletedlessons.md
CourseLesson	courselessons	一覧取得、取得、作成、更新、削除	courselessons.md
CourseMember	coursemembers	一覧取得、取得、作成、更新、削除	coursemembers.md
CourseSection	coursesections	一覧取得、取得、作成、更新、削除	coursesections.md
Coworker	coworkers	一覧取得、取得、作成、更新、コマンド	coworkers.md
CoworkerAccessControlAudit	coworkeraccesscontrolaudits	一覧取得、取得、作成、更新、削除	coworkeraccesscontrolaudits.md
CoworkerBookingCredit	coworkerbookingcredits	一覧取得、取得、作成、更新、削除	coworkerbookingcredits.md
CoworkerBookingCreditUseHistory	coworkerbookingcreditusehistories	一覧取得、取得、作成、更新	coworkerbookingcreditusehistories.md
CoworkerContract	coworkercontracts	一覧取得、取得、作成、更新、削除	coworkercontracts.md
CoworkerDataFile	coworkerdatafiles	一覧取得、取得、作成、更新、削除	coworkerdatafiles.md
CoworkerDelivery	coworkerdeliveries	一覧取得、取得、作成、更新、削除	coworkerdeliveries.md
CoworkerDiscountCode	coworkerdiscountcodes	一覧取得、取得、作成、更新、削除	coworkerdiscountcodes.md
CoworkerExtraService	coworkerextraservices	一覧取得、取得、作成、更新、削除	coworkerextraservices.md
CoworkerExtraServiceUseHistory	coworkerextraserviceusehistories	一覧取得、取得、作成、更新、削除	coworkerextraserviceusehistories.md
CoworkerGoogleCalendar	coworkergooglecalendars	一覧取得、取得、作成、更新、削除	coworkergooglecalendars.md
CoworkerIdentityCheck	coworkeridentitychecks	一覧取得、取得、作成、更新、削除	coworkeridentitychecks.md
CoworkerIdentityCheckDocument	coworkeridentitycheckdocuments	一覧取得、取得、作成、更新、削除	coworkeridentitycheckdocuments.md
CoworkerInventoryAsset	coworkerinventoryassets	一覧取得、取得、作成、更新、削除	coworkerinventoryassets.md
CoworkerInvoice	coworkerinvoices	一覧取得、取得、更新	coworkerinvoices.md
CoworkerInvoiceHistory	coworkerinvoicehistories	一覧取得、取得、作成、更新、削除	coworkerinvoicehistories.md
CoworkerInvoiceLine	coworkerinvoicelines	一覧取得、取得、更新	coworkerinvoicelines.md
CoworkerInvoicePaymentToken	coworkerinvoicepaymenttokens	一覧取得、取得、作成、更新、削除	coworkerinvoicepaymenttokens.md
CoworkerLedgerEntry	coworkerledgerentries	一覧取得、取得、作成、更新、削除	coworkerledgerentries.md
CoworkerLegalContentAudit	coworkerlegalcontentaudits	一覧取得、取得、作成、更新、削除	coworkerlegalcontentaudits.md
CoworkerMessage	coworkermessages	一覧取得、取得	coworkermessages.md
CoworkerMsOfficeCalendar	coworkermsofficecalendars	一覧取得、取得、作成、更新、削除	coworkermsofficecalendars.md
CoworkerNote	coworkernotes	一覧取得、取得、作成、更新、削除	coworkernotes.md
CoworkerNotification	coworkernotifications	一覧取得、取得、作成、更新、削除	coworkernotifications.md
CoworkerPaymentMethod	coworkerpaymentmethods	一覧取得、取得、作成、更新、削除	coworkerpaymentmethods.md
CoworkerPricePlanHistory	coworkerpriceplanhistories	一覧取得、取得	coworkerpriceplanhistories.md
CoworkerProduct	coworkerproducts	一覧取得、取得、作成、更新、削除	coworkerproducts.md
CoworkerReminderAudit	coworkerreminderaudits	一覧取得、取得、作成、更新、削除	coworkerreminderaudits.md
CoworkerSetting	coworkersettings	一覧取得、取得、作成、更新、削除	coworkersettings.md
CoworkerTask	coworkertasks	一覧取得、取得、作成、更新、削除	coworkertasks.md
CoworkerTimePass	coworkertimepasses	一覧取得、取得、作成、更新、削除	coworkertimepasses.md
CrmBoard	crmboards	一覧取得、取得、作成、更新、削除	crmboards.md
CrmBoardColumn	crmboardcolumns	一覧取得、取得、作成、更新、削除	crmboardcolumns.md
CrmOpportunity	crmopportunities	一覧取得、取得、作成、更新、削除	crmopportunities.md
CrmOpportunityHistory	crmopportunityhistories	一覧取得、取得、作成、更新、削除	crmopportunityhistories.md
CrmOpportunityImportFile	crmopportunityimportfiles	一覧取得、取得、作成、更新、削除	crmopportunityimportfiles.md
Currency	currencies	一覧取得、取得	currencies.md
CustomField	customfields	一覧取得、取得、作成、更新、削除	customfields.md
DataFile	datafiles	一覧取得、取得、作成、更新、削除	datafiles.md
DiscountCode	discountcodes	一覧取得、取得、作成、更新、削除	discountcodes.md
DocumentTemplate	documenttemplates	一覧取得、取得、作成、更新、削除	documenttemplates.md
EloxxLockersAudit	eloxxlockersaudits	一覧取得、取得、作成、更新、削除	eloxxlockersaudits.md
EmailAccount	emailaccounts	一覧取得、取得、作成、更新、削除	emailaccounts.md
EmailQueueItem	emailqueueitems	一覧取得、取得	emailqueueitems.md
EmailQueueItemAttachment	emailqueueitemattachments	一覧取得、取得、更新	emailqueueitemattachments.md
EmailTemplateFile	emailtemplatefiles	一覧取得、取得、作成、更新、削除	emailtemplatefiles.md
EventAttendee	eventattendees	一覧取得、取得、作成、更新、削除	eventattendees.md
EventComment	eventcomments	一覧取得、取得、作成、更新、削除	eventcomments.md
EventProduct	eventproducts	一覧取得、取得、作成、更新、削除	eventproducts.md
EventWaitingAttendee	eventwaitingattendees	一覧取得、取得、作成、更新、削除	eventwaitingattendees.md
ExtraService	extraservices	一覧取得、取得、作成、更新、削除	extraservices.md
ExtraServicePrice	extraserviceprices	一覧取得、取得、作成、更新、削除	extraserviceprices.md
ExtraServiceTimeSlot	extraservicetimeslots	一覧取得、取得、作成、更新、削除	extraservicetimeslots.md
FailedCheckin	failedcheckins	一覧取得、取得、作成、更新、削除	failedcheckins.md
FaqArticle	faqarticles	一覧取得、取得、作成、更新、削除	faqarticles.md
FinancialAccount	financialaccounts	一覧取得、取得、作成、更新、削除	financialaccounts.md
FloorPlan	floorplans	一覧取得、取得、作成、更新、削除	floorplans.md
FloorPlanAsset	floorplanassets	一覧取得、取得	floorplanassets.md
FloorPlanDesk	floorplandesks	一覧取得、取得、作成、更新、削除	floorplandesks.md
FloorPlanDeskVariant	floorplandeskvariants	一覧取得、取得、作成、更新、削除	floorplandeskvariants.md
FloorPlanLayout	floorplanlayouts	一覧取得、取得、作成、更新、削除	floorplanlayouts.md
FloorPlanLayoutArea	floorplanlayoutareas	一覧取得、取得、作成、更新、削除	floorplanlayoutareas.md
FloorPlanLayoutAsset	floorplanlayoutassets	一覧取得、取得、作成、更新、削除	floorplanlayoutassets.md
FloorPlanLayoutEdge	floorplanlayoutedges	一覧取得、取得、作成、更新、削除	floorplanlayoutedges.md
FloorPlanLayoutNode	floorplanlayoutnodes	一覧取得、取得、作成、更新、削除	floorplanlayoutnodes.md
FloorPlanLayoutOpening	floorplanlayoutopenings	一覧取得、取得、作成、更新、削除	floorplanlayoutopenings.md
FloorplanLayoutTransition	floorplanlayouttransitions	一覧取得、取得、作成、更新、削除	floorplanlayouttransitions.md
FormPage	formpages	一覧取得、取得、作成、更新、削除	formpages.md
FormPageAnswer	formpageanswers	一覧取得、取得、作成、更新	formpageanswers.md
FormPageQuestion	formpagequestions	一覧取得、取得、作成、更新、削除	formpagequestions.md
FormPageRequest	formpagerequests	一覧取得、取得、作成、更新、削除	formpagerequests.md
GlobalChatMessage	globalchatmessages	一覧取得、取得、作成、更新、削除	globalchatmessages.md
HelpDeskComment	helpdeskcomments	一覧取得、取得、作成、更新、削除	helpdeskcomments.md
HelpDeskDepartment	helpdeskdepartments	一覧取得、取得、作成、更新、削除	helpdeskdepartments.md
HelpDeskMessage	helpdeskmessages	一覧取得、取得、作成、更新、削除	helpdeskmessages.md
ImageFile	imagefiles	一覧取得、取得、作成、更新、削除	imagefiles.md
InstalledApplication	installedapplications	一覧取得、取得、作成、更新、削除	installedapplications.md
InstalledMarketPlaceApplication	installedmarketplaceapplications	一覧取得、取得、作成、更新、削除	installedmarketplaceapplications.md
InventoryAsset	inventoryassets	一覧取得、取得、作成、更新、削除	inventoryassets.md
Invoice	invoices	一覧取得、取得、更新	invoices.md
Language	languages	一覧取得、取得、作成、更新、削除	languages.md
LanguageToken	languagetokens	一覧取得、取得、作成、更新、削除	languagetokens.md
LedgerEntry	ledgerentries	一覧取得、取得	ledgerentries.md
LegalContentAudit	legalcontentaudits	一覧取得、取得、作成、更新、削除	legalcontentaudits.md
LogEntry	logentries	一覧取得、取得	logentries.md
MarketPlaceApplication	marketplaceapplications	一覧取得、取得、作成、更新、削除	marketplaceapplications.md
MsOfficeAdminCalendar	msofficeadmincalendars	一覧取得、取得、作成、更新、削除	msofficeadmincalendars.md
NewsLetter	newsletters	一覧取得、取得、作成、更新、削除	newsletters.md
NewsLetterSubscriber	newslettersubscribers	一覧取得、取得、作成、更新、削除	newslettersubscribers.md
OpenAiChatMessage	openaichatmessages	一覧取得、取得、作成、更新、削除	openaichatmessages.md
OpportunityType	opportunitytypes	一覧取得、取得、作成、更新、削除	opportunitytypes.md
PassportCard	passportcards	一覧取得、取得、作成、更新、削除	passportcards.md
PaymentGateway	paymentgateways	一覧取得、取得、作成、更新、削除	paymentgateways.md
PayoutInvoice	payoutinvoices	一覧取得、取得、作成、更新、削除	payoutinvoices.md
PlatformChangeMessage	platformchangemessages	一覧取得、取得、作成、更新、削除	platformchangemessages.md
ProactiveActionConfig	proactiveactionconfigs	一覧取得、取得、作成、更新、削除	proactiveactionconfigs.md
Product	products	一覧取得、取得、作成、更新、削除、コマンド	products.md
ProductBookingCredit	productbookingcredits	一覧取得、取得、作成、更新、削除	productbookingcredits.md
ProductExtraService	productextraservices	一覧取得、取得、作成、更新、削除	productextraservices.md
ProductTimePass	producttimepasses	一覧取得、取得、作成、更新、削除	producttimepasses.md
Proposal	proposals	一覧取得、取得、作成、更新、削除	proposals.md
ProposalContract	proposalcontracts	一覧取得、取得、作成、更新、削除	proposalcontracts.md
ProposalContractSchedule	proposalcontractschedules	一覧取得、取得、作成、更新、削除	proposalcontractschedules.md
ProposalProduct	proposalproducts	一覧取得、取得、作成、更新、削除	proposalproducts.md
ProposalSchedule	proposalschedules	一覧取得、取得、作成、更新、削除	proposalschedules.md
ProposedAction	proposedactions	一覧取得、取得、作成、更新、削除	proposedactions.md
RadiusServer	radiusservers	一覧取得、取得、作成、更新、削除	radiusservers.md
RecordCreationWorkflow	recordcreationworkflows	一覧取得、取得、作成、更新、削除	recordcreationworkflows.md
RecordCreationWorkflowVersion	recordcreationworkflowversions	一覧取得、取得、作成、更新、削除	recordcreationworkflowversions.md
RefreshToken	refreshtokens	一覧取得、取得、作成、更新、削除	refreshtokens.md
RegisteredDevice	registereddevices	一覧取得、取得、更新	registereddevices.md
Reminder	reminders	一覧取得、取得、作成、更新、削除	reminders.md
Report	reports	一覧取得、取得、作成、更新、削除	reports.md
ReportDashboard	reportdashboards	一覧取得、取得、作成、更新、削除	reportdashboards.md
ReportDefinition	reportdefinitions	一覧取得、取得、作成、更新、削除	reportdefinitions.md
ReportSubscription	reportsubscriptions	一覧取得、取得、作成、更新、削除	reportsubscriptions.md
Reseller	resellers	一覧取得、取得、作成、更新、削除	resellers.md
ResellerAccount	reselleraccounts	一覧取得、取得、作成、更新、削除	reselleraccounts.md
ResellerPayout	resellerpayouts	一覧取得、取得、作成、更新、削除	resellerpayouts.md
Resource	resources	一覧取得、取得、作成、更新、削除	resources.md
ResourceAccessRule	resourceaccessrules	一覧取得、取得、作成、更新、削除	resourceaccessrules.md
ResourceAccessRuleEligibleTimeSlot	resourceaccessruleeligibletimeslots	一覧取得、取得、作成、更新、削除	resourceaccessruleeligibletimeslots.md
ResourceAccessRuleTimeSlot	resourceaccessruletimeslots	一覧取得、取得、作成、更新、削除	resourceaccessruletimeslots.md
ResourceProduct	resourceproducts	一覧取得、取得、作成、更新、削除	resourceproducts.md
ResourceTimeSlot	resourcetimeslots	一覧取得、取得、作成、更新、削除	resourcetimeslots.md
ResourceType	resourcetypes	一覧取得、取得、作成、更新、削除	resourcetypes.md
Role	roles	一覧取得、取得	roles.md
Sensor	sensors	一覧取得、取得、作成、更新、削除	sensors.md
SensorHistory	sensorhistories	一覧取得、取得、作成、更新、削除	sensorhistories.md
SimpleTimeZone	simpletimezones	一覧取得、取得、更新	simpletimezones.md
SubscriberActivity	subscriberactivities	一覧取得、取得	subscriberactivities.md
SubscriberGroup	subscribergroups	一覧取得、取得、作成、更新、削除	subscribergroups.md
Survey	surveys	一覧取得、取得、作成、更新、削除	surveys.md
SurveyAnswer	surveyanswers	一覧取得、取得、作成、更新、削除	surveyanswers.md
SurveyQuestion	surveyquestions	一覧取得、取得、作成、更新、削除	surveyquestions.md
SurveyRun	surveyruns	一覧取得、取得、作成、更新、削除	surveyruns.md
SystemNotification	systemnotifications	一覧取得、取得、作成、更新、削除	systemnotifications.md
Tariff	tariffs	一覧取得、取得、作成、更新、削除	tariffs.md
TariffBookingCredit	tariffbookingcredits	一覧取得、取得、作成、更新、削除	tariffbookingcredits.md
TariffDefaultDueDate	tariffdefaultduedates	一覧取得、取得、作成、更新、削除	tariffdefaultduedates.md
TariffExtraService	tariffextraservices	一覧取得、取得、作成、更新、削除	tariffextraservices.md
TariffProduct	tariffproducts	一覧取得、取得、作成、更新、削除	tariffproducts.md
TariffSignupProduct	tariffsignupproducts	一覧取得、取得、作成、更新、削除	tariffsignupproducts.md
TariffTimePass	tarifftimepasses	一覧取得、取得、作成、更新、削除	tarifftimepasses.md
TaskItem	taskitems	一覧取得、取得、作成、更新、削除	taskitems.md
TaskList	tasklists	一覧取得、取得、作成、更新、削除	tasklists.md
TaxRate	taxrates	一覧取得、取得、作成、更新、削除	taxrates.md
Team	teams	一覧取得、取得、作成、更新、削除	teams.md
TemplateFile	templatefiles	一覧取得、取得、作成、更新、削除	templatefiles.md
TemplateVersion	templateversions	一覧取得、取得、作成、更新、削除	templateversions.md
Ticket	tickets	一覧取得、取得、作成、更新、削除	tickets.md
TimePass	timepasses	一覧取得、取得、作成、更新、削除	timepasses.md
TimePassPrice	timepassprices	一覧取得、取得、作成、更新、削除	timepassprices.md
TimePassTimeSlot	timepasstimeslots	一覧取得、取得、作成、更新、削除	timepasstimeslots.md
UiModule	uimodules	一覧取得、取得、作成、更新、削除	uimodules.md
User	users	一覧取得、取得、作成、更新、削除	users.md
UserBookmark	userbookmarks	一覧取得、取得、作成、更新、削除	userbookmarks.md
UserMessage	usermessages	一覧取得、取得	usermessages.md
UserRole	userroles	一覧取得、取得、作成、更新、削除	userroles.md
ValidationRule	validationrules	一覧取得、取得、作成、更新、削除	validationrules.md
VideoFile	videofiles	一覧取得、取得、作成、更新、削除	videofiles.md
VideoRoom	videorooms	一覧取得、取得、作成、更新、削除	videorooms.md
Visitor	visitors	一覧取得、取得、作成、更新、削除	visitors.md
WebHook	webhooks	一覧取得、取得、作成、更新、削除	webhooks.md
Workspace	workspaces	一覧取得、取得、作成、更新、削除	workspaces.md

画像のアップロード

一部のエンティティには画像プロパティ（ロゴ、バナー、写真など）があります。画像を設定するには、2つのプロパティを指定する必要があります。

1. New{PropertyName}Url — Nexudus バックエンドが画像をダウンロードできる公開アクセス可能な URLです。ローカルファイルパスや認証が必要な URL は使用できません。
2. {PropertyName}FileName — 画像の保存に使用するファイル名（拡張子を含む）です。特殊文字は使用せず（英字、数字、ハイフン、アンダースコアのみ）、ファイル拡張子（例：.png、.jpg）を含めてください。

ユーザーがファイル名を指定しない場合は、URL からファイル名を導き出す（末尾のパス要素を使用し、クエリ文字列と特殊文字を取り除く）か、image.pngのような適切な既定名を生成してください。ファイル名に使用できる文字だけが含まれ、有効な画像拡張子が付いていることを必ず確認してください。

エンティティ	画像プロパティ	CLI URL オプション	API URL プロパティ	CLI ファイル名オプション	API ファイル名プロパティ
ビジネス	Logo	--logo-url	NewLogoUrl	--logo-file-name	LogoFileName
ビジネス	BannerImage	--banner-url	NewBannerImageUrl	--banner-file-name	BannerImageFileName
ビジネス	NexIoBannerImage	--nexio-banner-url	NewNexIoBannerImageUrl	--nexio-banner-file-name	NexIoBannerImageFileName
ビジネス	PassportBanner	--passport-banner-url	NewPassportBannerUrl	--passport-banner-file-name	PassportBannerFileName
リソース	Picture	--new-picture-url	NewPictureUrl	--picture-file-name	PictureFileName

例 — ビジネスにロゴを設定する場合：

nexudus businesses update <id> --logo-url "https://example.com/logo.png" --logo-file-name "logo.png" --agent

例 — リソースに写真を設定する場合：

nexudus resources update <id> --new-picture-url "https://example.com/room.jpg" --picture-file-name "room.jpg" --agent

例 — ユーザーが URL のみを指定する場合（エージェントがファイル名を導き出します）：

# User says: set the logo to https://cdn.example.com/images/my-logo.png
# Agent extracts "my-logo.png" from the URL path
nexudus businesses update <id> --logo-url "https://cdn.example.com/images/my-logo.png" --logo-file-name "my-logo.png" --agent

例 — URL から使用可能なファイル名を取得できない場合（エージェントが生成します）：

# User says: set the logo to https://cdn.example.com/generate?id=abc
# Agent cannot extract a file name, so it generates a safe default
nexudus businesses update <id> --logo-url "https://cdn.example.com/generate?id=abc" --logo-file-name "logo.png" --agent

Nexudus API のパターン

Nexudus API は一貫した REST パターンに従います。/api/{module}/{entities} の各エンティティは、次の操作をサポートします。

操作	HTTP	URL
検索	GET	/api/{module}/{entities}?page=1&size=25
1 件取得	GET	/api/{module}/{entities}/{id}
作成	POST	/api/{module}/{entities}
更新	PUT	/api/{module}/{entities}
削除	DELETE	/api/{module}/{entities}/{id}
コマンド	GET	/api/{module}/{entities}/commands
コマンドを実行	POST	/api/{module}/{entities}/runCommand

複数の値の指定（リストオプション）

一部のオプションは ID のリストを受け取ります（例：--tariffs、--teams、--linked-resources、--resource-types）。複数の値を渡すには、値ごとにフラグを繰り返し指定してください。

nexudus resources update <id> --tariffs 101 --tariffs 202 --tariffs 303 --agent

カンマ区切りの値や角括弧構文は使用しないでください。値ごとに個別のフラグが必要です。

--{list}、--added-{list}、--removed-{list} の使い分け

すべてのリストプロパティには、3 つのバリエーションがあります。目的に合ったものを使用してください。

バリエーション	使用する場面	効果
--{list}	デフォルトの選択肢です。 希望するリスト全体がわかっている場合。	指定した値でリスト全体を置き換えます。
--added-{list}	既存のリストのほかの部分を変更せずに、1 つ以上の項目を追加する場合。	指定した ID を既存のリストにマージします。
--removed-{list}	既存のリストのほかの部分を変更せずに、1 つ以上の項目を削除する場合。	指定した ID を既存のリストから削除します。

ほとんどの場合、--{list} を使用してください。 追加／削除のバリエーションが必要なのは、既存のほかの項目に影響を与えず、たとえばすでに複数の料金プランがあるリソースに新しい料金プランを 1 つだけ追加するなど、細かく段階的な変更を行う場合に限られます。

例 — リソースのすべての料金プランを置き換える：

nexudus resources update <id> --tariffs 101 --tariffs 202 --agent

例 — 既存の料金プランを変更せずに、1 つ追加する：

nexudus resources update <id> --added-tariffs 303 --agent

例 — 既存の料金プランを変更せずに、1 つ削除する：

nexudus resources update <id> --removed-tariffs 101 --agent

ヒント

• 多数のレコードをスキャンする必要がある場合は、--page-size 100 を使用して、より大きなページを取得します。
• 単一の ID で絞り込むには --id <id> を使用し、複数の ID で絞り込むには --id <id1> --id <id2> のように繰り返します。
• UniqueId（GUID）で絞り込むには --unique-id <guid> を使用します。複数指定することもできます。
• 効率的に検索するには、フィルターオプションとページネーションを組み合わせます。
• run-command は、バッチ操作用にカンマ区切りの ID を受け付けます：nexudus products run-command archive 123,456,789 --agent。
• ビジネスエンティティは API 経由で作成または削除できません。一覧表示、表示、更新のみ可能です。
• 非対話モードで実行するときは、削除コマンドに必ず --yes を指定してください。