機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. ハブ組織
  4. 顧客分類

すべての顧客分類の取得

get

/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/CustomerClassification

リクエスト

パス・パラメータ
  • 組織パーティの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • PrimaryKey : 主キー情報を持つ顧客分類を検索します。
      ファインダ変数:
      • CodeAssignmentId; integer; 顧客分類割当の一意の識別子。
    • SourceSystemReferenceAltKey : 主キー情報を持つ顧客分類を検索します。
      ファインダ変数:
      • SourceSystem; string;ソース・システムの名前。
      • SourceSystemReferenceValue; string; 関連付けられたアカウントを識別するために必要なソース・システム参照値。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ClassCategory; string;分類カテゴリの名前。
    • ClassCode; string;分類カテゴリに対応する有効な分類コード。
    • CodeAssignmentId; integer; 顧客分類割当の一意の識別子。
    • ConflictId; integer;競合の一意の識別子。
    • CreatedBy; string;レコードを作成したユーザーの名前。
    • CreatedByModule; string; レコードを作成したアプリケーションまたはモジュール。 すべてのwebサービス・ベースの作成では、デフォルト値はHZ_WSです。
    • CreationDate; string; レコードが作成された日時を示します。
    • EndDateActive; string;分類コードが無効になる日付。
    • IsAuxClassificationFlag; boolean。分類カテゴリがカスタム・グループ分類カテゴリであるかどうかを示します。
    • IsIndustryFlag; boolean。分類カテゴリが産業グループ分類カテゴリであるかどうかを示します。
    • IsOrgTypeFlag; boolean。分類カテゴリが組織タイプ分類カテゴリであるかどうかを示します。
    • LastUpdateDate; string; レコードが最後に更新された日時を示します。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーに関連付けられたセッション・ログインを示します。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • PartyId; integer;分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の一意の識別子。
    • PartyNumber; string;分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の一意の代替識別子。 非アクティブなレコードは更新できません。
    • PartySourceSystem; string;分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。
    • PartySourceSystemReferenceValue; string;分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子。
    • PartyType; string; アカウント、担当者、世帯など、パーティのタイプを示します。
    • PrimaryFlag; boolean;現在のコードがプライマリ分類コードかどうかを示すインジケータ。
    • SourceSystem; string;システム設定の一部として管理者が定義する、コードで示されるクラス・カテゴリの外部ソース・システムの名前。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
    • SourceSystemReferenceValue; string;外部ソースからのクラス・カテゴリの一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
    • StartDateActive; string;分類が有効になる日付。
    • ステータス、文字列。コード割当がアクティブか非アクティブかを示します。たとえば、アクティブの場合はA、非アクティブの場合はIです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : hubOrganizations-CustomerClassification
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : hubOrganizations-CustomerClassification-item-response
タイプ: object
ソースを表示
  • タイトル: Classification Category
    最大長: 30
    分類カテゴリの名前。
  • タイトル: Classification Code
    最大長: 30
    分類カテゴリに対応する有効な分類コード。
  • タイトル: Code Assignment ID
    読取り専用: true
    顧客分類割当の一意の識別子。
  • 読取り専用: true
    デフォルト値: 0
    競合の一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザーの名前。
  • タイトル: Created by Module
    最大長: 30
    レコードを作成したアプリケーションまたはモジュール。 すべてのwebサービス・ベースの作成では、デフォルト値はHZ_WSです。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時を示します。
  • タイトル: End Date
    分類コードが無効になった日付。
  • タイトル: Auxiliary Classification Status
    読取り専用: true
    分類カテゴリがカスタム・グループ分類カテゴリかどうかを示します。
  • タイトル: Industry Type Status
    読取り専用: true
    分類カテゴリが産業グループ分類カテゴリであるかどうかを示します。
  • タイトル: Organization Type Status
    読取り専用: true
    分類カテゴリが組織タイプ分類カテゴリかどうかを示します。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時を示します。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーに関連付けられたセッション・ログインを示します。
  • Links
  • タイトル: Party ID
    分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の一意の識別子。
  • タイトル: Party Number
    最大長: 30
    分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の一意の代替識別子です。 非アクティブなレコードは更新できません。
  • タイトル: Party Source System
    分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。
  • タイトル: Party Source System Reference Value
    分類カテゴリおよび分類コードが関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子です。
  • タイトル: Party Type
    読取り専用: true
    最大長: 30
    アカウント、担当者または世帯など、パーティのタイプを示します。
  • タイトル: Primary
    最大長: 1
    デフォルト値: false
    現在のコードがプライマリ分類コードかどうかを示すインジケータ。
  • タイトル: Source System
    システム設定の一部として管理者が定義する、コードで示される区分カテゴリの外部ソース・システムの名前。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
  • タイトル: Source System Reference Value
    外部ソースからの区分カテゴリの一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、クラス・カテゴリを識別するための外部キーとして使用されます。
  • タイトル: Start Date
    分類が有効になる日付。
  • タイトル: Status
    最大長: 1
    デフォルト値: A
    コード割当がアクティブか非アクティブかを示します。たとえば、アクティブの場合はA、非アクティブの場合はIです。
「トップに戻る」