機械翻訳について

移動先

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

パッケージの取得

get

/ic/api/integration/v1/packages

最終更新時間でソートされたすべてのパッケージに関する情報を取得します。

リクエスト

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

• application/json; charset=utf-8

問合せパラメータ

• limit: integer(int32)
  返される結果のページ区切りには、オフセット・パラメータを使用します。 この制限は、一度に返すアイテムの最大数です。 たとえば、offset=3&limit=16は、4番目のアイテムから始まるパッケージをリストすることを示し、リストには16個のアイテムが含まれます。
• offset: integer(int32)
  戻される結果のページ区切りには、制限パラメータを使用します。 オフセットは、レコードを返す開始ポイントです。 たとえば、offset=3&limit=16は、4番目のアイテムから始まるパッケージをリストすることを示し、リストには16個のアイテムが含まれます。
• q: string

  指定されたパラメータに基づいてフィルタされたパッケージのリストを返します。

  有効なパラメータ:

  • name: パッケージの名前。 完全一致または次をサポートします。 たとえば:
    • パッケージ名の完全一致であるパッケージを取得するには、次を指定します:

      q={name:'PackageName'}

      .
    • 指定した文字列がパッケージ名に含まれるすべてのパッケージを取得するには、次のように指定します:

      q={name: /pack/}

  • type: パッケージのタイプ。 有効な値: PREBUILT, DEVELOPED.

トップに戻る

レスポンス

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

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

200レスポンス

操作の成功

本文()

ルート・スキーマ : PackagesRs

型: object

ソースを表示

• hasMore: boolean
  デフォルト値: false
• items: array items
• limit: integer(int32)
• links: array links
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PackageRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

ソースを表示

• Array of: object package

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

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

型: array

ソースを表示

• Array of: object SuiteLink

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

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

型: object

ソースを表示

• bartaBuiltBy: string
• bartaType: string
• countOfIntegrations: integer(int32)
• id: string
• integrations: array integrations
• isCloneAllowed: boolean
  デフォルト値: false
• isViewAllowed: boolean
  デフォルト値: false
• links: array links
• name: string
• type: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "countOfIntegrations":{
            "type":"integer",
            "format":"int32"
        },
        "type":{
            "type":"string"
        },
        "integrations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntegrationBaseResource"
            }
        },
        "bartaBuiltBy":{
            "type":"string"
        },
        "bartaType":{
            "type":"string"
        },
        "isViewAllowed":{
            "type":"boolean",
            "default":false
        },
        "isCloneAllowed":{
            "type":"boolean",
            "default":false
        }
    },
    "xml":{
        "name":"package"
    }
}

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

型: array

ソースを表示

• Array of: object IntegrationBaseResource

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

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

型: array

ソースを表示

• Array of: object Link

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

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

型: object

ソースを表示

• code: string
• dependencies: object IntegrationDependencyRs
• id: string
• links: array links
• lockedFlag: boolean
  デフォルト値: false
• name: string
• pattern: string
• patternDescription: string
• scheduleApplicable: boolean
  デフォルト値: false
• scheduleDefined: boolean
  デフォルト値: false
• status: string
• style: string
• styleDescription: string
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "style":{
            "type":"string"
        },
        "styleDescription":{
            "type":"string"
        },
        "pattern":{
            "type":"string"
        },
        "patternDescription":{
            "type":"string"
        },
        "dependencies":{
            "$ref":"#/definitions/IntegrationDependencyRs"
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "scheduleApplicable":{
            "type":"boolean",
            "default":false
        },
        "scheduleDefined":{
            "type":"boolean",
            "default":false
        }
    }
}

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

型: object

ソースを表示

• certificates: array certificates
• connections: array connections
• integrations: array integrations
• libraries: array libraries
• lookups: array lookups

{
    "type":"object",
    "properties":{
        "connections":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionDependencyRs"
            }
        },
        "lookups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LookupDependencyRs"
            }
        },
        "libraries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LibraryDependencyRs"
            }
        },
        "certificates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CertificateDependencyRs"
            }
        },
        "integrations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LocalIntegrationDependencyRs"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link

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

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

型: array

ソースを表示

• Array of: object CertificateDependencyRs

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

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

型: array

ソースを表示

• Array of: object ConnectionDependencyRs

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

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

型: array

ソースを表示

• Array of: object LocalIntegrationDependencyRs

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

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

型: array

ソースを表示

• Array of: object LibraryDependencyRs

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

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

型: array

ソースを表示

• Array of: object LookupDependencyRs

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

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

型: object

ソースを表示

• id: string
• name: string
• status: string
• usage: integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• id: string
• name: string
• role: string
• status: string
• type: string
• usage: integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースを表示

• code: string
• version: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• code: string
• description: string
• displayName: string
• lastUpdatedDate: string(date-time)
• lockedFlag: boolean
  デフォルト値: false
• status: string
• usage: integer(int32)
• version: string

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        }
    }
}

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

型: object

ソースを表示

• description: string
• name: string
• status: string
• usage: integer(int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : 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リクエストを発行することによって、パッケージの詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: すべてのパッケージの取得

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

例: どのような場合でも、パッケージ名にmyPackを含むパッケージのみを取得

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myPack/}" https://integration.us.oraclecloud.com/ic/api/integration/v1/packages

例: 戻されるパッケージのページ番号付け

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/packages 

例: パラメータを組み合せて、文字列を含むパッケージを取得し、結果のページを区切ります

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

この例では、myPackを大文字または小文字で含み、タイプがDEVELOPEDのパッケージを取得しています。

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myPack/, type:'DEVELOPED'}" -d "offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/packages

先頭に戻る