機械翻訳について

移動先

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

プロジェクト内のデプロイメントの取得

get

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

プロジェクト内のすべてのデプロイメントに関する情報を取得します。

リクエスト

パス・パラメータ

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

問合せパラメータ

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

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

トップに戻る

レスポンス

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

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

200レスポンス

操作の成功

本文()

ルート・スキーマ : LabelsRs

型: object

ソースを表示

• items: array items
  デプロイメントのリスト

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Deployments",
            "items":{
                "$ref":"#/components/schemas/LabelRs"
            }
        }
    }
}

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

型: array

デプロイメントのリスト

ソースを表示

• Array of: object LabelRs

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

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

型: object

ソースを表示

• b2btradingpartners: array b2btradingpartners
  B2BTradingPartnerリスト
• code(必須): string
  デプロイメント識別子
• decisions: array decisions
  ディシジョン・リスト
• description: string
  デプロイメント詳細記述
• integrations: array integrations
  統合リスト
• lastUpdated: string (date-time)
  最終更新日
• name(required): string
  デプロイメント名
• robots: array robots
  ロボット・リスト

{
    "required":[
        "name",
        "code"
    ],
    "type":"object",
    "properties":{
        "name":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Name"
        },
        "code":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Identifier"
        },
        "description":{
            "type":"string",
            "description":"Deployment Description"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "integrations":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        },
        "robots":{
            "type":"array",
            "description":"Robot List",
            "items":{
                "$ref":"#/components/schemas/RPADeploymentFlow"
            }
        },
        "decisions":{
            "type":"array",
            "description":"Decision List",
            "items":{
                "$ref":"#/components/schemas/DecisionDeploymentFlow"
            }
        },
        "b2btradingpartners":{
            "type":"array",
            "description":"B2BTradingPartner List",
            "items":{
                "$ref":"#/components/schemas/TradingPartner"
            }
        }
    }
}

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

型: array

B2BTradingPartnerリスト

ソースを表示

• Array of: object TradingPartner

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

ネストされたスキーマ : ディシジョン

型: array

ディシジョン・リスト

ソースを表示

• Array of: object DecisionDeploymentFlow

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

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

型: array

統合リスト

ソースを表示

• Array of: object Integration

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

ネストされたスキーマ : ロボット

型: array

ロボット・リスト

ソースを表示

• Array of: object RPADeploymentFlow

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

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

型: object

ソースを表示

• code: string
  TradingPartnerコード
• inboundAgrs: array inboundAgrs
  TradingPartner inboundAgrsリスト
• name: string
  TradingPartner名前
• outboundAgrs: array outboundAgrs
  TradingPartner outboundAgrsリスト
• status: string
  TradingPartnerステータス
• transports: array transports
  TradingPartnerトランスポート・リスト
• type: string
  TradingPartnerタイプ
• version: string
  デフォルト値: 01.00.0000

  TradingPartnerバージョン

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"TradingPartner Code"
        },
        "name":{
            "type":"string",
            "description":"TradingPartner Name"
        },
        "version":{
            "type":"string",
            "description":"TradingPartner Version",
            "default":"01.00.0000"
        },
        "type":{
            "type":"string",
            "description":"TradingPartner Type"
        },
        "status":{
            "type":"string",
            "description":"TradingPartner Status"
        },
        "transports":{
            "type":"array",
            "description":"TradingPartner Transports List",
            "items":{
                "type":"string"
            }
        },
        "inboundAgrs":{
            "type":"array",
            "description":"TradingPartner inboundAgrs List",
            "items":{
                "type":"string"
            }
        },
        "outboundAgrs":{
            "type":"array",
            "description":"TradingPartner outboundAgrs List",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

TradingPartner inboundAgrsリスト

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"TradingPartner inboundAgrs List",
    "items":{
        "type":"string"
    }
}

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

型: array

TradingPartner outboundAgrsリスト

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"TradingPartner outboundAgrs List",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : トランスポート

型: array

TradingPartnerトランスポート・リスト

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"TradingPartner Transports List",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• displayName: string
  決定名
• identifier: string
  ディシジョン識別子
• status: string
  決定ステータス
• version: string
  ディシジョン・バージョン

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"string",
            "description":"Decision Identifier"
        },
        "version":{
            "type":"string",
            "description":"Decision Version"
        },
        "displayName":{
            "type":"string",
            "description":"Decision Name"
        },
        "status":{
            "type":"string",
            "description":"Decision Status"
        }
    }
}

ネストされたスキーマ : 統合

型: object

ソースを表示

• code: string
  統合コード
• name: string
  統合名
• status: string
  統合ステータス
• type: string
  統合タイプ
• version: string
  統合バージョン

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Integration Code"
        },
        "version":{
            "type":"string",
            "description":"Integration Version"
        },
        "name":{
            "type":"string",
            "description":"Integration Name"
        },
        "status":{
            "type":"string",
            "description":"Integration Status"
        },
        "type":{
            "type":"string",
            "description":"Integration Type"
        }
    }
}

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

型: object

ソースを表示

• displayName: string
  ロボット名
• identifier: string
  ロボット識別子
• lifecycleState: string
  ロボットのLifecycle State
• version: string
  ロボット・バージョン

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"string",
            "description":"Robot Identifier"
        },
        "version":{
            "type":"string",
            "description":"Robot Version"
        },
        "displayName":{
            "type":"string",
            "description":"Robot Name"
        },
        "lifecycleState":{
            "type":"string",
            "description":"Robot Lifecycle State"
        }
    }
}

400レスポンス

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

500レスポンス

サーバー・エラー

トップに戻る

例

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

例: プロジェクトTEST_PROJECT内の返されたデプロイメントのページ区切り

ページ区切りは制限とオフセットで実行されます。 この例では、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/deployments?integrationInstance=service-instance

例: プロジェクトTEST_PROJECT内のすべてのデプロイメントを取得

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/deployments?integrationInstance=service-instance

先頭に戻る