機械翻訳について

ジャンプ先

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

拡張問合せすべての統合マップ

post

https://<servername>/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/$query

リクエスト

この操作にはリクエスト・パラメータがありません。

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

• application/json

リクエスト本文 - application/json ()

ルート・リソース・コレクションに対するPOSTリクエストに対する問合せ

ルート・スキーマ : スキーマ

すべて一致

ソースを表示

• allOf 「スキーマ」
• object 「タイプで打つ」

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__collection_query"
        },
        {
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"object",
                    "description":"Values to be applied in a parameterized filter specific to the view."
                }
            }
        }
    ]
}

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

すべて一致

ソースを表示

• object 「スキーマ」
• object 「タイプで打つ」

{
    "allOf":[
        {
            "$ref":"#/components/schemas/__item_query"
        },
        {
            "type":"object",
            "properties":{
                "collection":{
                    "type":"object",
                    "description":"Defines query criteria that can be applied on a resource collection.",
                    "properties":{
                        "filter":{
                            "type":"string",
                            "description":"The resource collection will be queried using the specified filter condition."
                        },
                        "limit":{
                            "type":"integer",
                            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                        },
                        "offset":{
                            "type":"integer",
                            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                        },
                        "sortBy":{
                            "type":"array",
                            "description":"Orders a resource collection based on the specified fields.",
                            "items":{
                                "oneOf":[
                                    {
                                        "type":"string",
                                        "description":"Name of field based on which sorting will happen. Order is ascending."
                                    },
                                    {
                                        "type":"object",
                                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                                    }
                                ]
                            }
                        },
                        "privilege":{
                            "type":"string",
                            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                        }
                    },
                    "additionalProperties":false
                }
            }
        }
    ]
}

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

タイプ: object

ソースを表示

• accessors: object accessors
  アクセサ名を、対応するアクセサに固有の問合せオブジェクトにマップします。 各アクセサの問合せオブジェクトは、ベースと同様の問合せ機能をサポートしています。
• fields: array fields
  リソース・フィールドを制限します。 指定したフィールドおよび必須のシステム・フィールドのみが返されます。
• subTypes: object subTypes
  識別子値(サブタイプで定義)を、対応するサブタイプに固有の問合せオブジェクトにマップします。 サブタイプ固有の問合せオブジェクトでは、ベースと比較して問合せ機能のsubset(fields,accessors,filter)がサポートされています。

{
    "type":"object",
    "properties":{
        "fields":{
            "type":"array",
            "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
            "items":{
                "type":"string"
            }
        },
        "subTypes":{
            "type":"object",
            "description":"Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base."
        },
        "accessors":{
            "type":"object",
            "description":"Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base."
        }
    }
}

ネストされたスキーマ : タイプで打つ

タイプ: object

ソースを表示

• collection: object collection
  リソース・コレクションに適用できる問合せ基準を定義します。

{
    "type":"object",
    "properties":{
        "collection":{
            "type":"object",
            "description":"Defines query criteria that can be applied on a resource collection.",
            "properties":{
                "filter":{
                    "type":"string",
                    "description":"The resource collection will be queried using the specified filter condition."
                },
                "limit":{
                    "type":"integer",
                    "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
                },
                "offset":{
                    "type":"integer",
                    "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
                },
                "sortBy":{
                    "type":"array",
                    "description":"Orders a resource collection based on the specified fields.",
                    "items":{
                        "oneOf":[
                            {
                                "type":"string",
                                "description":"Name of field based on which sorting will happen. Order is ascending."
                            },
                            {
                                "type":"object",
                                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                            }
                        ]
                    }
                },
                "privilege":{
                    "type":"string",
                    "description":"Represents the privilege or action required to check for while serving a request to access a resource."
                }
            },
            "additionalProperties":false
        }
    }
}

ネストされたスキーマ : タイプで打つ

タイプ: object

ソースを表示

• parameters: object parameters
  ビューに固有のパラメータ化されたフィルタに適用される値。

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "description":"Values to be applied in a parameterized filter specific to the view."
        }
    }
}

ネストされたスキーマ : アクセサ

タイプ: object

アクセサ名を、対応するアクセサに固有の問合せオブジェクトにマップします。 各アクセサの問合せオブジェクトは、ベースと同様の問合せ機能をサポートしています。

ネストされたスキーマ : フィールド

タイプ: array

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

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
    "items":{
        "type":"string"
    }
}

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

タイプ: object

識別子値(サブタイプで定義)を、対応するサブタイプに固有の問合せオブジェクトにマップします。 サブタイプ固有の問合せオブジェクトでは、ベースと比較して問合せ機能のsubset(fields,accessors,filter)がサポートされています。

ネストされたスキーマ : コレクション

タイプ: object

リソース・コレクションに適用できる問合せ基準を定義します。

ソースを表示

• filter: string
  指定されたフィルタ条件を使用して、リソース・コレクションにクエリーが実行されます。
• limit: integer
  リソース・コレクション内で返されるリソース・アイテムの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソース・アイテムのみを返します。
• offset: integer
  リソース・コレクションの開始位置を定義します。 オフセットがリソース数を超えると、リソース・アイテムは返されません。
• privilege: string
  リソースへのアクセス・リクエストの処理中に確認する必要がある権限またはアクションを表します。
• sortBy: array sortBy
  指定したフィールドに基づいてリソース・コレクションをオーダーします。

{
    "type":"object",
    "description":"Defines query criteria that can be applied on a resource collection.",
    "properties":{
        "filter":{
            "type":"string",
            "description":"The resource collection will be queried using the specified filter condition."
        },
        "limit":{
            "type":"integer",
            "description":"Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items."
        },
        "offset":{
            "type":"integer",
            "description":"Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned."
        },
        "sortBy":{
            "type":"array",
            "description":"Orders a resource collection based on the specified fields.",
            "items":{
                "oneOf":[
                    {
                        "type":"string",
                        "description":"Name of field based on which sorting will happen. Order is ascending."
                    },
                    {
                        "type":"object",
                        "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
                    }
                ]
            }
        },
        "privilege":{
            "type":"string",
            "description":"Represents the privilege or action required to check for while serving a request to access a resource."
        }
    },
    "additionalProperties":false
}

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

タイプ: array

指定したフィールドに基づいてリソース・コレクションをオーダーします。

ソースを表示

• Array of: items

{
    "type":"array",
    "description":"Orders a resource collection based on the specified fields.",
    "items":{
        "oneOf":[
            {
                "type":"string",
                "description":"Name of field based on which sorting will happen. Order is ascending."
            },
            {
                "type":"object",
                "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
            }
        ]
    }
}

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

1つのスキーマに一致

ソースを表示

• 文字列
  ソートが発生する基準となるフィールドの名前。 オーダーは昇順です。
• object 「タイプで打つ」
  単一エントリを持つオブジェクト。 キーは、ソートが発生する基準となるフィールドの名前である必要があります。 ソート順序を決定するには、値を昇順または降順にする必要があります。

{
    "oneOf":[
        {
            "type":"string",
            "description":"Name of field based on which sorting will happen. Order is ascending."
        },
        {
            "type":"object",
            "description":"Object with single entry. Key must be name of field based on which sorting will happen. Value must be either asc or desc to decide the sort order."
        }
    ]
}

ネストされたスキーマ : タイプで打つ

タイプ: object

単一エントリを持つオブジェクト。 キーは、ソートが発生する基準となるフィールドの名前である必要があります。 ソート順序を決定するには、値を昇順または降順にする必要があります。

ネストされたスキーマ : パラメータ

タイプ: object

ビューに固有のパラメータ化されたフィルタに適用される値。

トップに戻る

応答

デフォルトのレスポンス

品目の配列レスポンス

本文( )

ルート・スキーマ : integrationMaps_view-default

すべて一致

ソースを表示

• object __collection_context
• object integrationMaps_view-default-allOf[1]

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

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

タイプ: object

ソースを表示

• hasMore: boolean

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

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

タイプ: object

ソースを表示

• items: array items

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

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

タイプ: array

ソースを表示

• Array of: integrationMaps_view-default_item-response

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

ネストされたスキーマ : integrationMaps_view-default_item-response

すべて一致

ソースを表示

• allOf integrationMaps_item-response
• object integrationMaps_view-default_item-response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/integrationMaps_item-response"
        },
        {
            "type":"object",
            "properties":{
                "integrationMapId":{
                },
                "name":{
                },
                "description":{
                },
                "integrationMapNumber":{
                },
                "sourceObject":{
                },
                "seededFlag":{
                },
                "integrationSpec":{
                },
                "createdBy":{
                },
                "timeCreated":{
                },
                "updatedBy":{
                },
                "timeUpdated":{
                },
                "lockedFlag":{
                },
                "activeFlag":{
                }
            }
        }
    ]
}

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

すべて一致

ソースを表示

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

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

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

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

タイプ: 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."
}

ネストされたスキーマ : __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
                }
            }
        }
    }
}

ネストされたスキーマ : integrationMaps_view-default_item-response-allOf[1]

タイプ: object

ソースを表示

• activeFlag:
• createdBy:
• description:
• integrationMapId:
• integrationMapNumber:
• integrationSpec:
• lockedFlag:
• name:
• seededFlag:
• sourceObject:
• timeCreated:
• timeUpdated:
• updatedBy:

{
    "type":"object",
    "properties":{
        "integrationMapId":{
        },
        "name":{
        },
        "description":{
        },
        "integrationMapNumber":{
        },
        "sourceObject":{
        },
        "seededFlag":{
        },
        "integrationSpec":{
        },
        "createdBy":{
        },
        "timeCreated":{
        },
        "updatedBy":{
        },
        "timeUpdated":{
        },
        "lockedFlag":{
        },
        "activeFlag":{
        }
    }
}

ネストされたスキーマ : $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"
        }
    }
}

「トップに戻る」