Documentation

インベントリースクリプトリストの API エンドポイント

このリソースに GET リクエストを実行して、カスタムのインベントリースクリプトのリストを取得します。

GET /api/v1/inventory_scripts/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
X-API-Time: 0.049s

返されるデータ構造には以下のものが含まれます。

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}

count フィールドはクエリーで見つかったインベントリーの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results にはインベントリースクリプトのレコードが一覧表示されますが、ゼロの場合もあります。

結果

各カスタムインベントリースクリプトのデータ構造には以下のフィールドが含まれます。

  • id: カスタムインベントリースクリプトのデータベース ID (整数)
  • type: カスタムインベントリースクリプトのデータタイプ (複数選択)
    • custom_inventory_script: カスタムインベントリースクリプト
  • url: カスタムインベントリースクリプトの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
  • created: カスタムインベントリースクリプト作成時のタイムスタンプ (日時)
  • modified: カスタムインベントリースクリプトの最終更新時のタイムスタンプ (日時)
  • name: (文字列)
  • description: (文字列)
  • script: インベントリースクリプトのコンテンツ (文字列)
  • organization: (フィールド)

カスタムインベントリースクリプトの作成

新規カスタムインベントリースクリプトを作成するには、以下のカスタムインベントリースクリプトのフィールドを使ってリソースに POST リクエストを実行します。

  • name: (文字列。必須)
  • description: (文字列。デフォルトは "")
  • script: インベントリースクリプトのコンテンツ (文字列。デフォルトは "")
  • organization: (フィールド。必須)

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

name Inventory Script List
description # List Custom Inventory Scripts: Make a GET request to this resource to retrieve the list of custom inventory scripts.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.2
actions
POST
name
type string
required
true
label name
max_length 512
description
type string
required
false
label description
default (Empty Text)
script
type string
required
false
label script
help_text Inventory script contents
default (Empty Text)
organization
type field
required
true
GET
id
type integer
label ID
help_text Database ID for this custom inventory script.
type
type multiple choice
help_text Data type for this custom inventory script.
choices
0
0 custom_inventory_script
1 Custom Inventory Script
url
type string
help_text URL for this custom inventory script.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
created
type datetime
help_text Timestamp when this custom inventory script was created.
modified
type datetime
help_text Timestamp when this custom inventory script was last modified.
name
type string
label name
description
type string
label description
script
type string
label script
help_text Inventory script contents
organization
type field
types
0 custom_inventory_script
search_fields
0 description
1 name