ジャンプ先

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

RESTモジュールの作成

POST

/ords/rest/modules/

RESTモジュールを作成します。

リクエスト

この操作のリクエスト・パラメータはありません。

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

• application/json

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

ルート・スキーマ: schema

タイプ: object

ソースの表示

• base_path(必須): string
  このRESTfulサービスにアクセスする場合に使用されるURIのベースです。例: hr/は、hr/で始まるすべてのURIがこのリソース・モジュールで処理されることを意味します。
• comments: string
  コメント・テキスト。
• items_per_page: integer
  リソース・ハンドラHTTP操作GETメソッドのデフォルトのページ区切り、つまり、データベース問合せに基づくJSON書式結果セットのページごとに戻される行の数です。デフォルト: 25。
• module_status: string
  公開ステータスです。有効な値: PUBLISHED (デフォルト)またはNOT_PUBLISHED。
• name(required): string
  所有RESTfulサービス・モジュールの名前です。大/小文字が区別されます。
• origins_allowed: string
  Webサービス・コールを含むモジュールに許可される起点を設定します。
• run_mode: string
  この値は「codePreview」で、エンドポイントはバックエンドが実行したコードで応答します。パラメータが指定されていない場合、エンドポイントは操作の実行結果で応答します。

{
    "type":"object",
    "required":[
        "name",
        "base_path"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the owning RESTful service module. Case sensitive."
        },
        "base_path":{
            "type":"string",
            "description":"The base of the URI that is used to access this RESTful service. Example: hr/ means that all URIs starting with hr/ will be serviced by this resource module."
        },
        "origins_allowed":{
            "type":"string",
            "description":"Set the allowed origins for the module containing the web service call."
        },
        "items_per_page":{
            "type":"integer",
            "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: 25."
        },
        "module_status":{
            "type":"string",
            "description":"Publication status. Valid values: PUBLISHED (default) or NOT_PUBLISHED."
        },
        "comments":{
            "type":"string",
            "description":"Comment text."
        },
        "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

200 レスポンス

作成するRESTモジュールのソース・コード。showcodeに使用されます。

本文 ()

ルート・スキーマ: 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"
    ]
}

201レスポンス

正常に作成された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"
    ]
}

404レスポンス

名前またはbase_pathパラメータが指定されていません。

409レスポンス

その名前またはベース・パスのモジュールはすでに存在します。

先頭に戻る