機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アカウント
  4. 補助分類

すべての顧客分類の取得

get

/crmRestApi/resources/11.13.18.05/accounts/{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; 顧客分類割当の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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;競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreatedByModule; string; 顧客分類レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。
    • CreationDate; string;レコードが作成された日付。
    • EndDateActive; string;分類コードが無効になる日付。
    • IsAuxClassificationFlag; boolean。分類カテゴリがユーザー定義のグループ分類カテゴリであるかどうかを示します。 デフォルト値はfalseです。
    • IsIndustryFlag; boolean。分類カテゴリが産業グループ分類カテゴリであるかどうかを示します。 デフォルト値はfalseです。
    • IsOrgTypeFlag; boolean。分類カテゴリが組織タイプ分類カテゴリであるかどうかを示します。 デフォルト値はfalseです。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • PartyId; integer;分類が関連付けられているアカウント、担当者または世帯の一意の識別子。
    • PartyNumber; string;分類が関連付けられているアカウント、担当者または世帯の一意の代替識別子。 非アクティブなレコードは更新できません。
    • PartySourceSystem; string;分類が関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。
    • PartySourceSystemReferenceValue; string;分類が関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子。
    • PartyType; string; アカウント、担当者、世帯など、パーティのタイプ。
    • PrimaryFlag; boolean。顧客分類がプライマリ分類かどうかを示します。 デフォルト値はfalseです。
    • SourceSystem; string; 顧客分類のインポート元となる外部ソース・システムの名前。 値は、「設定およびメンテナンス」作業領域の取引先コミュニティ・ソース・システムの管理タスクで構成されます。
    • SourceSystemReferenceValue; string;外部ソースにおける顧客分類の一意の識別子。
    • 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-CustomerClassification
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accounts-CustomerClassification-item-response
タイプ: object
ソースを表示
  • タイトル: Classification Category
    最大長: 30
    分類カテゴリの名前。
  • タイトル: Classification Code
    最大長: 30
    分類カテゴリに対応する有効な分類コード。
  • タイトル: Code Assignment ID
    読取り専用: true
    顧客分類割当の一意の識別子。
  • 読取り専用: true
    デフォルト値: 0
    競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Created by Module
    最大長: 30
    顧客分類レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: End Date
    分類コードが無効になった日付。
  • タイトル: Auxiliary Classification Status
    読取り専用: true
    分類カテゴリがユーザー定義グループ分類カテゴリかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Industry Type Status
    読取り専用: true
    分類カテゴリが産業グループ分類カテゴリであるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Organization Type Status
    読取り専用: true
    分類カテゴリが組織タイプ分類カテゴリかどうかを示します。 デフォルト値はfalseです。
  • タイトル: 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
    顧客分類がプライマリ分類かどうかを示します。 デフォルト値はfalseです。
  • タイトル: Source System
    顧客分類のインポート元となる外部ソース・システムの名前。 値は、「設定およびメンテナンス」作業領域の取引先コミュニティ・ソース・システムの管理タスクで構成されます。
  • タイトル: Source System Reference Value
    外部ソースの顧客分類の一意の識別子。
  • タイトル: Start Date
    顧客分類が作成された日付。
  • タイトル: Status
    最大長: 1
    デフォルト値: A
    コード割当がアクティブか非アクティブかを示します。 コード割当は、値がAの場合はアクティブで、値がIの場合は非アクティブです。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての顧客分類を取得する方法を示しています。

レスポンス本文の例

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

{
  "items": [
    {
      "PartyId": 300100091050713,
      "PartyNumber": "CDRM_517466",
      "PartySourceSystem": null,
      "PartySourceSystemReferenceValue": null,
      "CodeAssignmentId": 300100091102292,
      "ClassCategory": "ORGANIZATION_TYPE",
      "ClassCode": "A: Commercial",
      "StartDateActive": "2016-07-27",
      "EndDateActive": "4712-12-31",
      "CreatedBy": "SALES_ADMIN",
      "CreatedByModule": "HZ_WS",
      "CreationDate": "2016-07-27T02:30:26-07:00",
      "LastUpdateDate": "2016-07-27T02:30:26-07:00",
      "LastUpdateLogin": "3882C39353CC51E4E053B80AF40A2F43",
      "LastUpdatedBy": "SALES_ADMIN",
      "Status": "A",
      "PrimaryFlag": true,
      "IsAuxClassificationFlag": "false",
      "IsOrgTypeFlag": "true",
      "IsIndustryFlag": "false",
      "PartyType": "ORGANIZATION",
      "SourceSystem": null,
      "SourceSystemReferenceValue": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466/child/CustomerClassification/300100091102292",
          "name": "CustomerClassification",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C547970654964787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000C78"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466/child/CustomerClassification/300100091102292",
          "name": "CustomerClassification",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466",
          "name": "accounts",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_517466/child/CustomerClassification",
      "name": "CustomerClassification",
      "kind": "collection"
    }
  ]
}
「トップに戻る」