すべてのwebアクティビティ・ルールを取得
get
/crmRestApi/resources/11.13.18.05/webActivityRules
リクエスト
問合せパラメータ
- 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 : 指定されたwebアクティビティ・ルールIDを持つWebアクティビティ・ルールを検索します。
ファインダ変数:- WebActivityRuleId; integer; Webアクティビティ・ルールの一意の識別子。
- WebActivityRuleNumberRowFinder : 指定されたwebアクティビティ・ルール番号を持つWebアクティビティ・ルールを検索します。
ファインダ変数:- WebActivityRuleNumber; string; Webアクティビティ・ルール番号。
- PrimaryKey : 指定されたwebアクティビティ・ルールIDを持つWebアクティビティ・ルールを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActiveFlag; boolean; webアクティビティ・ルールがアクティブかどうかを示します。
- CreatedBy; string; webアクティビティ・ルールを作成したリソース・ユーザー。
- CreationDate; string; webアクティビティ・ルールが作成された日時。
- 説明;文字列; webアクティビティ・ルールの説明。
- LastUpdateDate; string; webアクティビティ・ルールが最後に更新された日時。
- LastUpdateLogin; string; webアクティビティ・ルールを最後に更新したユーザーに関連付けられたログイン。
- LastUpdatedBy; string; webアクティビティ・ルールを最後に更新したリソース・ユーザー。
- ObjectVersionNumber; integer; webアクティビティ・ルールのオブジェクト・バージョン番号。
- StatusMeaning; string; webアクティビティ・ルールのステータスの意味。
- WebActivityRuleId; integer; Webアクティビティ・ルールの一意の識別子。
- WebActivityRuleName; string; Webアクティビティ・ルールの名前。
- WebActivityRuleNumber; string; Webアクティビティ・ルールの公開一意識別子。
- WebActivityType; string; Webアクティビティ・ルールのWebアクティビティ・タイプ。
- WebActivityTypeMeaning; string; Webアクティビティ・ルールのWebアクティビティ・タイプの意味。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : webActivityRules
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : webActivityRules-item-response
タイプ:
ソースを表示
object
-
ActiveFlag: boolean
タイトル:
Status
最大長:1
webアクティビティ・ルールがアクティブかどうかを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
webアクティビティ・ルールを作成したリソース・ユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
webアクティビティ・ルールが作成された日時。 -
Description: string
タイトル:
Description
最大長:1000
webアクティビティ・ルールの説明。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
webアクティビティ・ルールが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
webアクティビティ・ルールを最後に更新したリソース・ユーザー。 -
LastUpdateLogin: string
タイトル:
Last Updated Login
読取り専用:true
最大長:32
webアクティビティ・ルールを最後に更新したユーザーに関連付けられたログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
webアクティビティ・ルールのオブジェクト・バージョン番号。 -
StatusLookupCode: string
タイトル:
Status
読取り専用:true
最大長:30
webアクティビティ・ルールのステータスの参照コード。 -
StatusMeaning: string
タイトル:
Status
読取り専用:true
最大長:80
webアクティビティ・ルールのステータス内容。 -
WebActivityRuleCondition: array Web Activity Rule Conditions
タイトル:
Web Activity Rule Conditions
webアクティビティ・ルール条件リソースは、Webアクティビティ・ルール条件の表示、作成、更新および削除に使用されます。 -
WebActivityRuleId: integer (int64)
タイトル:
Web Activity Rule ID
webアクティビティ・ルールの一意の識別子。 -
WebActivityRuleName: string
タイトル:
Name
最大長:30
webアクティビティ・ルールの名前。 -
WebActivityRuleNumber: string
タイトル:
Web Activity Rule Number
最大長:30
webアクティビティ・ルールの公開一意識別子。 -
WebActivityType: string
タイトル:
Web Activity Type
最大長:100
webアクティビティ・ルールのWebアクティビティ・タイプ。 -
WebActivityTypeLookupCode: string
タイトル:
Web Activity Type
読取り専用:true
最大長:30
webアクティビティ・ルールのWebアクティビティ・タイプの参照コード。 -
WebActivityTypeMeaning: string
タイトル:
Web Activity Type
読取り専用:true
最大長:80
webアクティビティ・ルールのWebアクティビティ・タイプの意味。
ネストされたスキーマ : Webアクティビティ・ルール条件
タイプ:
array
タイトル:
Web Activity Rule Conditions
webアクティビティ・ルール条件リソースは、Webアクティビティ・ルール条件の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : webActivityRules-WebActivityRuleCondition-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
webアクティビティ・ルール条件を作成したリソース・ユーザー。 -
CreationDate: string (date-time)
タイトル:
Created Date
読取り専用:true
webアクティビティ・ルール条件が作成された日時。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
webアクティビティ・ルール条件が最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
webアクティビティ・ルール条件を最後に更新したリソース・ユーザー。 -
LastUpdateLogin: string
タイトル:
Last Updated Login
読取り専用:true
最大長:32
webアクティビティ・ルール条件を最後に更新したユーザーに関連付けられたログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
webアクティビティ・ルール条件のオブジェクト・バージョン番号。 -
RuleConditionExpression: 文字列(バイト)
タイトル:
Condition Expression
webアクティビティ・ルール条件のルール条件グループの式。 -
RuleConditionGroupName: string
タイトル:
Condition Group Name
最大長:30
webアクティビティ・ルール条件のルール条件グループ。 -
RuleConditionGroupType: string
タイトル:
Condition Group Type
最大長:30
webアクティビティ・ルール条件のルール条件グループのタイプ。 -
SourceObject: string
タイトル:
Source Object
最大長:30
webアクティビティ・ルール条件のソース・オブジェクト。 条件は、ソース・オブジェクトの属性を使用して定義されます。 -
WebActivityRuleId: integer (int64)
タイトル:
Web Activity Rule ID
webアクティビティ・ルール条件におけるWebアクティビティ・ルールの一意の識別子。 -
WebActyRuleCondId: integer (int64)
タイトル:
Web Activity Rule Condition ID
webアクティビティ・ルール条件の一意の識別子。 -
WebActyRuleCondNumber: string
タイトル:
Web Activity Rule Condition Number
最大長:30
webアクティビティ・ルール条件の公開一意識別子。