機械翻訳について

すべてのビジネス・ユニットの取得

get

/crmRestApi/resources/11.13.18.05/crmBusinessUnits

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
      ファインダ変数:
    • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
    • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
      • BUId; integer;ビジネス・ユニットの一意の識別子。
      • BUName; string;ビジネス・ユニットの名前。
      • BusinessUnitId; integer;ビジネス・ユニットの一意の識別子。
      • DefaultBUFlag; boolean。現在のビジネス・ユニットがユーザーのデフォルト・ビジネス・ユニットに記録されるかどうかを示します。 この値はtrueおよびfalseです。
      • 名前、文字列、ビジネス・ユニットの名前。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : crmBusinessUnits
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : crmBusinessUnits-item-response
    タイプ: object
    ソースを表示
    • Assessment Templates
      タイトル: Assessment Templates
      査定テンプレート・リソースは、査定テンプレートの表示に使用されます。 アセスメントに関連付けられたテンプレートが格納されます。
    • 読取り専用: true
      ビジネス・ユニットの一意の識別子。
    • 読取り専用: true
      ビジネス・ユニットの名前。
    • 読取り専用: true
      ビジネス・ユニットの一意の識別子。
    • 読取り専用: true
      現在のビジネス・ユニットがログイン・ユーザーのデフォルト・ビジネス・ユニットであるかどうかを示します。 この値はtrueおよびfalseです。
    • Common Set Id Lookups
      タイトル: Common Set Id Lookups
      共通セットID参照リソースは、セットID対応参照タイプの参照値を表示するために使用されます。
    • Links
    • 読取り専用: true
      ビジネス・ユニットの名前。
    • Opportunity Status Values
      タイトル: Opportunity Status Values
      商談ステータス値のリソースを使用して、商談ステータス値を表示します。 構成可能な設定データは、販売用途に特化して定義されます。
    • Sales Methods
      タイトル: Sales Methods
      販売メソッド・リソースは、販売プロセスで使用されるアプローチを表示するために使用されます。 メソッドには、商談の見込み、売上予想、クローズなど、セールス・プロセスに関連付けられたすべてのステージを含めることができます。
    ネストされたスキーマ : アセスメント・テンプレート
    タイプ: array
    タイトル: Assessment Templates
    査定テンプレート・リソースは、査定テンプレートの表示に使用されます。 アセスメントに関連付けられたテンプレートが格納されます。
    ソースを表示
    ネストされたスキーマ : 共通セットID参照
    タイプ: array
    タイトル: Common Set Id Lookups
    共通セットID参照リソースは、セットID対応参照タイプの参照値を表示するために使用されます。
    ソースを表示
    ネストされたスキーマ : 商談ステータス値
    タイプ: array
    タイトル: Opportunity Status Values
    商談ステータス値のリソースを使用して、商談ステータス値を表示します。 構成可能な設定データは、販売用途に特化して定義されます。
    ソースを表示
    ネストされたスキーマ : 販売メソッド
    タイプ: array
    タイトル: Sales Methods
    販売メソッド・リソースは、販売プロセスで使用されるアプローチを表示するために使用されます。 メソッドには、商談の見込み、売上予想、クローズなど、セールス・プロセスに関連付けられたすべてのステージを含めることができます。
    ソースを表示
    ネストされたスキーマ : crmBusinessUnits-assessmentTemplates-item-response
    タイプ: object
    ソースを表示
    • 最大長: 50
      査定済ビジネス・オブジェクトのタイプを示すコード。
    • このアセスメントのソースとして機能したアセスメント・テンプレートの一意の識別子。
    • Links
    • タイトル: Name
      最大長: 100
      アセスメント・テンプレートの名前。
    • ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
    ネストされたスキーマ : crmBusinessUnits-fndCommonSetIdLookups-item-response
    タイプ: object
    ソースを表示
    ネストされたスキーマ : crmBusinessUnits-optyStatus-item-response
    タイプ: object
    ソースを表示
    • 読取り専用: true
      これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
    • 読取り専用: true
      ビジネス・ユニットの一意の識別子。
    • 読取り専用: true
      これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
    • デフォルト値: 0
      この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
    • 読取り専用: true
      最大長: 64
      レコードを作成したユーザー。
    • 読取り専用: true
      レコードが作成された日時。
    • タイトル: Description
      最大長: 240
      参照タイプの摘要。
    • タイトル: Display Sequence
      ステータス・コードが表示される順序。
    • タイトル: Active
      最大長: 1
      参照タイプが使用可能かどうかを示します。
    • 参照タイプが使用不可である日付。
    • 読取り専用: true
      レコードが最後に更新された日時。
    • 読取り専用: true
      最大長: 64
      レコードを最後に更新したユーザー。
    • 読取り専用: true
      最大長: 32
      レコードを最後に更新したユーザーのログイン。
    • Links
    • タイトル: Status Category
      最大長: 30
      参照値に関連付けられた参照カテゴリ。
    • タイトル: Status Code
      最大長: 30
      参照値に関連付けられた参照コード。
    • タイトル: Status
      最大長: 30
      デフォルト値: OPTY_STATUS
      参照値に関連付けられた参照タイプ。
    • 参照値の一意の識別子。
    • タイトル: Status
      最大長: 80
      参照値の翻訳済値。
    • 読取り専用: true
      オブジェクト・バージョン番号は、オプティミスティック・ロックを実装します。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • タイトル: Set Code
      読取り専用: true
      最大長: 30
      販売ステータス参照値の参照データ・セット・コード。
    • タイトル: Set
      販売ステータス参照値のリファレンス・データの一意の識別子。
    • 読取り専用: true
      これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
    • 読取り専用: true
      販売ステータス参照値のリファレンス・データの一意の識別子。
    • タイトル: Set Name
      読取り専用: true
      最大長: 80
      販売ステータス参照値の参照データ・セット識別子の名前。
    • 参照タイプがアクティブになる日付。
    • 行が最後に更新された日時。 別のモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。
    ネストされたスキーマ : crmBusinessUnits-salesMethods-item-response
    タイプ: object
    ソースを表示
    • 読取り専用: true
      ビジネス・ユニットの一意の識別子。
    • デフォルト値: 0
      この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
    • 読取り専用: true
      最大長: 64
      レコードを作成したユーザー。
    • 読取り専用: true
      レコードが作成された日時。
    • タイトル: Default Sales Method
      読取り専用: true
      現在の販売メソッドがユーザーのデフォルト・ビジネス・ユニットに記録されるかどうかを示します。 この値はtrueおよびfalseです。
    • タイトル: Default Sales Method for Expansion
      読取り専用: true
      拡張商談のデフォルトの販売メソッド。
    • タイトル: Default Sales Method for Renewal
      読取り専用: true
      更改商談のデフォルト販売メソッド。
    • タイトル: Disabled
      最大長: 2
      デフォルト値: false
      販売メソッドが削除されたかどうかを示します。
    • タイトル: Description
      最大長: 255
      販売メソッドの摘要。
    • 読取り専用: true
      レコードが最後に更新された日時。
    • 読取り専用: true
      最大長: 64
      レコードを最後に更新したユーザー。
    • 読取り専用: true
      最大長: 32
      レコードを最後に更新したユーザーのログイン。
    • Links
    • タイトル: Name
      最大長: 50
      販売メソッドの名前。
    • タイトル: Opportunity Type
      最大長: 30
      商談のタイプが新規、更新または拡張のいずれであるかを示します。
    • タイトル: Close Window
      販売メソッド商談クローズ・ウィンドウ。
    • タイトル: Revenue Line-Set Enabled
      最大長: 1
      デフォルト値: false
      この販売メソッドの使用時に収益明細セットを使用可能にするかどうかを示します。
    • 販売メソッドの一意の識別子。
    • タイトル: Sales Method Number
      最大長: 64
      データ移行の代替キーとして作成されたGUIDベースの列。
    • Sales Stages
      タイトル: Sales Stages
      営業ステージ・リソースは、営業ステージの表示に使用されます。 特定のセールス・メソッドのセールス・ステージでは、セールス・サイクルにおける商談の進捗状況について説明します。
    • 読取り専用: true
      販売メソッド参照値のリファレンス・データ・セットの一意の識別子。
    • タイトル: Set
      読取り専用: true
      最大長: 80
      販売メソッド参照データ・セット識別子の名前。
    • 行が最後に更新された日時。 異なるモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。
    ネストされたスキーマ : 営業ステージ
    タイプ: array
    タイトル: Sales Stages
    営業ステージ・リソースは、営業ステージの表示に使用されます。 特定のセールス・メソッドのセールス・ステージでは、セールス・サイクルにおける商談の進捗状況について説明します。
    ソースを表示
    ネストされたスキーマ : crmBusinessUnits-salesMethods-SalesStage-item-response
    タイプ: object
    ソースを表示
    • 最大長: 255
      デフォルト値: MOO_STG_B
      添付エンティティの名前。 デフォルト値はMOO_STG_Bです。
    • Attachments
      タイトル: Attachments
      添付リソースは、添付の表示、作成および更新に使用されます。
    • タイトル: Duration
      営業ステージの平均日数。
    • デフォルト値: 0
      この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
    • 読取り専用: true
      最大長: 64
      レコードを作成したユーザー。
    • 読取り専用: true
      レコードが作成された日時。
    • 最大長: 2
      デフォルト値: false
      営業ステージが削除されたかどうかを示します。
    • タイトル: Description
      最大長: 255
      営業ステージの摘要。
    • 読取り専用: true
      レコードが最後に更新された日時。
    • 読取り専用: true
      最大長: 64
      レコードを最後に更新したユーザー。
    • 読取り専用: true
      最大長: 32
      レコードを最後に更新したユーザーのログイン。
    • Links
    • タイトル: Stalled Deal Limit
      セールス・ステージの最大日数。
    • タイトル: Name
      最大長: 50
      セールス・ステージの名前。
    • タイトル: Phase
      最大長: 30
      デフォルト値: "B - Working the Deal"
      営業ステージのフェーズ・コード。
    • タイトル: Quota Factor
      営業ステージの目標ファクタ。
    • タイトル: Win Probability
      デフォルト値: 0
      営業ステージの推奨受注確度。
    • タイトル: Sales Method ID
      営業ステージが属する販売メソッドの一意の識別子。
    • Sales Stage Process Steps
      タイトル: Sales Stage Process Steps
      営業ステージ・プロセス・ステップ・リソースは、営業ステージ・プロセス・ステップの表示に使用されます。 特定の営業ステージに関連付けられた一連の推奨ステップであり、営業担当に商談ライフサイクルをガイドするために使用されます。
    • 営業ステージ・セットの一意の識別子。 値は販売メソッド・セット識別子から取得されます。
    • 最大長: 64
      データ移行の代替キーの一部として作成されたGUIDベースの列。
    • タイトル: Status
      最大長: 30
      デフォルト値: "Open"
      営業ステージのステータス。
    • 営業ステージの一意の識別子。
    • タイトル: Order
      販売メソッド内の営業ステージ・オーダーです。
    • 行が最後に更新された日時。 異なるモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。
    ネストされたスキーマ : 添付ファイル
    タイプ: array
    タイトル: Attachments
    添付リソースは、添付の表示、作成および更新に使用されます。
    ソースを表示
    ネストされたスキーマ : セールス・ステージ・プロセス・ステップ
    タイプ: array
    タイトル: Sales Stage Process Steps
    営業ステージ・プロセス・ステップ・リソースは、営業ステージ・プロセス・ステップの表示に使用されます。 特定の営業ステージに関連付けられた一連の推奨ステップであり、営業担当に商談ライフサイクルをガイドするために使用されます。
    ソースを表示
    ネストされたスキーマ : crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response
    タイプ: object
    ソースを表示
    ネストされたスキーマ : crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response
    タイプ: object
    ソースを表示
    「トップに戻る」