ジャンプ先

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

RESTモジュール・テンプレートの更新

put

/ords/rest/templates/{id}

RESTモジュール・テンプレートを更新します。

リクエスト

パス・パラメータ

• id(必須): integer
  特定のテンプレートのID。

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

• application/json

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

ルート・スキーマ: schema

タイプ: object

ソースの表示

• comments: string
  コメント・テキスト。
• etag_query: string
  エンティティ・タグの生成に使用される問合せです。
• etag_type(必須): string
  リソース・テンプレートによって使用されるエンティティ・タグのタイプです。エンティティ・タグとは、リソースのバージョン識別子として動作するHTTPヘッダーです。エンティティ・タグを使用して、以前取得したリソースの取得を避け、リソースを更新する際にコミット時のロックを実行します。有効な値は、HASH、QUERY、NONEです。
• priority(必須): integer
  リソース・テンプレートを評価する優先順位: 0 (低優先度。デフォルト)から9 (高優先度)です。
• uri_prefix(必須): string
  リソース・テンプレートの一致パターンです。たとえば、/objects/:object/:id?のパターンは/objects/emp/101と一致し(101のidでempリソースにあるアイテムのリクエストと一致)、/objects/emp/とも一致します。(:idパラメータには?修飾子の注釈が付き、これはidパラメータがオプションであることを示すため、empリソースのリクエストとも一致します。)

{
    "type":"object",
    "required":[
        "uri_prefix",
        "priority",
        "etag_type"
    ],
    "properties":{
        "uri_prefix":{
            "type":"string",
            "description":"A matching pattern for the resource template. For example, a pattern of /objects/:object/:id? will match /objects/emp/101 (matches a request for the item in the emp resource with id of 101) and will also match /objects/emp/. (Matches a request for the emp resource, because the :id parameter is annotated with the ? modifier, which indicates that the id parameter is optional.)"
        },
        "priority":{
            "type":"integer",
            "description":"The priority for the order of how the resource template should be evaluated: 0 (low priority. the default) through 9 (high priority)."
        },
        "etag_type":{
            "type":"string",
            "description":"A type of entity tag to be used by the resource template. An entity tag is an HTTP Header that acts as a version identifier for a resource. Use entity tag headers to avoid retrieving previously retrieved resources and to perform optimistic locking when updating resources. Valid values are HASH, QUERY, NONE."
        },
        "etag_query":{
            "type":"string",
            "description":"Query that is used to generate the entity tag."
        },
        "comments":{
            "type":"string",
            "description":"Comment text."
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

正常に作成されたRESTモジュール・テンプレートの詳細。

本文 ()

ルート・スキーマ: 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 レスポンス

etag_type、パターンまたは優先度パラメータが指定されていません。

404レスポンス

テンプレートが存在しません

409レスポンス

テンプレート・パターンはすでにモジュールに存在します。

先頭に戻る