機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. プログラム登録
  4. パートナ・プログラム

登録のパートナ・プログラムの取得

get

/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgram/{PartnerProgramId}

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : programEnrollments-PartnerProgram-item-response
タイプ: object
ソースを表示
  • タイトル: Countries
    読取り専用: true
    プログラムの国名。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    プログラム・レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    プログラム・レコードが作成された日時。
  • 読取り専用: true
    レコードを削除できるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: End Date
    プログラムが終了したときの有効データ。
  • タイトル: Last Updated Date
    読取り専用: true
    プログラム・レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    プログラム・レコードを更新したユーザー。
  • 読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Owner Party Number
    読取り専用: true
    最大長: 30
    パートナ・プログラムの所有者パーティの公開一意識別子です。
  • タイトル: Program ID
    登録に関連付けられたパートナ・プログラムの一意の識別子。 これはパートナ・プログラム表の主キーです。
  • タイトル: Description
    最大長: 1000
    プログラムの摘要。
  • タイトル: Program Manager ID
    パートナ・プログラムを管理する個人の一意の識別子。
  • タイトル: Owner
    最大長: 360
    プログラム・マネージャの名前。
  • タイトル: Name
    最大長: 150
    パートナ・プログラムの名前。
  • タイトル: Program Number
    最大長: 30
    プログラムに対して生成された一意の番号。
  • タイトル: Type
    最大長: 30
    パートナ・プログラムのタイプ。 受け入れられる値は、開発者、販売業者、市場投入、テクノロジ・パートナ、製品フォーカス・エリアおよび再販業者です。 受け入れられる値のリストは、参照ZPM_PARTNER_PROGRAM_TYPEで定義されます。
  • タイトル: Start Date
    プログラムが開始する有効日。
  • タイトル: Status
    最大長: 30
    デフォルト値: D
    パートナ・プログラムのステータス。 受け入れられる値は、ドラフト、保留中、公開済および終了済です。
  • 読取り専用: true
    レコードを更新できるかどうかを示します。 デフォルト値はfalseです。
リンク
ProgramStatuses
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PROGRAM_STATUS%2CBindLookupCode%3D{StatusCode}
プログラム・ステータスの値リスト

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: StatusCode;ターゲット属性: LookupCode
  • 表示属性: 意味
ProgramTypes
パラメータ:
  • ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PARTNER_PROGRAM_TYPE%2CBindLookupCode%3D{ProgramType}
プログラム定義で定義されている、開発者、販売代理業者、再販業者など、選択したパートナ・プログラムのタイプ。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ProgramType;ターゲット属性: LookupCode
  • 表示属性: 意味
リソース
選択したパートナ・プログラム所有者の値(Colby Morrisなど)。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: ProgramManagerName;ターゲット属性: ResourceName
  • 表示属性: ResourceFirstName, ResourceLastName, EmailAddress, OrganizationName, RoleName
delete
パラメータ:
  • EnrollmentNumber: $request.path.EnrollmentNumber
  • PartnerProgramId: $request.path.PartnerProgramId
このメソッドを使用すると、パートナ・プログラムを削除できます。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、登録のパートナ・プログラムを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/ENRM_12345/child/PartnerProgram/300100000339515

レスポンス本文の例

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

{
PartnerProgramId: 300100000339515
ProgramName: "PLATINUM PROGRAM"
ProgramDescription: "PLATINUM PROGRAM"
StartDateActive: "2011-06-23"
EndDateActive: "2021-12-31"
PrimaryContactId: 100010038017891
ProgramManagerId: 100010032636167
ProgramManagerName: "John Doe"
ProgramType: "GTMI"
CreatedBy: "CHANNEL_PARTNER_MANAGER"
CreationDate: "2011-06-23T06:09:36-07:00"
LastUpdateDate: "2011-06-24T12:11:29-07:00"
LastUpdatedBy: "CHANNEL_OPERATIONS_MGR"
ProgramApproverId: 100010025532588
ProgramApproverUser: "BEN_ADMIN_S2"
EnrollmentApproverUser: "SALES_MGR"
-links:[7]
-0: {
      ...
    }
-1: {
      ...
    }
-2: {
      ...
    }
 ...
}
「トップに戻る」