REST API for Oracle Integration

機械翻訳について

ライブラリの取得

get

/ic/api/integration/v1/libraries

最終更新時間でソートされたすべてのライブラリに関する情報を取得します。

リクエスト

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

application/json; charset=utf-8

問合せパラメータ

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.resource+json;type=collection

200レスポンス

操作の成功

ルート・スキーマ : library

型: object

ソースを表示

hasMore: boolean

デフォルト値: false
id: string
items: array items
limit: integer(int32)
links: array links
totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LibraryTypeRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"library"
    }
}

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

型: array

ソースを表示

Array of: object library

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

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

型: array

ソースを表示

Array of: object SuiteLink

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

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

型: object

ソースを表示

calloutType: string
code: string
createdBy: string
createdDate: string(date-time)
description: string
displayName: string
id: string
lastUpdatedBy: string
lastUpdatedDate: string(date-time)
libraryType: string
links: array links
lockedBy: string
lockedDate: string(date-time)
lockedFlag: boolean

デフォルト値: false
status: string
usage: integer(int32)
version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "displayName":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "libraryType":{
            "type":"string"
        },
        "calloutType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        }
    },
    "xml":{
        "name":"library"
    }
}

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

型: array

ソースを表示

Array of: object SuiteLink

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

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

型: object

ソースを表示

href: string
mediaType: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "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://integration.us.oraclecloud.com/ic/api/integration/v1/libraries

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

limitおよびoffsetでページ区切りが行われます。この例では、4番目のアイテムから始まるライブラリを一覧表示します。リストには16アイテムが含まれます。

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries

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

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=name" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries

例: パラメータを組み合せると、名前にテキスト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://integration.us.oraclecloud.com/ic/api/integration/v1/libraries

例: 最終更新時間でソートされたすべてのJavaScriptライブラリを取得

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries

先頭に戻る