ジャンプ先

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

特定のAPEXアプリケーションの取得またはエクスポート

get

/ords/_/db-api/stable/apex/applications/{application_id}

このサービスは、指定されたAPEXアプリケーションの表現を返します。表現データは、APEXアプリケーションに関するAPEX_APPLICATIONSビューのメタデータ、またはAPEX GET_APPLICATION.EXPORTデータベース・プロシージャを使用したアプリケーション全体のエクスポートになります。詳細は、APEXのドキュメントを参照してください。クライアントには、SQL開発者ロールまたはSQL管理者ロールが必要です。

リクエスト

パス・パラメータ

• application_id: string
  アプリケーションの主キーで、すべてのワークスペースにわたり一意です。

問合せパラメータ

• export_format: string
  アプリケーション・コンポーネント全体を返すファイル形式を示します。有効な値 SQL_SCRIPT | SQL_ZIP

  指定できる値: [ "SQL_SCRIPT", "SQL_ZIP" ]
• export_type: string
  APEXエクスポート機能のパラメータ。APPLICATION_SOURCE、EMBEDDED_CODE、CHECKSUM-SH1を実行するエクスポート・タイプのカンマ区切りリスト
• p_with_pkg_app_mapping: boolean
  trueの場合、インストール済のパッケージ・アプリケーションをパッケージ・アプリケーション定義への参照とともにエクスポートします。falseの場合、通常のアプリケーションとしてエクスポートします。
• with_acl_assignments: boolean
  APEXエクスポート機能のパラメータ。trueの場合、ACLユーザー・ロール割当てをエクスポートします。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_comments: boolean
  APEXエクスポート機能のパラメータ。trueの場合、開発者コメントを含めます。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_date: boolean
  APEXエクスポート機能のパラメータ。trueの場合、結果にエクスポートの日時を含めます。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_ir_notifications: boolean
  APEXエクスポート機能のパラメータ。trueの場合、レポート通知を含めます。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_ir_private_reports: boolean
  APEXエクスポート機能のパラメータ。trueの場合、ユーザーが保存したプライベート・レポートを含めます。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_ir_public_reports: boolean
  APEXエクスポート機能のパラメータ。trueの場合、ユーザーが保存したパブリック・レポートを含めます。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_no_subscriptions: boolean
  APEXエクスポート機能のパラメータ。trueの場合、コンポーネントにはサブスクリプション参照が含まれています。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_original_ids: boolean
  APEXエクスポート機能のパラメータ。trueの場合、アプリケーションをインポートしたときのIDのままでエクスポートします。export_format問合せパラメータも指定されている場合にのみ有効です。
• with_supporting_objects: string
  APEXエクスポート機能のパラメータ。Yの場合、サポートされているオブジェクトをエクスポートします。Iの場合、インポート時に自動的にインストールします。Nの場合、サポートされているオブジェクトをエクスポートしません。nullの場合、アプリケーションの「エクスポートに含める」デプロイ値が使用されます。export_format問合せパラメータも指定されている場合にのみ有効です。

  指定できる値: [ "Y", "I", "N" ]
• with_translations: boolean
  APEXエクスポート機能のパラメータ。trueの場合、アプリケーション翻訳のマッピングおよび翻訳リポジトリのすべてのテキストを含めます。export_format問合せパラメータも指定されている場合にのみ有効です。

先頭に戻る

レスポンス

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

• application/json
• application/sql
• application/zip

200 レスポンス

指定されたOracle APEXアプリケーション。

本文 ()

ルート・スキーマ : APEXApplicationsItem

タイプ: object

このオブジェクトは、APEX_APPLICATIONSの1行を表します。

ソースの表示

• application_alias(optional): string
  代替の英数字アプリケーション識別子。
• application_group(optional): string
  代替の英数字アプリケーション識別子。
• application_id(optional): integer
  アプリケーションの主キーで、すべてのワークスペースにわたり一意です。
• application_name(optional): string
  このアプリケーションの名前。
• application_owner(optional): string
  代替の英数字アプリケーション識別子。
• availability_status(optional): string
  アプリケーションが使用可能または使用不可であることを指定します。
• last_updated_by(optional): string
  最終更新者。
• last_updated_on(optional): string
  最終更新日時。
• links(optional): array links
• page_count(optional): integer
  アプリケーション・ページの数。
• workspace(optional): string
  ワークスペースの内部名。

{
    "type":"object",
    "description":"This object represents a single row on APEX_APPLICATIONS.",
    "properties":{
        "application_id":{
            "type":"integer",
            "description":"Application Primary Key, Unique over all workspaces."
        },
        "application_name":{
            "type":"string",
            "description":"The name of this application."
        },
        "application_alias":{
            "type":"string",
            "description":"The alternate alphanumeric application identifier."
        },
        "application_group":{
            "type":"string",
            "description":"The alternate alphanumeric application identifier."
        },
        "application_owner":{
            "type":"string",
            "description":"The alternate alphanumeric application identifier."
        },
        "page_count":{
            "type":"integer",
            "description":"Number of application pages."
        },
        "workspace":{
            "type":"string",
            "description":"The internal name of the workspace."
        },
        "availability_status":{
            "type":"string",
            "description":"Specifies whether or not the application is available or unavailable for use."
        },
        "last_updated_by":{
            "type":"string",
            "description":"Last updated by."
        },
        "last_updated_on":{
            "type":"string",
            "description":"The date and time of the last update."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

ソースの表示

• href: string
• rel: string

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

400 レスポンス

不正なリクエスト - export_formatを指定せずに指定されたエクスポート関連の問合せパラメータ。

先頭に戻る