機械翻訳について

ビジネス・プランの作成

post

/crmRestApi/resources/11.13.18.05/businessPlans

リクエスト

ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
  • 次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Class
    最大長: 20
    デフォルト値: PARTNER
    ビジネス・プランのクラスを示すコード。 有効な値のリストは、参照BusinessPlanClassVAで定義されます。
  • タイトル: Business Plan ID
    ビジネス・プランの一意の識別子。
  • タイトル: Number
    最大長: 64
    ビジネス・プランの代替キー識別子。
  • タイトル: Owner ID
    ビジネス・プラン所有者の一意の識別子。
  • Business Plan Resources
    タイトル: Business Plan Resources
    ビジネス・プラン・リソースは、ビジネス・プランに関連付けられているチーム・メンバーを表示、作成、更新および削除するために使用されます。
  • タイトル: Type
    最大長: 30
    ビジネス・プランのタイプを示すコード。 有効な値のリストは、参照BusinessPlanTypeVAで定義されます。
  • タイトル: Customer ID
    ビジネス・プラン・アカウントの一意の識別子。
  • タイトル: Description
    最大長: 3000
    ビジネス・プランの摘要。
  • タイトル: Name
    最大長: 275
    ビジネス計画の名前。
  • Notes
    タイトル: Notes
    ノート・リソースは、ビジネス・プランに関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、ビジネス・プランに関連するコメント、情報またはインストラクションを取得します。
  • タイトル: Original Creation Date
    ビジネス計画が最初に作成された日付。
  • タイトル: Owner
    最大長: 360
    ビジネス計画所有者の名前。
  • タイトル: Partner ID
    ビジネス・プラン・パートナの一意の識別子。
  • タイトル: Partner Number
    最大長: 30
    PartnerIdに対応する代替キー。
  • タイトル: Partner
    最大長: 360
    ビジネス・プランのパートナの表示名。
  • タイトル: Period End Name
    最大長: 30
    ビジネス・プラン期間の終了の表示名。
  • タイトル: Period End Internal Name
    最大長: 30
    ビジネス・プラン期間の終了の内部名。
  • タイトル: Period
    最大長: 80
    ビジネス期間範囲の表示名。
  • 最大長: 15
    ビジネス・プラン期間のカレンダの名前。
  • タイトル: Period Start Name
    最大長: 30
    ビジネス・プラン期間の開始の表示名。
  • タイトル: Period Start Internal Name
    最大長: 30
    ビジネス・プラン期間の開始の内部名。
  • タイトル: Period Type
    最大長: 30
    ビジネス・プランの期間を示すコード。 有効な値のリストは、参照SalesObjectiveGLPeriodTypeViewAccessorで定義されます。
  • タイトル: Status
    最大長: 30
    ビジネス・プランのステータスを示すコード。 有効な値のリストは、参照BusinessPlanStatusVAで定義されます。
  • SWOTs
    タイトル: SWOTs
    SWOTsリソースは、ビジネス・プランの長所、短所、商談および脅威の表示、作成、更新および削除に使用されます。
ネストされたスキーマ : ビジネス・プランのリソース
タイプ: array
タイトル: Business Plan Resources
ビジネス・プラン・リソースは、ビジネス・プランに関連付けられているチーム・メンバーを表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : ノート
タイプ: array
タイトル: Notes
ノート・リソースは、ビジネス・プランに関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、ビジネス・プランに関連するコメント、情報またはインストラクションを取得します。
ソースを表示
ネストされたスキーマ : SWOTs
タイプ: array
タイトル: SWOTs
SWOTsリソースは、ビジネス・プランの長所、短所、商談および脅威の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : businessPlans-BusinessPlanResource-item-post-request
タイプ: object
ソースを表示
ネストされたスキーマ : businessPlans-Note-item-post-request
タイプ: object
ソースを表示
  • タイトル: Contact Relationship ID
    リレーションの一意の識別子。この値は、ノートが担当者に関連付けられているときに移入されます。
  • タイトル: Corporate Currency Code
    最大長: 15
    担当者に関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。
  • タイトル: Creator Party ID
    ノート作成者のパーティの一意の識別子。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    ノートに関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。
  • タイトル: Currency
    最大長: 15
    ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照RatedCurrenciesVAで定義されます。
  • 最大長: 30
    ノートの代替一意識別子。 システム生成または外部システムからのユーザー・キー。
  • タイトル: Title
    最大長: 500
    ユーザーが入力したノートのタイトル。
  • タイトル: Note
    実際のノートのテキスト。
  • タイトル: Type
    最大長: 30
    これは、ノートを分類するためのノート・タイプ・コードです。 有効な値のリストは、参照NoteSourceTypeVAで定義されます。
  • タイトル: Parent Note ID
    親ノートの一意の識別子。
  • タイトル: Related Object Type
    最大長: 30
    OBJECTS Metadataで定義されたソース・オブジェクトを示すコード(アクティビティ、商談、販売ビジネス・プランなど)。
  • タイトル: Related Object
    最大長: 64
    OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談、販売ビジネス・プランなど)。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    これは、ノートの表示レベルを指定するための属性です。 有効な値のリストは、参照NoteVisibilityLookupVAで定義されます。
ネストされたスキーマ : businessPlans-Swot-item-post-request
タイプ: object
ソースを表示
  • タイトル: Business Plan ID
    ビジネス・プランの一意の識別子。
  • タイトル: Business Plan Number
    最大長: 64
    親PUID。
  • タイトル: Description
    最大長: 2000
    SWOTの摘要。
  • タイトル: SWOT ID
    ビジネス・プランSWOTの一意の識別子。
  • タイトル: Number
    最大長: 64
    ビジネス・プランSWOTの代替キー識別子。
  • タイトル: Type Code
    最大長: 30
    ビジネス・プランSWOTのタイプを示すコード。 有効な値のリストは、参照ORA_ZCA_BUS_PLAN_SWOTで定義されます。 指定可能な値は、Opportunity(商談)、Strength(強さ)、Threat(脅威)、Weakmess(弱い)です。
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • 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(弱い)です。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、ビジネス・プランを作成する方法を示しています。

cURLコマンド

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

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"Name": "Business Plan for FNC",
"PartnerId": 100100006031746,
"PeriodTypeCode": "YEAR",
"PeriodSetName": "Accounting12",
"PeriodEndName": "12-16",
"PeriodStartName": "01-16",
"StatusCode": "ORA_DRAFT"
}

レスポンス本文の例

次の例は、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": null,
"LastUpdateDate": "2016-12-12T02:39:59-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",
...
}
「トップに戻る」