機械翻訳について

移動先

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

プロジェクト内のライブラリの取得

get

/ic/api/integration/v1/projects/{projectId}/libraries

プロジェクト内のすべてのライブラリに関する情報を、最後に更新された時間順に取得します。

リクエスト

パス・パラメータ

• projectId(required): string
  プロジェクト識別子

問合せパラメータ

• integrationInstance(required): string
  これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
• limit: integer(int32)
  返される結果のページ区切りには、オフセット・パラメータを使用します。 この制限は、一度に返すアイテムの最大数です。 たとえば、offset=3&limit=16は、4アイテムから始まるライブラリをリストすることを示し、リストには16アイテムが含まれます。
• offset: integer(int32)
  戻される結果のページ区切りには、制限パラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 たとえば、offset=3&limit=16は、4アイテムから始まるライブラリをリストすることを示し、リストには16アイテムが含まれます。
• orderBy: string

  名前または最終更新時間でソートされたライブラリがリストされます。

  有効値:

  • name: ライブラリにライブラリ名を付けます。 例: orderBy=name.
  • time: ライブラリを最終更新時間で順序付けします。 例: orderBy=time.
• q: string
  ライブラリを名前およびタイプでフィルタします。

  有効なパラメータ:

  • name: ライブラリ名。 サポートには、次のみが含まれます。 たとえば:
    • 指定した文字列がライブラリ名に含まれるすべてのライブラリを取得するには、次のように指定します:

      q={name: /library/}

  • type: ライブラリのタイプ。 有効な値: preinstalled, private.

    たとえば、myLibraryという文字列が含まれ、ステータスが事前インストール済のすべてのライブラリを取得するには、次のように指定します:

    q={name : /myLibrary/, type : 'preinstalled'}

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

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

• application/json;charset=utf-8, application/vnd.oracle.model+json;type=collection

200レスポンス

操作の成功

本文()

ルート・スキーマ : LibraryRs

型: object

ソースを表示

• has-more: boolean
  レコードが他に存在するかどうかを確認するフラグ
• items: array items
  ライブラリのリスト
• limit: integer (int32)
  表示するレコードの制限
• total-results: integer (int32)
  結果合計

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Libraries",
            "items":{
                "$ref":"#/components/schemas/LibraryTypeRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of Records to be Displayed",
            "format":"int32"
        }
    }
}

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

型: array

ライブラリのリスト

ソースを表示

• Array of: object LibraryTypeRs

{
    "type":"array",
    "description":"List of Libraries",
    "items":{
        "$ref":"#/components/schemas/LibraryTypeRs"
    }
}

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

型: object

ソースを表示

• callout-type: string
  コールアウトのタイプ
• code: string
  ライブラリ・コード
• created-by: string
  ライブラリ作成者
• created-date: string (date-time)
  ライブラリ作成日
• description: string
  ライブラリ摘要
• display-name: string
  Library Name
• id: string
  ライブラリ識別子
• last-updated-by: string
  ライブラリ最終更新者
• last-updated-date: string (date-time)
  ライブラリ最終更新日
• library-type: string
  ライブラリ・タイプ
• locked-by: string
  ロック者
• locked-date: string (date-time)
  ロック日
• locked-flag: boolean
  ロック・フラグ
• project-id: string
• status: string
  ライブラリ・ステータス
• usage: integer (int32)
  ライブラリの使用方法
• version: string
  ライブラリ・バージョン

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Library Status"
        },
        "last-updated-date":{
            "type":"string",
            "description":"Library Last Updated Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Library Last Updated By"
        },
        "created-date":{
            "type":"string",
            "description":"Library Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Library Created By"
        },
        "library-type":{
            "type":"string",
            "description":"Library Type"
        },
        "callout-type":{
            "type":"string",
            "description":"Callout Type"
        },
        "id":{
            "type":"string",
            "description":"Library Identifier"
        },
        "code":{
            "type":"string",
            "description":"Library Code"
        },
        "display-name":{
            "type":"string",
            "description":"Library Name"
        },
        "version":{
            "type":"string",
            "description":"Library Version"
        },
        "description":{
            "type":"string",
            "description":"Library Description"
        },
        "usage":{
            "type":"integer",
            "description":"Library Usage",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "project-id":{
            "type":"string"
        }
    }
}

400レスポンス

パラメータの形式が正しくありません

500レスポンス

サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、プロジェクト内のAPIライブラリに関する詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: 名前にmyLibrary、MYLIBRARYまたはMYLIBRARYを含むJavaScriptライブラリのみを取得し、タイプを事前インストールしてください

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myLibrary/, type: 'preinstalled'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/libraries?integrationInstance=service-instance

例: 返されるライブラリのページ番号付け

ページ区切りは制限とオフセットで実行されます。 この例では、4番目のアイテムから始まるライブラリを一覧表示します。 リストには16アイテムが含まれます。

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/libraries?integrationInstance=service-instance

例: ライブラリ名のアルファベット順にライブラリを取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H
      "Accept:application/json" -d "orderBy=name"
      https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/libraries?integrationInstance=service-instance

例: パラメータを組み合せると、名前にテキストmyLibraryを含むライブラリが取得され、結果のページが区切られます

問合せパラメータを結合するには、qを--data-urlencodeオプションとともに使用します。 その他のパラメータは、 -dオプションの後に追加できます。

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json"
      --data-urlencode "q={name: /myLibrary/, type: 'private'}" -d
      "orderBy=name&offset=12&limit=5"
      https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/libraries?integrationInstance=service-instance

例: プロジェクトTEST_PROJECTの最終更新時間順に並べられたすべてのJavaScriptライブラリを取得

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json"
      https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/libraries?integrationInstance=service-instance

先頭に戻る