移動先

• リクエスト
• レスポンス

組織の更新

put

/api/v2/organizations/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、この組織を更新します。次のフィールドを変更できます。

• name: この組織の名前。(文字列、必須)
• description: この組織のオプションの説明。(文字列、デフォルト="")

• max_hosts: この組織が管理できるホストの最大数。(整数、デフォルト=0)

• default_environment: この組織によって実行されるジョブのデフォルトの実行環境。(id、デフォルト=``)

PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : Organization

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• custom_virtualenv: 文字列
  タイトル: Custom virtualenv

  読取り専用: true

  最小長: 1

  使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス
• default_environment: 整数
  タイトル: Default environment

  この組織によって実行されるジョブのデフォルトの実行環境。
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• max_hosts: 整数
  タイトル: Max hosts

  最小値: 0

  この組織が管理できるホストの最大数。
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• related: 文字列
  タイトル: Related

  読取り専用: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "default_environment":{
            "description":"The default execution environment for jobs run by this organization.",
            "title":"Default environment",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "max_hosts":{
            "description":"Maximum number of hosts allowed to be managed by this organization.",
            "minimum":"0",
            "title":"Max hosts",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

本文()

ルート・スキーマ : Organization

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• custom_virtualenv: 文字列
  タイトル: Custom virtualenv

  読取り専用: true

  最小長: 1

  使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス
• default_environment: 整数
  タイトル: Default environment

  この組織によって実行されるジョブのデフォルトの実行環境。
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• max_hosts: 整数
  タイトル: Max hosts

  最小値: 0

  この組織が管理できるホストの最大数。
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• related: 文字列
  タイトル: Related

  読取り専用: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "default_environment":{
            "description":"The default execution environment for jobs run by this organization.",
            "title":"Default environment",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "max_hosts":{
            "description":"Maximum number of hosts allowed to be managed by this organization.",
            "minimum":"0",
            "title":"Max hosts",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る