Documentation

組織リストの API エンドポイント

このリソースに GET リクエストを実行して、組織リストを取得します。

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

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

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

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

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "type": "organization",
            "url": "/api/v1/organizations/1/",
            "related": {
                "created_by": "/api/v1/users/1/",
                "modified_by": "/api/v1/users/1/",
                "admins": "/api/v1/organizations/1/admins/",
                "users": "/api/v1/organizations/1/users/",
                "inventories": "/api/v1/organizations/1/inventories/",
                "activity_stream": "/api/v1/organizations/1/activity_stream/",
                "projects": "/api/v1/organizations/1/projects/",
                "teams": "/api/v1/organizations/1/teams/"
            },
            "summary_fields": {
                "created_by": {
                    "id": 1,
                    "username": "admin",
                    "first_name": "",
                    "last_name": ""
                },
                "modified_by": {
                    "id": 1,
                    "username": "admin",
                    "first_name": "",
                    "last_name": ""
                }
            },
            "created": "2015-08-25T01:00:18.545Z",
            "modified": "2015-08-25T01:00:18.545Z",
            "name": "Default",
            "description": ""
        }
    ]
}

結果

各組織のデータ構造には以下のフィールドが含まれます。

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

組織の作成

新規組織を作成するには、以下の組織フィールドを使ってリソースに POST リクエストを実行します。

  • name: (文字列。必須)
  • description: (文字列。デフォルトは "")

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

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

name Organization List
description # List Organizations: Make a GET request to this resource to retrieve the list of organizations.
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)
GET
id
type integer
label ID
help_text Database ID for this organization.
type
type multiple choice
help_text Data type for this organization.
choices
0
0 organization
1 Organization
url
type string
help_text URL for this organization.
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 organization was created.
modified
type datetime
help_text Timestamp when this organization was last modified.
name
type string
label name
description
type string
label description
types
0 organization
search_fields
0 description
1 name