Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての商談取引を取得

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityDeal

リクエスト

パス・パラメータ

OptyNumber(required): string

商談の一意の代替識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- OpportunityDealAltKeyFinder : ディールまたは商談の一意の公開識別子に基づいて商談ディールを検索します。
  ファインダ変数:
  - DealNumber; string;ディールの一意の公開識別子。
  - OptyNumber; string;商談の一意の公開識別子。
- OptyIdDealIdKey : ディールまたは商談の主キーに基づいて商談ディールを検索します。
  ファインダ変数:
  - DealId; integer;ディールの主キー。
  - OptyId; integer;商談の主キー。
- PrimaryKey : 商談ディール識別子で商談ディールを検索します。
  ファインダ変数:
  - OptyDealId; integer;商談ディールの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ConflictId; integer; モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成された場合に、行の一意性を保証するために使用される値。
- CreatedBy; string; 商談ディール・レコードを作成したユーザー。
- CreationDate; string; 商談ディール・レコードが作成された日時。
- DealExpirationDate; string; ディールが期限切れになるように設定されている日時。
- DealId; integer;ディールの一意の識別子。
- DealName; string;商談ディールの名前。
- DealNumber; string;ディール登録の代替キー識別子。
- DealSize; number;商談に関連付けられているディールのサイズ。
- LastUpdateDate; string; 商談ディール・レコードが最後に更新された日時。
- LastUpdateLogin; string; 商談ディール・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdatedBy; string; 商談ディール・レコードを最後に更新したユーザー。
- OptyDealId; integer;商談ディールの一意の識別子。
- OptyId; integer;商談の一意の識別子。
- OptyNumber; string;商談の一意の代替識別子。
- PartnerId; integer;ディールで追跡されるパートナの一意の識別子。
- PartyName; string;パートナの名前。
- StatusCode; string; 商談取引のステータスを示すコード。有効な値のリストは、参照ORA_MKL_DEAL_REG_STATUSで定義されます。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : opportunities-OpportunityDeal

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityDeal-item-response"
            }
        }
    }
}

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

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object opportunities-OpportunityDeal-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityDeal-item-response"
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : opportunities-OpportunityDeal-item-response

タイプ: object

ソースを表示

ApprovedDate: 文字列(日付)

タイトル: Approved Date

読取り専用: true

ディールが承認された日時。
ConflictId: integer (int64)

タイトル: Conflict ID

デフォルト値: 0

モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

商談取引レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

商談取引レコードが作成された日時。
DealExpirationDate: 文字列(日付)

タイトル: Expiration Date

読取り専用: true

ディールが失効するように設定されている日時。
DealId: integer

タイトル: Deal ID

ディールの一意の識別子。
DealName: string

タイトル: Deal Name

読取り専用: true

最大長: 250

商談取引の名前。
DealNumber: string

タイトル: Registration Number

最大長: 30

ディール登録の代替キー識別子。
DealSize: number

タイトル: Deal Size

読取り専用: true

商談に関連付けられている取引のサイズ。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

商談取引レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

商談取引レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

商談ディール・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OptyDealId: integer

タイトル: Opportunity Deal ID

読取り専用: true

商談ディールの一意の識別子。
OptyId: integer

タイトル: Opportunity ID

商談の一意の識別子。
OptyNumber: string

タイトル: Opportunity Number

最大長: 30

商談の一意の代替識別子。
PartnerId: integer (int64)

タイトル: Partner ID

読取り専用: true

ディールで追跡されるパートナの一意の識別子。
PartyName: string

タイトル: Partner

読取り専用: true

最大長: 360

パートナの名前。
StatusCode: string

タイトル: Status

読取り専用: true

最大長: 30

商談ディールのステータスを示すコード。有効な値のリストは、参照ORA_MKL_DEAL_REG_STATUSで定義されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the opportunity deal record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity deal record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the deal.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the opportunity deal record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date and time when deal was approved.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the deal registration.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner tracked in the deal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealSize":{
            "title":"Deal Size",
            "type":"number",
            "description":"The size of the deal associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the opportunity deal. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date and time when the deal is set to expire.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealName":{
            "title":"Deal Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the opportunity deal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyDealId":{
            "title":"Opportunity Deal ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity deal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the opportunity deal record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the opportunity deal record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての商談ディールを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_335580/child/OpportunityDeal

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

 {
   "items" : [1]0: {
   "PartyName" : "Stryker Corp.",
   "CreatedBy": "JLOPEZ",
   "CreationDate": "2016-11-16T05:02:42-08:00",
   "LastUpdateDate": "2016-11-16T05:03:04-08:00",
   "LastUpdateLogin": "3F16A2DC2AF92E0FE05354C0F20A6B55",
   "OptyId" : 300100092363928,
   "LastUpdatedBy": "JLOPEZ",
   "DealId": 300100092363896,																											
   "OptyDealId": 300100092363935,																										
   "PartnerId": 100000016934002,																																		
   "DealNumber": "CDRM_47006",																															
   "ApprovedDate": "2016-10-18",																																	
   "DealName": null,																																							
   "StatusCode": "ORA_APPROVED",																																	
   "DealExpirationDate": "2017-01-16",																														
   ...
}
 }

「トップに戻る」