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

すべての登録の取得

get

/crmRestApi/resources/11.13.18.05/programEnrollments

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • EnrollmentNumber : プログラム登録の代替キー識別子。
      ファインダ変数:
      • EnrollmentNumber; string; プログラム登録の代替キー識別子。
    • EnrollmentNumberRF : 指定した登録番号を持つ登録を検索します。
      ファインダ変数:
      • EnrollmentNumber; string; プログラム登録の代替キー識別子。
    • PrimaryKey : 指定したプログラム登録IDを持つ登録を検索します。
      ファインダ変数:
      • ProgramEnrollmentId; number;パートナ・プログラム登録の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActiveEnrollment; string;登録のアクティビティ・ステータス。 受け入れられる値はアクティブおよび非アクティブです。
    • CreatedBy; string; 登録レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • EnrollmentNumber; string; プログラム登録の代替キー識別子。
    • EnrollmentStatus; string;登録のステータス。 受け入れられる値は、ドラフト、待ち状態、承認済、否認済、終了済および更改済です。 有効な値のリストは、参照ZPM_ENROLLMENT_STATUSで定義されます。
    • ExpirationDate; string;登録が失効する日付。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • PartnerCompanyNumber; string;プログラム登録に関連付けられたパートナ会社の公開一意識別子。
    • PartnerPartyId; number;パートナの一意の識別子。
    • PartnerPartyName; string;パートナの名前。
    • PartnerProgramId; number;パートナ・プログラムの一意の識別子。
    • PartnerTierId; integer;パートナの層。
    • ProgramDescription; string;プログラムの説明。
    • ProgramEnrollmentId; number;パートナ・プログラム登録の一意の識別子。
    • ProgramName; string;パートナ・プログラムの名前。
    • ProgramNumber; string;プログラムの代替キー識別子。
    • RenewedEnrollment; string;登録の更新ステータス。 受け入れられる値は、新規および更新です。
    • RenewedFromId; number;更改登録のコピー元となる登録の一意の識別子。
    • StartDate; string; プログラム登録が開始される有効日。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : programEnrollments
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : programEnrollments-item-response
タイプ: object
ソースを表示
  • タイトル: Approved Enrollment State
    読取り専用: true
    登録のアクティビティ・ステータス。 受け入れられる値はアクティブおよび非アクティブです。
  • タイトル: Approval Date
    読取り専用: true
    登録が承認された日付。
  • Attachments
    タイトル: Attachments
    添付リソースは、添付の表示、作成および更新に使用されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    登録レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Enrollment Number
    最大長: 30
    プログラム登録の代替キー識別子。
  • タイトル: Status
    最大長: 30
    デフォルト値: DRAFT
    登録のステータス。 受け入れられる値は、ドラフト、待ち状態、承認済、否認済、終了済および更改済です。 有効な値のリストは、参照ZPM_ENROLLMENT_STATUSで定義されます。
  • タイトル: End Date
    登録が失効する日付。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • Notes
    タイトル: Notes
    ノート・リソースは、パートナ・プログラムに関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、パートナ・プログラムに関連するコメント、情報またはインストラクションを取得します。
  • タイトル: Partner Number
    最大長: 30
    プログラム登録に関連付けられたパートナ会社の公開一意識別子です。
  • タイトル: Partner
    パートナの名前。
  • パートナの一意の識別子。
  • タイトル: Partner
    読取り専用: true
    最大長: 360
    パートナの名前。
  • Partner Programs
    タイトル: Partner Programs
    パートナ・プログラム・リソースは、プログラムの名前、プログラム摘要、有効期間など、パートナ・プログラムに関する情報を表示するために使用されます。
  • パートナ・プログラムの一意の識別子。
  • タイトル: Partner Tier
    読取り専用: true
    パートナの階層。
  • 読取り専用: true
    パートナ・プログラムに現在のユーザーがアクセスできるかどうかを示します。
  • Program Benefit Details
    タイトル: Program Benefit Details
    プログラム特典詳細リソースは、プログラム特典の詳細を表示するために使用されます。
  • タイトル: Program Description
    読取り専用: true
    最大長: 1000
    プログラムの摘要。
  • パートナ・プログラム登録の一意の識別子。
  • タイトル: Program
    最大長: 150
    パートナ・プログラムの名前。
  • タイトル: Program Number
    最大長: 30
    プログラムの代替キー識別子。
  • タイトル: Expiration in Days
    読取り専用: true
    最大長: 255
    登録が失効するまでの日数。
  • 読取り専用: true
    登録が現在のステータスに基づいて更改済ステータスに遷移できるかどうかを示します。
  • タイトル: Renewal
    読取り専用: true
    最大長: 255
    登録の更新ステータス。 受け入れられる値は、新規および更新です。
  • タイトル: Previous Enrollment Number
    読取り専用: true
    現在の登録が前の登録から更改されるかどうかを示します。
  • 読取り専用: true
    更改登録のコピー元となる登録の一意の識別子。
  • タイトル: Start Date
    プログラム登録が開始される有効日。
  • タイトル: Submission Date
    登録が発行された日付。
  • 読取り専用: true
    登録が現在のステータスに基づいて待ち状態ステータスに遷移できるかどうかを示します。
  • 読取り専用: true
    登録が現在のステータスに基づいて終了ステータスに遷移できるかどうかを示します。
  • タイトル: Termination Date
    読取り専用: true
    登録が終了する日付。
  • 読取り専用: true
    登録が現在のステータスに基づいて取下げステータスに遷移できるかどうかを示します。
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : ノート
タイプ: array
タイトル: Notes
ノート・リソースは、パートナ・プログラムに関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、パートナ・プログラムに関連するコメント、情報またはインストラクションを取得します。
ソースを表示
ネストされたスキーマ : パートナ・プログラム
タイプ: array
タイトル: Partner Programs
パートナ・プログラム・リソースは、プログラムの名前、プログラム摘要、有効期間など、パートナ・プログラムに関する情報を表示するために使用されます。
ソースを表示
ネストされたスキーマ : プログラム給付金詳細
タイプ: array
タイトル: Program Benefit Details
プログラム特典詳細リソースは、プログラム特典の詳細を表示するために使用されます。
ソースを表示
ネストされたスキーマ : programEnrollments-Attachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : programEnrollments-Notes-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
    ノートに関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Delete Indicator
    読取り専用: true
    ノートを削除するかどうかを示します。 値がYの場合、ノートを削除する必要があります。 デフォルト値はNです。
  • タイトル: 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
    このコードは、ノートのタイプを示します。 有効な値のリストは、参照ZMM_NOTE_TYPEで定義されます。
  • タイトル: Parent Note ID
    親ノートの一意の識別子。
  • タイトル: Party ID
    読取り専用: true
    ノートが関連付けられている担当者の一意の識別子。 住所が関連付けられている担当者レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
  • タイトル: Author
    読取り専用: true
    最大長: 360
    担当者パーティの名前。
  • タイトル: Related Object Type
    最大長: 30
    OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。
  • タイトル: Related Object
    最大長: 64
    OBJECTS Metadataで定義されたソース・オブジェクトの主キー識別子(アクティビティ、商談など)。
  • タイトル: Update Indicator
    読取り専用: true
    ノートを更新できるかどうかを示します。 値がYの場合は、ノートを更新できます。 デフォルト値はNです。
  • タイトル: Private
    最大長: 30
    デフォルト値: INTERNAL
    内部、外部、プライベートなど、ノートの表示レベルを示すコード。 有効な値のリストは、参照ZMM_NOTE_VISIBILITYで定義されます。
ネストされたスキーマ : 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です。
ネストされたスキーマ : programEnrollments-ProgramBenefitDetails-item-response
タイプ: object
ソースを表示
  • 特典の価値。 DataTypeがList型の場合、属性に値があります。
  • タイトル: Benefit Value
    最大長: 150
    特典の価値。
  • タイトル: Category
    読取り専用: true
    最大長: 30
    特典のカテゴリを示すコード。 たとえば、Financial、Sales、Technical Supportなどです。 有効な値のリストは、参照ORA_ZPM_BENEFIT_CATEGORYで定義されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードが最後に更新された日時。
  • タイトル: Creation Date
    読取り専用: true
    レコードを最後に作成したユーザー。
  • タイトル: Value Type
    読取り専用: true
    最大長: 30
    特典の値タイプ。 たとえば、金額、リスト、数値、テキスト、はい/いいえです。
  • 読取り専用: true
    レコードを削除できるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Benefits Description
    読取り専用: true
    最大長: 1000
    特典を説明するテキスト。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    プログラム特典詳細を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Name
    最大長: 155
    特典の名前。
  • タイトル: Program
    登録に関連付けられたパートナ・プログラムの識別子。
  • タイトル: Program Benefit Details
    プログラム福利厚生詳細の一意の識別子。
  • タイトル: Benefit
    プログラム特典の一意の識別子。
  • タイトル: Tier
    プログラム特典の関連階層の一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 155
    ベネフィットに関連付けられた階層の名前。
  • 読取り専用: true
    レコードを更新できるかどうかを示します。 デフォルト値はfalseです。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行して、すべての登録を取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
   "items" : [25]
   -0: {
EnrollmentStatus: "APPROVED"
LastUpdateDate: "2011-06-24T14:35:39-07:00"
PartnerPartyId: 100000016934002
PartnerProgramId: 300100000339515
ProgramEnrollmentId: 300100000408356
ApprovalDate: "2011-06-24"
ExpirationDate: "2014-06-24"
TerminationDate: null
StartDate: "2011-06-24"
RenewedFromId: null
RemainingDays: "0"
ProgramName: "BIQA_PRM PLATINUM PROGRAM"
ProgramDescription: "BIQA_PRM PLATINUM PROGRAM"
ActiveEnrollment: "INACTIVE"
RenewedEnrollment: "NEW"
PartnerPartyName: " High Technology "
...
}
    -1:
	{
...
}
...
}
「トップに戻る」