ジャンプ先

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

ORDSロールの更新

put

/ords/rest/roles/{id}

ORDSロールを更新します。

リクエスト

パス・パラメータ

• id(必須): integer
  特定のORDSロールのID。

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• id(必須): number
  更新する指定のIDのORDSロールを指定します。
• role_name(必須): string
  ORDSロール・モジュールの新しいrole_name。
• run_mode: string
  この値は「codePreview」で、エンドポイントはバックエンドが実行したコードで応答します。パラメータが指定されていない場合、エンドポイントは操作の実行結果で応答します。

{
    "type":"object",
    "required":[
        "id",
        "role_name"
    ],
    "properties":{
        "id":{
            "type":"number",
            "description":"Specify the ORDS role given the ID to update."
        },
        "role_name":{
            "type":"string",
            "description":"New role_name for the ORDS role module."
        },
        "run_mode":{
            "type":"string",
            "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution."
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

201レスポンス

正常に更新されたORDSロールの詳細。

本文 ()

ルート・スキーマ: ResourceItem

タイプ: object

使用可能なその他のプロパティ: true

ソースの表示

• links: array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

400 レスポンス

role_nameパラメータが指定されていません。

403レスポンス

このロールを更新する権限がありません。

404レスポンス

ロールが見つかりません。

先頭に戻る