機械翻訳について

移動先

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

パッケージの取得

get

/ic/api/integration/v1/packages

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

リクエスト

問合せパラメータ

• integrationInstance(required): string
  これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
• 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

ソースを表示

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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Packages",
            "items":{
                "$ref":"#/components/schemas/PackageRs"
            }
        },
        "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 PackageRs

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

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

型: object

ソースを表示

• barta-built-by: string
  BA (Business Accelerator) | R (レシピ) | TA (Technical Accelerator) builtBy
• barta-type: string
  タイプBA (Business Accelerator) | R (レシピ) | TA (Technical Accelerator)
• count-of-integrations: integer (int32)
  統合数
• integrations: array integrations
  統合リスト
• is-clone-allowed: boolean
  クローンの許可を確認するフラグ
• is-view-allowed: boolean
  表示可能かどうかをチェックするフラグ
• name: string
  パッケージ名
• type: string
  パッケージ・タイプ

{
    "type":"object",
    "properties":{
        "integrations":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/IntegrationBaseResource"
            }
        },
        "name":{
            "type":"string",
            "description":"Package Name"
        },
        "count-of-integrations":{
            "type":"integer",
            "description":"Number of Integrations",
            "format":"int32"
        },
        "type":{
            "type":"string",
            "description":"Package type"
        },
        "barta-built-by":{
            "type":"string",
            "description":"BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy"
        },
        "barta-type":{
            "type":"string",
            "description":"Accelerator type BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator)"
        },
        "is-view-allowed":{
            "type":"boolean",
            "description":"Flag to Check if View Allowed"
        },
        "is-clone-allowed":{
            "type":"boolean",
            "description":"Flag to Check if Clone Allowed"
        }
    }
}

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

型: array

統合リスト

ソースを表示

• Array of: IntegrationBaseResource

{
    "type":"array",
    "description":"Integration List",
    "items":{
        "$ref":"#/components/schemas/IntegrationBaseResource"
    }
}

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

すべてに一致

ソースを表示

• allOf IdResource
• object GenericRestResource
• object IntegrationBaseResource-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "status":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "code":{
                    "type":"string"
                },
                "dependencies":{
                    "$ref":"#/components/schemas/IntegrationDependencyRs"
                },
                "lockedFlag":{
                    "type":"boolean"
                },
                "style":{
                    "type":"string"
                },
                "styleDescription":{
                    "type":"string"
                },
                "pattern":{
                    "type":"string"
                },
                "patternDescription":{
                    "type":"string"
                },
                "scheduleApplicable":{
                    "type":"boolean"
                },
                "scheduleDefined":{
                    "type":"boolean"
                },
                "description":{
                    "type":"string"
                },
                "endPointURI":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "created":{
                    "type":"string",
                    "format":"date-time"
                },
                "lockedBy":{
                    "type":"string"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time"
                },
                "lastUpdatedBy":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "proxyWSDL":{
                    "type":"string"
                },
                "filmstrip":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FilmstripRs"
                    }
                },
                "keywords":{
                    "type":"string"
                },
                "docUrl":{
                    "type":"string"
                },
                "smartTags":{
                    "type":"string"
                },
                "apipId":{
                    "type":"string"
                },
                "warningMsg":{
                    "type":"string"
                },
                "publishFlag":{
                    "type":"boolean"
                },
                "tracingEnabledFlag":{
                    "type":"boolean"
                },
                "payloadTracingEnabledFlag":{
                    "type":"boolean"
                },
                "eventSubscriptionFlag":{
                    "type":"boolean"
                },
                "tempCopyExists":{
                    "type":"boolean"
                },
                "reactivationStatus":{
                    "type":"string"
                }
            }
        }
    ]
}

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

すべてに一致

ソースを表示

• object GenericRestResource
• object IdResource-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "projectId":{
                    "type":"string"
                },
                "projectName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• links: array links
• processing-time: number (float)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "processing-time":{
            "type":"number",
            "format":"float"
        }
    }
}

ネストされたスキーマ : IdResource-allOf[1]

型: object

ソースを表示

• id: string
• projectId: string
• projectName: string

{
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : IntegrationBaseResource-allOf[2]

型: object

ソースを表示

• apipId: string
• code: string
• created: string (date-time)
• createdBy: string
• dependencies: object IntegrationDependencyRs
• description: string
• docUrl: string
• endPointURI: string
• eventSubscriptionFlag: boolean
• filmstrip: array filmstrip
• keywords: string
• lastUpdated: string (date-time)
• lastUpdatedBy: string
• lockedBy: string
• lockedDate: string (date-time)
• lockedFlag: boolean
• name: string
• pattern: string
• patternDescription: string
• payloadTracingEnabledFlag: boolean
• proxyWSDL: string
• publishFlag: boolean
• reactivationStatus: string
• scheduleApplicable: boolean
• scheduleDefined: boolean
• smartTags: string
• status: string
• style: string
• styleDescription: string
• tempCopyExists: boolean
• tracingEnabledFlag: boolean
• version: string
• warningMsg: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "dependencies":{
            "$ref":"#/components/schemas/IntegrationDependencyRs"
        },
        "lockedFlag":{
            "type":"boolean"
        },
        "style":{
            "type":"string"
        },
        "styleDescription":{
            "type":"string"
        },
        "pattern":{
            "type":"string"
        },
        "patternDescription":{
            "type":"string"
        },
        "scheduleApplicable":{
            "type":"boolean"
        },
        "scheduleDefined":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "endPointURI":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "proxyWSDL":{
            "type":"string"
        },
        "filmstrip":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FilmstripRs"
            }
        },
        "keywords":{
            "type":"string"
        },
        "docUrl":{
            "type":"string"
        },
        "smartTags":{
            "type":"string"
        },
        "apipId":{
            "type":"string"
        },
        "warningMsg":{
            "type":"string"
        },
        "publishFlag":{
            "type":"boolean"
        },
        "tracingEnabledFlag":{
            "type":"boolean"
        },
        "payloadTracingEnabledFlag":{
            "type":"boolean"
        },
        "eventSubscriptionFlag":{
            "type":"boolean"
        },
        "tempCopyExists":{
            "type":"boolean"
        },
        "reactivationStatus":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link

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

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

型: object

ソースを表示

• href: string
• media-type: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

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

{
    "type":"object",
    "properties":{
        "connections":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
            }
        },
        "lookups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
            }
        },
        "libraries":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
            }
        },
        "certificates":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
            }
        }
    }
}

ネストされたスキーマ : フィルム・ストリップ

型: array

ソースを表示

• Array of: object FilmstripRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FilmstripRs"
    }
}

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

型: array

ソースを表示

• Array of: object IntegrationDependencyRs.CertificateDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
    }
}

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

型: array

ソースを表示

• Array of: object IntegrationDependencyRs.ConnectionDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
    }
}

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

型: array

ソースを表示

• Array of: object IntegrationDependencyRs.LibraryDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
    }
}

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

型: array

ソースを表示

• Array of: object IntegrationDependencyRs.LookupDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
    }
}

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

型: object

ソースを表示

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

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

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

型: object

ソースを表示

• display-name: string
• id(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name: string
• role: string
• status: string
• type: string
• usage: integer (int32)

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "display-name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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

型: object

ソースを表示

• code: string
• description: string
• display-name: string
• last-updated-date: string (date-time)
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• status: string
• usage: integer (int32)
• version: string

{
    "type":"object",
    "properties":{
        "display-name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "last-updated-date":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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

型: object

ソースを表示

• description(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name(required): string
• status(required): string
• usage(required): integer (int32)

{
    "required":[
        "description",
        "name",
        "status",
        "usage"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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

型: object

ソースを表示

• code(必須): string
• icon-url: string
• name(required): string
• role(required): string
• status: string

{
    "required":[
        "code",
        "name",
        "role"
    ],
    "type":"object",
    "properties":{
        "icon-url":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        }
    }
}

400レスポンス

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

500レスポンス

サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、パッケージの詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

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

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

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

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

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

limitおよびoffsetでページ区切りが行われます。 この例では、パッケージを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/packages?integrationInstance=service-instance

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

問合せパラメータを組み合せるには、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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/packages?integrationInstance=service-instance

先頭に戻る