機械翻訳について

ジャンプ先

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

統合インスタンスの取得

get

https://<servername>/api/boss/data/objects/ora/cxSalesCommon/integration/v1/integrationInstances/{integrationInstances_id}

リクエスト

パス・パラメータ

• integrationInstances_id(required): string
  このパス・パラメータは、統合インスタンスRESTリソースに定義されている次のフィールドにマップされます:
  

  1. integrationInstanceId: 統合インスタンスの一意の識別子。

問合せパラメータ

• $fields: string
  リソース・フィールドを制限します。 指定したフィールドおよび必須のシステム・フィールドのみが返されます。

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

トップに戻る

応答

デフォルトのレスポンス

単一品目のレスポンス

本文( )

ルート・スキーマ : integrationInstances_item-response

すべて一致

ソースを表示

• object 「統合インスタンス」
  タイトル: Integration Instance

  統合インスタンスには、Salesと他のOracle applications間で統合された特定のレコードの詳細(ルーチン識別子、ステータス、統合ペイロード、統合マップ識別子など)が格納されます。
• object __busObj_context
• object integrationInstances_item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstance_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        },
        {
            "type":"object",
            "properties":{
                "integrationDetails":{
                    "$ref":"#/components/schemas/integrationInstances-integrationDetails"
                }
            }
        }
    ]
}

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

タイプ: object

タイトル: Integration Instance

統合インスタンスには、Salesと他のOracle applications間で統合された特定のレコードの詳細(ルーチン識別子、ステータス、統合ペイロード、統合マップ識別子など)が格納されます。

ソースを表示

• activeFlag: boolean
  タイトル: Active Flag

  デフォルト値: true

  インテグレーション・インスタンスがアクティブかどうかを示します。
• createdBy: string
  タイトル: Created By

  読取り専用: true

  統合インスタンス・レコードを作成したユーザー。
• description: string
  タイトル: Integration Description

  統合インスタンスの説明。
• integrationInstanceId: string (big-integer)
  タイトル: Integration Instance Identifier

  統合インスタンスの一意の識別子。
• integrationInstanceNumber: string
  タイトル: Integration Instance Number

  統合インスタンスの公開一意識別子。
• integrationMap: integrationMap
• integrationPayload: string (long-text)
  タイトル: Integration Payload

  統合のペイロード。
• name: string
  タイトル: Integration Name

  統合インスタンスの名前。
• routineExecutionId: string (big-integer)
  タイトル: Routine Execution Identifier

  統合インスタンスを作成したルーチンの実行識別子。
• ステータス: ステータス
• timeCreated: string (date-time)
  タイトル: Time Created

  読取り専用: true

  統合インスタンスが作成された日時。
• timeUpdated: string (date-time)
  タイトル: Time Updated

  読取り専用: true

  統合インスタンス・レコードが更新された日時。
• updatedBy: string
  タイトル: Updated By

  読取り専用: true

  インテグレーション・インスタンス・レコードを更新したユーザー。

{
    "type":"object",
    "properties":{
        "integrationInstanceId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Instance Identifier",
            "description":"The unique identifier of the integration instance."
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "title":"Integration Name",
            "description":"The name of the integration instance."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "title":"Integration Description",
            "description":"The description of the integration instance."
        },
        "integrationInstanceNumber":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Instance Number",
            "description":"The public unique identifier of the integration instance."
        },
        "routineExecutionId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "title":"Routine Execution Identifier",
            "description":"The execution identifier of the routine that created the integration instance."
        },
        "activeFlag":{
            "type":"boolean",
            "default":true,
            "nullable":true,
            "title":"Active Flag",
            "description":"Indicates whether the integration instance is active."
        },
        "status":{
            "allOf":[
                {
                    "type":"string",
                    "default":"DRAFT",
                    "nullable":true,
                    "x-searchable":true,
                    "title":"Status",
                    "description":"The status of the integration instance."
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStatus_enum"
                }
            ]
        },
        "integrationPayload":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Integration Payload",
            "description":"The payload for the integration."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the integration instance record."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Time Created",
            "description":"The date and time when the integration instance was created."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The user who updated the integration instance record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Updated",
            "description":"The date and time when the integration instance record was updated."
        },
        "integrationMap":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    },
    "x-primaryKey":[
        "integrationInstanceId"
    ],
    "x-alternateKeys":{
        "altKey":[
            "integrationInstanceNumber"
        ]
    },
    "title":"Integration Instance",
    "x-hints":{
        "titlePlural":"Integration Instances"
    },
    "description":"An integration instance stores the details of a specific record integrated between Sales and other Oracle applications, such as Routine Identifier, Status, Integration Payload, and Integration Map Identifier."
}

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

タイプ: object

ソースを表示

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

• integrationDetails: integrationInstances-integrationDetails

{
    "type":"object",
    "properties":{
        "integrationDetails":{
            "$ref":"#/components/schemas/integrationInstances-integrationDetails"
        }
    }
}

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

すべて一致

ソースを表示

• object 「統合マップ」
  タイトル: Integration Map

  統合マップには、Salesのオブジェクトと他のOracle applicationsのオブジェクトとの間の属性マッピングが格納されます。 統合プロセスでは、マッピングを使用して、Salesから他のアプリケーションと同期する必要がある属性を決定します。
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

ネストされたスキーマ : ステータス

すべて一致

ソースを表示

• 文字列
  タイトル: Status

  デフォルト値: DRAFT

  統合インスタンスのステータス。
• 文字列
  許可された値: [ "DRAFT", "IN_PROGRESS", "COMPLETE", "ERROR", "RETRY" ]

{
    "allOf":[
        {
            "type":"string",
            "default":"DRAFT",
            "nullable":true,
            "x-searchable":true,
            "title":"Status",
            "description":"The status of the integration instance."
        },
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStatus_enum"
        }
    ]
}

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

タイプ: object

タイトル: Integration Map

統合マップには、Salesのオブジェクトと他のOracle applicationsのオブジェクトとの間の属性マッピングが格納されます。 統合プロセスでは、マッピングを使用して、Salesから他のアプリケーションと同期する必要がある属性を決定します。

ソースを表示

• activeFlag: boolean
  タイトル: Active Flag

  インテグレーション・マップがアクティブであることを示します。
• createdBy: string
  タイトル: Created By

  読取り専用: true

  統合マップ・レコードを作成したユーザー。
• description: string
  タイトル: Map Description

  統合マップの説明。
• integrationMapId: string (big-integer)
  タイトル: Integration Map Identifier

  統合マップの一意の識別子。
• integrationMapNumber: string
  タイトル: Integration Map Number

  統合マップの公開一意識別子。
• integrationSpec: string (long-text)
  タイトル: Map Transform Specification

  インテグレーション・マップの変換指定。
• lockedFlag: boolean
  タイトル: Locked Flag

  統合マップがロックされており、ユーザーが編集またはクローニングできないことを示します。
• name: string
  タイトル: Map Name

  統合マップの名前。
• seededFlag: boolean
  タイトル: Seeded Flag

  統合マップがOracleによってシードされたかどうかを示します。
• sourceApplication: string
  タイトル: Source Application

  読取り専用: true

  統合のソース・アプリケーション。
• sourceObject: string
  タイトル: Source Object

  統合のソース・オブジェクト。
• timeCreated: string (date-time)
  タイトル: Time Created

  読取り専用: true

  統合マップが作成された日時。
• timeUpdated: string (date-time)
  タイトル: Time Updated

  読取り専用: true

  インテグレーション・マップが最後に更新された日時。
• updatedBy: string
  タイトル: Updated By

  読取り専用: true

  統合マップ・レコードを最後に更新したユーザー。

{
    "type":"object",
    "properties":{
        "integrationMapId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Identifier",
            "description":"The unique identifier of the integration map."
        },
        "name":{
            "type":"string",
            "title":"Map Name",
            "description":"The name of the integration map."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "title":"Map Description",
            "description":"The description of the integration map."
        },
        "integrationMapNumber":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Number",
            "description":"The public unique identifier of the integration map."
        },
        "sourceApplication":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "title":"Source Application",
            "description":"The source application for the integration."
        },
        "sourceObject":{
            "type":"string",
            "x-searchable":true,
            "title":"Source Object",
            "description":"The source object of the integration."
        },
        "seededFlag":{
            "type":"boolean",
            "x-searchable":true,
            "title":"Seeded Flag",
            "description":"Indicates whether the integration map was seeded by Oracle."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Time Created",
            "description":"The date and time when the integration map was created."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the integration map record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Updated",
            "description":"The date and time when the integration map was last updated."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The user who last updated the integration map record."
        },
        "integrationSpec":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Map Transform Specification",
            "description":"The transform specifications for the integration map."
        },
        "activeFlag":{
            "type":"boolean",
            "title":"Active Flag",
            "description":"Indicates that the integration map is active."
        },
        "lockedFlag":{
            "type":"boolean",
            "title":"Locked Flag",
            "description":"Indicates that the integration map is locked and can't be edited or cloned by a user."
        }
    },
    "x-primaryKey":[
        "integrationMapId"
    ],
    "x-alternateKeys":{
        "altKey":[
            "integrationMapNumber"
        ]
    },
    "title":"Integration Map",
    "x-hints":{
        "titlePlural":"Integration Maps"
    },
    "description":"An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application."
}

ネストされたスキーマ : $context

タイプ: object

ソースを表示

• etag: string
• links: object links
  読取り専用: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: object

読取り専用: true

ソースを表示

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

ネストされたスキーマ : $self

タイプ: object

ソースを表示

• href: string

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

ネストされたスキーマ : integrationInstances-integrationDetails

すべて一致

ソースを表示

• object __collection_context
• object integrationInstances-integrationDetails-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_context"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/integrationInstances-integrationDetails_item-response"
                    }
                }
            }
        }
    ]
}

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

タイプ: object

ソースを表示

• hasMore: boolean

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        }
    }
}

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

タイプ: object

ソースを表示

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/integrationInstances-integrationDetails_item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

ソースを表示

• Array of: integrationInstances-integrationDetails_item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/integrationInstances-integrationDetails_item-response"
    }
}

ネストされたスキーマ : integrationInstances-integrationDetails_item-response

すべて一致

ソースを表示

• object 「インスタンス詳細」
  タイトル: Instance Detail

  インテグレーション・インスタンスの詳細には、インテグレーション・インスタンスのさまざまなステージとそのステータスが保存されます。
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstanceDetail_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

ネストされたスキーマ : インスタンス詳細

タイプ: object

タイトル: Instance Detail

インテグレーション・インスタンスの詳細には、インテグレーション・インスタンスのさまざまなステージとそのステータスが保存されます。

ソースを表示

• childIntegrationDetails: childIntegrationDetails
• createdBy: string
  タイトル: Created By

  読取り専用: true

  統合インスタンス詳細レコードを作成したユーザー。
• inboundPayload: string (long-text)
  タイトル: Inbound Payload

  インテグレーション・インスタンス詳細のインバウンド・ペイロード。
• instanceDetailId: string (big-integer)
  タイトル: Request Detail Identifier

  統合インスタンス内の詳細レコードの一意の識別子。
• 統合: 統合
• integrationInstanceId: string (big-integer)
  タイトル: Integration Instance Identifier

  統合インスタンスの一意の識別子。
• integrationLevel: integer (int32)
  タイトル: Integration Level

  統合インスタンス詳細のレベル。 これは、サブステップとの統合に適用されます。
• outboundPayload: string (long-text)
  タイトル: Outbound Payload

  統合インスタンス詳細のアウトバウンド・ペイロード。
• ステージ: 演壇
• ステータス: ステータス
• step: string
  タイトル: Substep

  サブステップの名前。
• timeCreated: string (date-time)
  タイトル: Time Created

  読取り専用: true

  統合インスタンス詳細レコードの作成日時。
• timeUpdated: string (date-time)
  タイトル: Time Updated

  読取り専用: true

  統合インスタンス詳細レコードが更新された日時。
• updatedBy: string
  タイトル: Updated By

  読取り専用: true

  インテグレーション・インスタンス詳細レコードを最後に更新したユーザー。

{
    "type":"object",
    "properties":{
        "instanceDetailId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Request Detail Identifier",
            "description":"The unique identifier of the detail record within an integration instance."
        },
        "integrationInstanceId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Instance Identifier",
            "description":"The unique identifier of the integration instance."
        },
        "stage":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "x-searchable":true,
                    "x-sortable":true,
                    "title":"Stage",
                    "description":"The stage of the integration instance detail."
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStages_enum"
                }
            ]
        },
        "status":{
            "allOf":[
                {
                    "type":"string",
                    "nullable":true,
                    "title":"Status",
                    "description":"The status of the integration instance detail."
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStatus_enum"
                }
            ]
        },
        "step":{
            "type":"string",
            "nullable":true,
            "title":"Substep",
            "description":"The name of the substep."
        },
        "integrationLevel":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "title":"Integration Level",
            "description":"The level of the integration instance detail. This applies to integrations with substeps."
        },
        "inboundPayload":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Inbound Payload",
            "description":"The inbound payload for the integration instance detail."
        },
        "outboundPayload":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Outbound Payload",
            "description":"The outbound payload for the integration instance detail."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the integration instance detail record."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Created",
            "description":"The date and time of the creation of the integration instance detail record."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The user who last updated the integration instance detail record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Time Updated",
            "description":"The date and time when the integration instance detail record was updated."
        },
        "integration":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstance_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        },
        "childIntegrationDetails":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstanceDetail_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    },
    "x-primaryKey":[
        "instanceDetailId"
    ],
    "title":"Instance Detail",
    "x-hints":{
        "titlePlural":"Instance Details"
    },
    "description":"An integration instance details stores the various stages of an integration instance and their statuses."
}

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

すべて一致

ソースを表示

• object 「インスタンス詳細」
  タイトル: Instance Detail

  インテグレーション・インスタンスの詳細には、インテグレーション・インスタンスのさまざまなステージとそのステータスが保存されます。
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstanceDetail_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

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

すべて一致

ソースを表示

• object 「統合インスタンス」
  タイトル: Integration Instance

  統合インスタンスには、Salesと他のOracle applications間で統合された特定のレコードの詳細(ルーチン識別子、ステータス、統合ペイロード、統合マップ識別子など)が格納されます。
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstance_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

ネストされたスキーマ : 演壇

すべて一致

ソースを表示

• 文字列
  タイトル: Stage

  統合インスタンス詳細のステージ。
• 文字列
  許可された値: [ "ENRICH", "TRANSFORM", "ACTIVATE", "BEFORE_HANDLER", "AFTER_HANDLER" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "x-searchable":true,
            "x-sortable":true,
            "title":"Stage",
            "description":"The stage of the integration instance detail."
        },
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStages_enum"
        }
    ]
}

ネストされたスキーマ : ステータス

すべて一致

ソースを表示

• 文字列
  タイトル: Status

  インテグレーション・インスタンス詳細のステータス。
• 文字列
  許可された値: [ "DRAFT", "IN_PROGRESS", "COMPLETE", "ERROR", "RETRY" ]

{
    "allOf":[
        {
            "type":"string",
            "nullable":true,
            "title":"Status",
            "description":"The status of the integration instance detail."
        },
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStatus_enum"
        }
    ]
}

リンク

$self

パラメータ:

• integrationInstances_id: $request.path.integrationInstances_id

integrationMap

パラメータ:

• integrationMaps_id: $response.body#/integrationMap/$id

「トップに戻る」