機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. パートナ

すべてのパートナを入手

get

/crmRestApi/resources/11.13.18.05/partnersLOV

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • ActivePartnersFinder : 指定したファインダを持つアクティブなパートナをすべて検索します。
      ファインダ変数:
      • BindDefaultStatus; string;バインドのデフォルト・ステータス。 これはオプションです。 これは渡す必要はありません。
      • BindExtraStatus; string;バインドの追加ステータス。 これはオプションです。 これは渡す必要はありません。
    • PrimaryKey : パーティ識別子を使用してパートナを検索します。
      ファインダ変数:
    • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
    • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
      • AccountDirectorId; integer; このパートナの所有者リソースの一意の識別子。
      • 住所;文字列;パートナの住所。
      • City; string;パートナ住所の市区町村名。
      • CompanyNumber; string; パートナの会社の代替キー識別子。
      • Country; string;パートナに関連付けられた国。
      • Location; string; 住所のロケーション。
      • LookupCode; string;参照コード。 この属性は内部です。
      • LookupType; string;参照タイプ。 この属性は内部です。
      • PartnerAccountId; integer;パートナ・アカウントの一意の識別子。 この属性は内部です。
      • PartnerLevel; string;パートナ・レベル・コード。
      • PartnerLevelMeaning; string; パートナ・レベルの意味。
      • PartnerStatusMeaning; string; パートナ・ステータスの意味。
      • PartnerType; string;パートナ・タイプの連結リスト。
      • PartyId; integer;パーティの一意の識別子。
      • PartyName; string;パートナの名前。
      • PartyUniqueName; string;パートナの一意の名前。
      • PostalCode; string; パートナ住所の郵便番号。
      • 都道府県、文字列。パートナ住所の都道府県。
      • ステータス、文字列。パートナ・ステータス・コード。
      • TerritoryCode; string;地域コード。
      • TerritoryShortName; string;テリトリ短縮名。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : partnersLOV
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : partnersLOV-item-response
    タイプ: object
    ソースを表示
    • このパートナの所有者リソースの一意の識別子。
    • タイトル: Address
      読取り専用: true
      最大長: 255
      パートナのアドレス。
    • タイトル: City
      読取り専用: true
      最大長: 60
      パートナ住所の市区町村名。
    • タイトル: Partner Number
      最大長: 30
      パートナの会社の代替キー識別子。
    • タイトル: Country
      読取り専用: true
      最大長: 2
      パートナに関連付けられた国。
    • タイトル: Address
      読取り専用: true
      パートナの書式設定された住所。
    • Links
    • タイトル: Location
      最大長: 90
      住所のロケーション。
    • タイトル: Lookup Code
      読取り専用: true
      最大長: 30
      参照コード。 この属性は内部です。
    • タイトル: Lookup Type
      読取り専用: true
      最大長: 30
      参照タイプ。 この属性は内部です。
    • 読取り専用: true
      パートナ・アカウントの一意の識別子。 この属性は内部です。
    • Partner Contact Managers
      タイトル: Partner Contact Managers
      パートナ担当者マネージャ値リスト・リソースは、管理ロール内のパートナ担当者のリストを表示するために使用されます。
    • Partner Types
      タイトル: Partner Types
      パートナ・タイプ・リソースは、パートナのタイプを表示、作成および削除するために使用されます。 パートナ・タイプ・レコードを使用すると、パートナが実行するビジネスのタイプに基づいてパートナ取引先を分類できます。 たとえば、パートナは再販業者または販売代理店になります。
    • Partner Enrolled Programs
      タイトル: Partner Enrolled Programs
      パートナが登録されているパートナ・プログラムのリストを表示するために、パートナ登録済プログラム値リスト・リソースが使用されます。
    • タイトル: Level
      最大長: 50
      パートナ・レベル・コード。
    • タイトル: Level
      読取り専用: true
      最大長: 80
      パートナ・レベルの意味。
    • タイトル: Status
      読取り専用: true
      最大長: 80
      パートナ・ステータス内容。
    • タイトル: Type
      読取り専用: true
      パートナ・タイプの連結リスト。
    • タイトル: Party ID
      読取り専用: true
      パーティの一意識別子
    • タイトル: Name
      読取り専用: true
      最大長: 360
      パートナの名前。
    • タイトル: Partner Name
      読取り専用: true
      最大長: 900
      パートナの一意の名前。
    • タイトル: Postal Code
      読取り専用: true
      最大長: 60
      パートナ住所の郵便番号。
    • パートナを選択できるかどうかを示します。 この属性は内部です。
    • タイトル: State
      読取り専用: true
      最大長: 60
      パートナ住所の都道府県。
    • タイトル: Status
      最大長: 50
      パートナ・ステータス・コード。
    • タイトル: Territory Code
      読取り専用: true
      最大長: 2
      テリトリ・コード。
    • タイトル: Country
      読取り専用: true
      最大長: 80
      テリトリ短縮名。
    ネストされたスキーマ : パートナ担当者マネージャ
    タイプ: array
    タイトル: Partner Contact Managers
    パートナ担当者マネージャ値リスト・リソースは、管理ロール内のパートナ担当者のリストを表示するために使用されます。
    ソースを表示
    ネストされたスキーマ : パートナ・タイプ
    タイプ: array
    タイトル: Partner Types
    パートナ・タイプ・リソースは、パートナのタイプを表示、作成および削除するために使用されます。 パートナ・タイプ・レコードを使用すると、パートナが実行するビジネスのタイプに基づいてパートナ取引先を分類できます。 たとえば、パートナは再販業者または販売代理店になります。
    ソースを表示
    ネストされたスキーマ : パートナ登録済プログラム
    タイプ: array
    タイトル: Partner Enrolled Programs
    パートナが登録されているパートナ・プログラムのリストを表示するために、パートナ登録済プログラム値リスト・リソースが使用されます。
    ソースを表示
    ネストされたスキーマ : partnersLOV-partnerContactManagersLOV-item-response
    タイプ: object
    ソースを表示
    • 読取り専用: true
      デフォルト値: HZ_PARTIES
      添付エンティティの名前。 この属性は内部です。
    • 読取り専用: true
      子ロールの一意の識別子。 この属性は内部です。
    • 読取り専用: true
      非正規化レベル。 この属性は内部です。
    • 読取り専用: true
      非正規化マネージャID。 この属性は内部です。
    • タイトル: Effective End Date
      読取り専用: true
      マネージャのロールが終了する日付。 この属性は内部です。
    • タイトル: Effective Start Date
      読取り専用: true
      マネージャのロールが開始する日付。 この属性は内部です。
    • タイトル: To Date
      読取り専用: true
      レコードが終了する日付。 この属性は内部です。
    • タイトル: Tree Code
      読取り専用: true
      最大長: 30
      ツリー・コード。 この属性は内部です。
    • タイトル: Tree Structure Code
      読取り専用: true
      最大長: 30
      ツリー構造コード。 この属性は内部です。
    • タイトル: Tree Version ID
      読取り専用: true
      最大長: 32
      ツリー・バージョンの一意の識別子。 この属性は内部です。
    • タイトル: Group ID
      読取り専用: true
      グループの一意の識別子。 この属性は内部です。
    • 読取り専用: true
      グループ・メンバーの一意の識別子。
    • 読取り専用: true
      最大長: 240
      階層タイプ。 この属性は内部です。
    • 読取り専用: true
      イメージのURL。 この属性は内部です。
    • Links
    • タイトル: Manager
      読取り専用: true
      マネージャの名前。
    • タイトル: Organization
      読取り専用: true
      最大長: 240
      パートナ担当者マネージャの名前。 この属性は内部です。
    • 読取り専用: true
      オブジェクト・バージョン番号。 この属性は内部です。
    • 読取り専用: true
      組織の一意の識別子。 この属性は内部です。
    • 読取り専用: true
      親組織の一意の識別子。 この属性は内部です。
    • 読取り専用: true
      親リソースの一意の識別子。 この属性は内部です。
    • 読取り専用: true
      パートナ・ロール関連の一意の識別子。 この属性は内部です。
    • タイトル: Party ID
      読取り専用: true
      パートナ担当者に関連付けられたパーティの一意の識別子。
    • タイトル: Name
      読取り専用: true
      最大長: 360
      パートナ担当者に関連付けられたパーティの名前。
    • タイトル: Type
      読取り専用: true
      最大長: 30
      パーティ・タイプ。 この属性は内部です。
    • タイトル: First Name
      読取り専用: true
      最大長: 150
      個人の名。 この属性は内部です。
    • タイトル: Last Name
      読取り専用: true
      最大長: 150
      個人の姓。 この属性は内部です。
    • 読取り専用: true
      リソースの一意の識別子。 この属性は内部です。
    • タイトル: Name
      読取り専用: true
      最大長: 360
      リソース名。 この属性は内部です。
    • 読取り専用: true
      最大長: 30
      パートナ担当者のロールを示すコード。
    • 読取り専用: true
      パートナ担当者ロールの一意の識別子。
    • タイトル: Role Name
      読取り専用: true
      最大長: 60
      パートナ担当者ロールの名前。
    • 読取り専用: true
      関連ロールの一意の識別子。 この属性は内部です。
    • 読取り専用: true
      ロールresource.This属性の一意の識別子は内部です。
    • 読取り専用: true
      最大長: 30
      ロール・リソース・タイプ。 この属性は内部です。
    • タイトル: From Date
      読取り専用: true
      レコードが開始する日付。 この属性は内部です。
    • システム有効日。 この属性は内部です。
    • 読取り専用: true
      最大長: 30
      ツリー・コード。 この属性は内部です。
    • タイトル: Effective End Date
      読取り専用: true
      有効終了日。 この属性は内部です。
    • タイトル: Effective Start Date
      読取り専用: true
      有効開始日。 この属性は内部です。
    • 読取り専用: true
      最大長: 30
      ツリー・ステータス。 この属性は内部です。
    • 読取り専用: true
      最大長: 30
      ツリー構造コード。 この属性は内部です。
    • 読取り専用: true
      最大長: 32
      ツリーversion.This属性の一意の識別子は内部です。
    ネストされたスキーマ : partnersLOV-partnerDimensionsLOV-item-response
    タイプ: object
    ソースを表示
    ネストされたスキーマ : partnersLOV-partnerEnrolledProgramsLOV-item-response
    タイプ: object
    ソースを表示
    • タイトル: Approval Date
      読取り専用: true
      登録が承認された日付。
    • タイトル: Enrollment Number
      読取り専用: true
      最大長: 30
      登録の代替キー識別子。
    • タイトル: Status
      読取り専用: true
      最大長: 30
      ドラフト、待ち状態、承認済、否認済、終了済、更改済など、登録のステータス。
    • タイトル: End Date
      読取り専用: true
      登録が失効する日付。
    • Links
    • 読取り専用: true
      パートナの一意の識別子。
    • タイトル: Program ID
      読取り専用: true
      パートナ・プログラムの一意の識別子。
    • タイトル: Party ID
      読取り専用: true
      パートナ組織のパーティの一意の識別子。
    • タイトル: Organization
      読取り専用: true
      最大長: 360
      パートナ組織の名前。
    • タイトル: Program Enrollment ID
      読取り専用: true
      パートナ・プログラム登録の一意の識別子。
    • タイトル: Program Name
      読取り専用: true
      最大長: 150
      パートナ・プログラムの名前。
    • タイトル: Program Number
      読取り専用: true
      最大長: 30
      プログラムの代替キー識別子。
    • 読取り専用: true
      最大長: 30
      プログラム期間の失効前に表示されるメッセージ。
    • タイトル: Program Type
      読取り専用: true
      最大長: 30
      再販業者や市場参入など、様々なパートナ・プログラムのタイプ。
    • 読取り専用: true
      プログラムに関連付けられたレコード・セット。
    • タイトル: Remaining Days
      読取り専用: true
      登録が失効するまでの残り日数。
    • タイトル: Start Date
      読取り専用: true
      プログラム登録が開始する日付。
    • タイトル: Program Status Code
      読取り専用: true
      最大長: 30
      登録のステータスを示すコード。
    • タイトル: Submission Date
      読取り専用: true
      登録が発行された日付。
    「トップに戻る」