機械翻訳について

すべての商談ステータス値の取得

get

/crmRestApi/resources/11.13.18.05/optyStatusesLOV

リクエスト

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

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

    • LookupValuesAltKey : 代替キーを持つ販売ステータス・レコードを検索します。
      ファインダ変数:
      • LookupCode; string;参照値に関連付けられた参照コード。
      • LookupType; string; 参照値に関連付けられた参照タイプ。
      • SetCode; string.
      • SetId; integer;参照値の参照データ・セットの識別子。
    • PrimaryKey : 指定された主キーを持つ販売ステータス・レコードを検索します。
      ファインダ変数:
      • LookupValuesId; integer; 参照値の一意の識別子。
    • StatusByBUIdFinder : 参照タイプ、セット識別子、使用可能フラグおよびビジネス・ユニット識別子別に販売ステータス・レコードを検索します。
      ファインダ変数:
      • BindBUId; integer;ビジネス・ユニットの一意の識別子。
      • BindEnabledFlag; string; 参照タイプが有効かどうかを示します。
      • BindLookupType; string; 参照値に関連付けられた参照タイプ。
      • BindSetId; integer;参照値の参照データ・セットの識別子。
    • StatusFinder : 参照タイプ、使用可能フラグおよびセット識別子別に、使用可能な販売ステータス・レコードを検索します。
      ファインダ変数:
      • BindEnabledFlag; string; 参照タイプが有効かどうかを示します。
      • BindLookupType; string; 参照値に関連付けられた参照タイプ。
      • BindSetId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AppliesToLOVSwitcher; string; これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
    • BUId; integer;ビジネス・ユニットの一意の識別子。
    • CategoryLOVSwitcher; string; これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
    • ConflictId; integer; この値により、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性が保証されます。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • Description; string;参照タイプの摘要。
    • DisplaySequence; integer;ステータス・コードが表示される順序。
    • EnabledFlag; boolean。参照タイプが有効かどうかを示します。
    • EndDateActive; string; 参照タイプが無効になっている日付。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • LookupCategory; string; 参照値に関連付けられた参照カテゴリ。
    • LookupCode; string; 参照値に関連付けられた参照コード。
    • LookupType; string; 参照値に関連付けられた参照タイプ。
    • LookupValuesId; integer; 参照値の一意の識別子。
    • 内容;文字列;参照値の翻訳値。
    • ObjectVersionNumber; integer;オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • SetCode; string;売上ステータス参照値の参照データ・セット・コード。
    • SetId; integer; 販売ステータス参照値の参照データ・セット識別子。
    • SetIdLOVSwitcher; string; これは、ピッカーの表示時にLOVを区別するためにUIで使用されます。
    • SetIdP; integer; 販売ステータス参照値の参照データ・セット識別子。
    • SetName; string;売上ステータス参照値の参照データ・セット識別子名。
    • StartDateActive; string; 参照タイプがアクティブになる日付。
    • UserLastUpdateDate; string; thr行が最後に更新された日時。 別のモバイル・データベースやサーバーなどの別のデータベースで更新が行われた場合、この値はLAST_UPDATE_DATEとは異なります。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : optyStatusesLOV
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : optyStatusesLOV-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とは異なります。
「トップに戻る」