機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. ビジネス・プラン

ビジネス計画の取得

get

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}

リクエスト

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

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

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

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : businessPlans-item-response
タイプ: object
ソースを表示
  • タイトル: Class
    最大長: 20
    デフォルト値: PARTNER
    ビジネス・プランのクラスを示すコード。 有効な値のリストは、参照BusinessPlanClassVAで定義されます。
  • タイトル: Business Plan ID
    ビジネス・プランの一意の識別子。
  • タイトル: Number
    最大長: 64
    ビジネス・プランの代替キー識別子。
  • タイトル: Owner ID
    ビジネス・プラン所有者の一意の識別子。
  • タイトル: Owner Number
    読取り専用: true
    最大長: 30
    BusinessPlanOwnerIdに対応する代替キー。
  • Business Plan Resources
    タイトル: Business Plan Resources
    ビジネス・プラン・リソースは、ビジネス・プランに関連付けられているチーム・メンバーを表示、作成、更新および削除するために使用されます。
  • タイトル: Type
    最大長: 30
    ビジネス・プランのタイプを示すコード。 有効な値のリストは、参照BusinessPlanTypeVAで定義されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Customer ID
    ビジネス・プラン・アカウントの一意の識別子。
  • タイトル: Customer Number
    読取り専用: true
    最大長: 30
    CustomerIdに対応する代替キー。
  • タイトル: Customer Type
    読取り専用: true
    最大長: 30
    ビジネス・プランに関連付けられている顧客のパーティ・タイプ。 有効な値のリストは、参照CA_RECORD_TYPEで定義されます。 指定可能な値は、組織、グループまたは個人です。
  • 読取り専用: true
    ビジネス・プランを削除できるかどうかを示します。
  • タイトル: Description
    最大長: 3000
    ビジネス・プランの摘要。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 275
    ビジネス計画の名前。
  • Notes
    タイトル: Notes
    ノート・リソースは、ビジネス・プランに関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、ビジネス・プランに関連するコメント、情報またはインストラクションを取得します。
  • タイトル: Original Creation Date
    ビジネス計画が最初に作成された日付。
  • タイトル: Owner
    最大長: 360
    ビジネス計画所有者の名前。
  • タイトル: Partner ID
    ビジネス・プラン・パートナの一意の識別子。
  • タイトル: Partner
    読取り専用: true
    最大長: 80
    ビジネス計画に関連付けられているパートナの名前。
  • タイトル: Partner Number
    最大長: 30
    PartnerIdに対応する代替キー。
  • タイトル: Partner
    最大長: 360
    ビジネス・プランのパートナの表示名。
  • タイトル: End Date
    読取り専用: true
    期間終了日
  • タイトル: Period End Name
    最大長: 30
    ビジネス・プラン期間の終了の表示名。
  • タイトル: Period End Internal Name
    最大長: 30
    ビジネス・プラン期間の終了の内部名。
  • タイトル: Period
    最大長: 80
    ビジネス期間範囲の表示名。
  • 最大長: 15
    ビジネス・プラン期間のカレンダの名前。
  • タイトル: Start Date
    読取り専用: true
    期間開始日
  • タイトル: Period Start Name
    最大長: 30
    ビジネス・プラン期間の開始の表示名。
  • タイトル: Period Start Internal Name
    最大長: 30
    ビジネス・プラン期間の開始の内部名。
  • タイトル: Period Type
    最大長: 30
    ビジネス・プランの期間を示すコード。 有効な値のリストは、参照SalesObjectiveGLPeriodTypeViewAccessorで定義されます。
  • 読取り専用: true
    ビジネス・プランのアクティビティの取得に使用されるソース・タイプ。
  • タイトル: Status
    最大長: 30
    ビジネス・プランのステータスを示すコード。 有効な値のリストは、参照BusinessPlanStatusVAで定義されます。
  • SWOTs
    タイトル: SWOTs
    SWOTsリソースは、ビジネス・プランの長所、短所、商談および脅威の表示、作成、更新および削除に使用されます。
  • 読取り専用: true
    ビジネス・プランを更新できるかどうかを示します。 デフォルト値はtrueです。
ネストされたスキーマ : ビジネス・プランのリソース
タイプ: array
タイトル: Business Plan Resources
ビジネス・プラン・リソースは、ビジネス・プランに関連付けられているチーム・メンバーを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : ノート
タイプ: array
タイトル: Notes
ノート・リソースは、ビジネス・プランに関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、ビジネス・プランに関連するコメント、情報またはインストラクションを取得します。
ソースを表示
ネストされたスキーマ : SWOTs
タイプ: array
タイトル: SWOTs
SWOTsリソースは、ビジネス・プランの長所、短所、商談および脅威の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : businessPlans-BusinessPlanResource-item-response
タイプ: object
ソースを表示
  • タイトル: Access
    最大長: 30
    チーム・メンバーのアクセス・レベルを示すコード。 有効な値のリストは、参照ORA_ZCA_BUS_PLAN_ACCESS_LEVELで定義されます。
  • タイトル: Business Plan ID
    ビジネス・プランの一意の識別子。
  • タイトル: Number
    最大長: 64
    親PUID。
  • タイトル: Business Plan Resource ID
    ビジネス・プラン・リソースの一意の識別子。
  • タイトル: Resource Number
    最大長: 230
    ビジネス・プラン・リソースの代替キー識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • 読取り専用: true
    ビジネス・プラン・チーム・メンバーのマネージャの一意の識別子。
  • タイトル: Email
    読取り専用: true
    最大長: 320
    ビジネス計画チーム・メンバーの電子メール・アドレス。
  • タイトル: Phone
    読取り専用: true
    ビジネス計画チーム・メンバーの電話番号。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Manager
    読取り専用: true
    最大長: 360
    ビジネス計画チーム・メンバーのマネージャの名前。
  • タイトル: Function
    最大長: 30
    チーム・メンバーの機能を示すコード。 有効な値のリストは、参照MemberFunctionCodesVAで定義されます。
  • タイトル: Organization
    読取り専用: true
    最大長: 240
    ビジネス・プラン・チーム・メンバーの組織名。
  • タイトル: Owner Indicator
    読取り専用: true
    ビジネス計画チーム・メンバーがビジネス計画の所有者であるかどうかを示します。 値がTrueの場合、ビジネス計画チーム・メンバーもビジネス計画の所有者になります。 デフォルト値は「False」です。
  • タイトル: Resource ID
    リソースの一意の識別子。
  • 読取り専用: true
    最大長: 360
    チーム・メンバーの名前。
  • 読取り専用: true
    最大長: 30
    ResourceIdに対応する代替キー。
  • タイトル: Role
    読取り専用: true
    最大長: 60
    チーム・メンバーのロールの名前。
ネストされたスキーマ : businessPlans-Note-item-response
タイプ: object
ソースを表示
  • タイトル: Contact Relationship ID
    リレーションの一意の識別子。この値は、ノートが担当者に関連付けられているときに移入されます。
  • タイトル: Corporate Currency Code
    最大長: 15
    担当者に関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Creator Party ID
    ノート作成者のパーティの一意の識別子。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ノートに関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
  • タイトル: Currency
    最大長: 15
    ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照RatedCurrenciesVAで定義されます。
  • タイトル: Delete Indicator
    読取り専用: true
    ビジネス・プラン・ノートを削除できるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Primary Email
    読取り専用: true
    最大長: 320
    ノートを作成したユーザーの電子メール・アドレス。
  • タイトル: Primary Address
    読取り専用: true
    ノートを作成したユーザーの住所。
  • タイトル: Primary Phone
    読取り専用: true
    ノートを作成したユーザーの電話番号。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Note ID
    読取り専用: true
    ビジネス・プランのノートの一意の識別子。
  • 最大長: 30
    ノートの代替一意識別子。 システム生成または外部システムからのユーザー・キー。
  • タイトル: Title
    最大長: 500
    ユーザーが入力したノートのタイトル。
  • タイトル: Note
    実際のノートのテキスト。
  • タイトル: Type
    最大長: 30
    これは、ノートを分類するためのノート・タイプ・コードです。 有効な値のリストは、参照NoteSourceTypeVAで定義されます。
  • タイトル: Parent Note ID
    親ノートの一意の識別子。
  • タイトル: Party ID
    読取り専用: true
    ノートが関連付けられている担当者の一意の識別子。 この場合、CreatorPartyIdと同じです。
  • タイトル: Author
    読取り専用: true
    最大長: 360
    ビジネス・プランに関連付けられているパーティの名前。
  • タイトル: Related Object Type
    最大長: 30
    OBJECTS Metadataで定義されたソース・オブジェクトを示すコード(アクティビティ、商談、販売ビジネス・プランなど)。
  • タイトル: Related Object
    最大長: 64
    OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談、販売ビジネス・プランなど)。
  • タイトル: Update Indicator
    読取り専用: true
    ビジネス・プラン・ノートを更新できるかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    これは、ノートの表示レベルを指定するための属性です。 有効な値のリストは、参照NoteVisibilityLookupVAで定義されます。
ネストされたスキーマ : businessPlans-Swot-item-response
タイプ: object
ソースを表示
  • タイトル: Business Plan ID
    ビジネス・プランの一意の識別子。
  • タイトル: Business Plan Number
    最大長: 64
    親PUID。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Description
    最大長: 2000
    SWOTの摘要。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: SWOT ID
    ビジネス・プランSWOTの一意の識別子。
  • タイトル: Number
    最大長: 64
    ビジネス・プランSWOTの代替キー識別子。
  • タイトル: Type Code
    最大長: 30
    ビジネス・プランSWOTのタイプを示すコード。 有効な値のリストは、参照ORA_ZCA_BUS_PLAN_SWOTで定義されます。 指定可能な値は、Opportunity(商談)、Strength(強さ)、Threat(脅威)、Weakmess(弱い)です。
リンク
BusinessPlanClassVA
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_CLASS
ビジネス・プランの区分を示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: BusinessPlanClassCode;ターゲット属性: LookupCode
  • 表示属性: 意味
BusinessPlanResource
パラメータ:
  • BusinessPlanId: $request.path.BusinessPlanId
ビジネス・プラン・リソースは、ビジネス・プランに関連付けられているチーム・メンバーを表示、作成、更新および削除するために使用されます。
BusinessPlanStatusVA
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_STATUS%2CBindLookupCode%3D{StatusCode}
ビジネス・プランのステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: StatusCode;ターゲット属性: LookupCode
  • 表示属性: 意味
BusinessPlanTypeVA
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_TYPE%2CBindLookupCode%3D{BusinessPlanTypeCode}
ビジネス・プランのタイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: BusinessPlanTypeCode;ターゲット属性: LookupCode
  • 表示属性: 意味
ノート
パラメータ:
  • BusinessPlanId: $request.path.BusinessPlanId
ノート・リソースは、ビジネス・プランに関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、ビジネス・プランに関連するコメント、情報またはインストラクションを取得します。
PartnerAccountResourcePVO
ビジネス・プラン所有者の名前の値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: OwnerResourceName;ターゲット属性: ResourceName
  • 表示属性: ResourceName
PartnerPickerPVO
パラメータ:
  • ファインダ: ActivePartnersFinder
ビジネス・プランに関連付けられているパートナの表示名の値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: PartnerPartyDisplayName;ターゲット属性: PartyName
  • 表示属性: PartyName
SalesGLEndPeriodPickTimeListToViewAccessor
パラメータ:
  • ファインダ: EndPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
ビジネス・プラン終了期間の表示名の値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: PeriodEndDisplayName;ターゲット属性: PeriodName
  • 表示属性: PeriodName
SalesGLStartPeriodPickerTimeListViewAccessor
パラメータ:
  • ファインダ: StartPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
ビジネス・プラン開始期間の表示名の値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: PeriodStartDisplayName;ターゲット属性: PeriodName
  • 表示属性: PeriodName
SalesObjectiveGLPeriodTypeViewAccessor
ビジネス・プラン期間のタイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: PeriodTypeCode;ターゲット属性: LookupCode
  • 表示属性: 意味
Swot
パラメータ:
  • BusinessPlanId: $request.path.BusinessPlanId
SWOTsリソースは、ビジネス・プランの長所、短所、商談および脅威の表示、作成、更新および削除に使用されます。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、ビジネス・プランを取得する方法を示しています。

cURLコマンド

- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/businessPlans/300100091979253

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"BusinessPlanClassCode": "PARTNER",
"BusinessPlanId": 300100091979253,
"Name": "Business Plan for FNC",
"BusinessPlanNumber": "CDRM_24034",
"BusinessPlanOwnerId": 100010037456865,
"BusinessPlanTypeCode": null,
"CreatedBy": "MHoope",
"CreationDate": "2016-12-12T02:39:59-08:00",
"Description": "New Description",
"LastUpdateDate": "2016-12-12T02:43:16-08:00",
"LastUpdateLogin": "4373F6AF02325539E05364C0F20A8DA6",
"LastUpdatedBy": "MHoope",
"PartnerId": 100100006031746,
"PeriodTypeCode": "YEAR",
"PeriodSetName": "Accounting12",
"PeriodStartName": "01-16",
"PeriodEndName": "12-16",
"StatusCode": "ORA_DRAFT",
"OwnerResourceName": "Matt Hooper",
"PartnerName": "17201319412525834151",
"PeriodStartDisplayName": "2016",
"PeriodEndDisplayName": "2016",
"PeriodRangeDisplayName": "2016",
"OrigCreationDate": "2016-12-12T02:39:59-08:00",
"PartnerPartyDisplayName": "17201319412525834151",
"UpdateFlag": true,
"DeleteFlag": true,
"SourceType": "SALES_BUSINESS_PLAN",
...
}
「トップに戻る」