すべての営業ステージの取得
get
/crmRestApi/resources/11.13.18.05/salesStagesLOV
リクエスト
問合せパラメータ
- expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 指定した主キーを持つ営業ステージを検索します。
ファインダ変数:- StgId; integer;営業ステージの一意の識別子。
- SalesStageBySalesMethodFinder : 指定された販売メソッド識別子のすべての営業ステージを検索します。
ファインダ変数:- BindSalesMethodId; integer; 営業ステージが属する販売メソッドの一意の識別子。
- SalesStageFinder : 削除されていない営業ステージを検索します。
ファインダ変数: - StgAltKey : 代替キーを持つ営業ステージを検索します。
ファインダ変数:- 名前、文字列、営業ステージの名前。
- SalesMethodId; integer; 営業ステージが属する販売メソッドの一意の識別子。
- StgAltKeyUUID : 販売メソッドおよびステージ番号別に営業ステージを検索します。
ファインダ変数:- SalesMethodId; integer; 営業ステージが属する販売メソッドの一意の識別子。
- StageNumber; string; データ移行の代替キーの一部となるように作成されたGUIDベースの列。
- PrimaryKey : 指定した主キーを持つ営業ステージを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AttachmentEntityName; string;添付エンティティの名前。 デフォルト値はMOO_STG_Bです。
- AverageDaysAtStage; integer;営業ステージの平均日数。
- ConflictId; integer; この値により、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- DeletedFlag; boolean;営業ステージが削除されたかどうかを示します。
- DescriptionText; string;営業ステージの説明。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- MaximumDaysInStage; integer; 営業ステージの最大日数。
- 名前、文字列、営業ステージの名前。
- PhaseCd; string;営業ステージのフェーズ・コード。
- QuotaFactor; number;営業ステージの目標ファクタ。
- RcmndWinProb; number;営業ステージの推奨受注確度。
- SalesMethodId; integer; 営業ステージが属する販売メソッドの一意の識別子。
- StageNumber; string; データ移行の代替キーの一部となるように作成されたGUIDベースの列。
- StageStatusCd; string;営業ステージのステータス。
- StgId; integer;営業ステージの一意の識別子。
- StgOrder; number;販売メソッド内の営業ステージ・オーダー。
- UserLastUpdateDate; string; 行が最後に更新された日時。 別のモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : salesStagesLOV
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : salesStagesLOV-item-response
タイプ:
ソースを表示
object
-
AttachmentEntityName: string
最大長:
255
デフォルト値:MOO_STG_B
添付エンティティの名前。 デフォルト値はMOO_STG_Bです。 -
AverageDaysAtStage: integer (int64)
タイトル:
Duration
営業ステージの平均日数。 -
ConflictId: integer (int64)
デフォルト値:
0
この値によって、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。 -
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日時。 -
DeletedFlag: boolean
最大長:
2
デフォルト値:false
営業ステージが削除されたかどうかを示します。 -
DescriptionText: string
タイトル:
Description
最大長:255
営業ステージの摘要。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MaximumDaysInStage: integer (int64)
タイトル:
Stalled Deal Limit
セールス・ステージの最大日数。 -
Name: string
タイトル:
Name
最大長:50
セールス・ステージの名前。 -
PhaseCd: string
タイトル:
Phase
最大長:30
デフォルト値:"B - Working the Deal"
営業ステージのフェーズ・コード。 -
QuotaFactor: number
タイトル:
Quota Factor
営業ステージの目標ファクタ。 -
RcmndWinProb: number
タイトル:
Win Probability
デフォルト値:0
営業ステージの推奨獲得可能性。 -
SalesMethodId: integer (int64)
タイトル:
Sales Method ID
営業ステージが属する販売メソッドの一意の識別子。 -
SetId: string
営業ステージ・セットの一意の識別子。 値は販売メソッド・セット識別子から取得されます。
-
StageNumber: string
最大長:
64
データ移行の代替キーの一部として作成されたGUIDベースの列。 -
StageStatusCd: string
タイトル:
Status
最大長:30
デフォルト値:"Open"
営業ステージのステータス。 -
StgId: integer (int64)
営業ステージの一意の識別子。
-
StgOrder: number
タイトル:
Order
販売メソッド内の営業ステージ・オーダーです。 -
UserLastUpdateDate: string (date-time)
行が最後に更新された日時。 別のモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。