機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 競合取引先

すべての競合取引先を取得

get

/crmRestApi/resources/11.13.18.05/competitorAccounts

リクエスト

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

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

    • ActiveCompetitorsFinder : アクティブな競合相手を検索します。
      ファインダ変数:
      • PartyNumber; string;競合相手の一意の公開識別子。
      • PartyUniqueName; string;競合相手の一意の名前。
      • ThreatLevelCode; string;競合相手の脅威のレベル。
    • PartyIdAltKey : 指定したパーティ識別子を持つ競合相手を検索します。
      ファインダ変数:
      • PartyId; integer;競合相手レコードの主キー。
    • PartyNumberAltKeyFinder : 指定された公開識別子を持つ競合相手を検索します。
      ファインダ変数:
      • PartyNumber; string;競合相手の一意の公開識別子。
    • PrimaryKey : 指定した主キーを持つ競合相手を検索します。
      ファインダ変数:
      • PartyId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AnnualRevenueAmount; number;競合会社の年間売上を示します。
    • CeoName; string;組織の最高経営責任者の名前。
    • 国;文字列;競合相手の自国。
    • CreatedBy; string; 競合相手レコードを作成したユーザー。
    • CreatedByModule; string; 競合相手レコードを作成したモジュール。
    • CreationDate; string;レコードが作成された日付。
    • CurrencyCode; string;年間収益額の通貨コード。
    • DUNSNumber; string; 自由形式のテキスト形式のDUNS番号。 値は9桁の数字に制限されません。
    • DbRating; string;ダン・アンド・ブラッド・ストリート信用格付け。
    • DeletetFlag; boolean;競合相手を削除できるかどうかを示します。
    • FiscalYearendMonth; string; 組織の会計年度の最終月。 受け入れられる値のリストは、参照タイプMONTHで定義されます。
    • IncorpYear; integer; 組織が業務を開始した年。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 競合相手レコードを最後に更新したユーザー。
    • LineOfBusiness; string; このサイトで実行されるビジネス・アクティビティのタイプ。
    • MinorityOwnedInd; string; 組織が主として少数民族または人種的少数民族によって所有されるかどうかを示します。 値がYの場合、組織は民族少数民族または人種少数民族によって所有されます。 会社は主に民族または人種的少数民族によって所有されています。 デフォルト値はNです。
    • OrganizationName; string;競合会社組織の名前。
    • OrganizationSize;文字列;売上や従業員数などの基準に基づく競合組織の規模。
    • PartyId; integer;競合相手レコードの主キー。
    • PartyName; string;競合会社組織の名前。
    • PartyNumber; string;競合相手の一意の公開識別子。
    • PartyType; string;パーティ・レコードのタイプ。
    • PublicPrivateOwnershipFlag; boolean。組織がパブリックに所有されているか、プライベートに所有されているかを示します。 値がYの場合、組織は個人所有組織です。 デフォルト値はNです。
    • SICCode; string;競合相手のStandard Industry Classification (SIC)コード。
    • SmallBusInd; string; 組織が中小企業とみなされるかどうかを示します。 値がYの場合、組織は中小企業とみなされます。 デフォルト値はNです。
    • StatusCode; string;競合ステータス - アクティブまたは非アクティブ。
    • StockSymbol; string; 株式取引所にリストされている組織の株式記号。
    • ThreatLevelCode; string;ディールの当該組織との競合時に競合相手が提示する脅威のレベル。
    • TradingPartnerIdentifier; string; FSIO関連の取引先コード。
    • URL; string;競合相手に関する情報を含むUniform Resource Locatorまたはwebサイト。
    • UniqueNameSuffix; string; 属性PartyUniqueNameの生成に使用されるサフィクス。 サフィクスは、PartyUniqueNameを生成するためにOrganizationName属性にリンクされます。
    • UpdateFlag; boolean;レコードを更新できるかどうかを示します。
    • YearEstablished; integer; 組織が事業活動を開始した年。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : competitorAccounts
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : competitorAccounts-item-response
タイプ: object
ソースを表示
  • タイトル: Annual Revenue Amount
    競合会社の年間売上を示します。
  • Attachments
    タイトル: Attachments
    添付リソースは、添付の表示、作成および更新に使用されます。
  • タイトル: Chief Executive Name
    最大長: 240
    組織の最高経営責任者の名前。
  • タイトル: Country
    最大長: 2
    競合相手の自国。
  • 読取り専用: true
    最大長: 64
    競合会社レコードを作成したユーザー。
  • 最大長: 30
    デフォルト値: SALES
    競合レコードを作成したモジュール。
  • 読取り専用: true
    レコードが作成された日付。
  • タイトル: Currency
    最大長: 15
    年間収益金額の通貨コード。
  • タイトル: D&B Credit Rating
    最大長: 5
    ダン・アンド・ブラッド・ストリート信用格付け。
  • 読取り専用: true
    競合相手を削除できるかどうかを示します。
  • タイトル: D-U-N-S Number
    最大長: 30
    自由形式のテキスト形式のDUNS番号。 値は9桁の数字に制限されません。
  • タイトル: Fiscal Year End Month
    最大長: 30
    組織の会計年度の最終月。 受け入れられる値のリストは、参照タイプMONTHで定義されます。
  • タイトル: Year Incorporated
    組織が事業活動を開始した年。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    競合会社レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • タイトル: Line of Business
    最大長: 240
    このサイトで実行されるビジネス・アクティビティのタイプ。
  • Links
  • タイトル: Minority-Owned Indicator
    最大長: 30
    組織が主に民族少数民族または人種少数民族によって所有されるかどうかを示します。 値がYの場合、組織は民族少数民族または人種少数民族によって所有されます。 会社は主に民族または人種的少数民族によって所有されています。 デフォルト値はNです。
  • タイトル: Organization Name
    最大長: 360
    競合会社組織の名前。
  • タイトル: Organization Size
    最大長: 30
    収益や従業員数などの基準に基づく競合組織の規模。
  • 競合会社レコードの主キー。
  • タイトル: Name
    最大長: 360
    競合会社組織の名前。
  • タイトル: Registry ID
    最大長: 30
    競合相手の一意の公開識別子。
  • タイトル: Party Type
    最大長: 30
    デフォルト値: ORGANIZATION
    パーティ・レコードのタイプ。
  • タイトル: Private Ownership
    最大長: 1
    組織が公開または非公開のどちらであるかを示します。 値がYの場合、組織は個人所有組織です。 デフォルト値はNです。
  • タイトル: SIC Code
    最大長: 30
    競合相手のStandard Industry Classification (SIC)コード。
  • タイトル: Small Business Indicator
    最大長: 30
    組織が中小企業とみなされるかどうかを示します。 値がYの場合、組織は中小企業とみなされます。 デフォルト値はNです。
  • タイトル: Status
    最大長: 10
    デフォルト値: ACTIVE
    競合相手のステータス - アクティブまたは非アクティブ。
  • タイトル: Stock Symbol
    最大長: 20
    証券取引所にリストされている組織の株式記号。
  • タイトル: Threat Level
    最大長: 30
    ディールの当該組織との競合時に競合相手が提示する脅威のレベル。
  • 最大長: 30
    FSIO関連の取引先コード。
  • タイトル: Name Suffix
    最大長: 540
    属性PartyUniqueNameの生成に使用されるサフィクス。 サフィクスは、PartyUniqueNameを生成するためにOrganizationName属性にリンクされます。
  • 読取り専用: true
    レコードを更新できるかどうかを示します。
  • タイトル: Primary URL
    最大長: 2000
    競合相手に関する情報を含むUniform Resource Locatorまたはwebサイト。
  • タイトル: Year Established
    組織が事業活動を開始した年。
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : competitorAccounts-Attachment-item-response
タイプ: object
ソースを表示
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての競合相手アカウントを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
         {
            "PartyId": 300100017959625,
            "PartyNumber": "CDRM_9146",
            "PartyName": "ACmpttr172013181841413611PUK",
            "PartyType": "ORGANIZATION",
            "OrganizationName": "ACmpttr172013181841413611PUK",
            "UniqueNameSuffix": null,
            "OrganizationSize": null,
            "SICCode": null,
            "TradingPartnerIdentifier": null,
            "CeoName": null,
            "DbRating": null,
            "DUNSNumber": null,
            "FiscalYearendMonth": null,
            "IncorpYear": null,
            "LineOfBusiness": null,
            "MinorityOwnedInd": null,
            "SmallBusInd": null,
            "StockSymbol": null,
            "YearEstablished": null,
            "PublicPrivateOwnershipFlag": null,
            "AnnualRevenueAmount": null,
            "CurrencyCode": null,
            "StatusCode": "INACTIVE",
            "ThreatLevelCode": "HIGH",
            "URL": null,
            "Country": null,
            "CreatedByModule": "SALES",
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2013-01-07T18:22:34+00:00",
            "UpdateFlag": "false",
            "DeletetFlag": "false",
            "LastUpdateDate": "2015-03-18T22:31:25+00:00",
            "LastUpdateLogin": "119E7E511D369D5AE0531833F40A581A",
            "LastUpdatedBy": "SALES_ADMIN",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100017959625",
                    "name": "competitorAccounts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E00020000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100017959625",
                    "name": "competitorAccounts",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts/300100017959625/child/Attachment",
                    "name": "Attachment",
                    "kind": "collection"
                }
            ]
        },
  .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/competitorAccounts",
            "name": "competitorAccounts",
            "kind": "collection"
        }
    ]
}
「トップに戻る」