機械翻訳について

すべてのインバウンド・メッセージ・フィルタの取得

get

/crmRestApi/resources/11.13.18.05/inboundMsgFilters

リクエスト

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

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

    • InboundMsgFiltersVOAltKey : 指定された代替キーを持つインバウンド・メッセージ・フィルタを検索します。
      ファインダ変数:
      • ActionCd; string; フィルタにAcceptまたはRejectアクションが適用されるかどうかを示します。
      • FieldName; string;フィルタが適用されるフィールドの名前。
      • FilterTypeCd; string; フィルタのタイプを示します。
      • パターン;文字列;フィルタのパターン値。
    • PrimaryKey : 指定された主キーを持つインバウンド・メッセージ・フィルタを検索します。
      ファインダ変数:
      • FilterId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActionCd; string; AcceptまたはRejectアクションがフィルタに適用されているかどうかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_INBND_FLTR_ACTION_TYPEで定義されます。
    • ActionCdMeaning; string; インバウンドEメール・フィルタの処理参照コードに対応する表示値を示します。
    • CreatedBy; string;インバウンド・メッセージ・フィルタを作成したユーザー。
    • CreationDate; string;インバウンド・メッセージ・フィルタが作成された日付。
    • CustomFilterFlag; boolean。フィルタがユーザー定義かどうかを示します。
    • DeletedFlag; boolean。フィルタが削除されたかどうかを示します。 デフォルト値はfalseです。
    • Description; string;フィルタの説明。
    • FieldName; string;フィルタが適用されるフィールドの名前。
    • FilterId; integer;インバウンド・メッセージ・フィルタの一意の識別子。
    • FilterTypeCd; string; フィルタのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_INBND_FLTR_FIELD_TYPEで定義されます。
    • FilterTypeCdMeaning; string;インバウンドEメール・フィルタのフィルタ・タイプ参照コードに対応する表示値を示します。
    • LastUpdateDate; string;インバウンド・メッセージ・フィルタが最後に更新された日付。
    • LastUpdatedBy; string;インバウンド・メッセージ・フィルタを最後に更新したユーザー。
    • OrderNumber; integer; フィルタを適用する順序。 複数のフィルタがある場合にのみ有効です。
    • パターン;文字列;フィルタのパターン値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : inboundMsgFilters
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : inboundMsgFilters-item-response
タイプ: object
ソースを表示
  • タイトル: Action Code
    最大長: 30
    受入または拒否処理がフィルタに適用されているかどうかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_INBND_FLTR_ACTION_TYPEで定義されます。
  • タイトル: Action Value
    最大長: 255
    インバウンドEメール・フィルタの処理参照コードに対応する表示値を示します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    インバウンド・メッセージ・フィルタを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    インバウンド・メッセージ・フィルタが作成された日付。
  • タイトル: User-Defined Filter
    最大長: 1
    デフォルト値: false
    フィルタがユーザー定義かどうかを示します。
  • タイトル: Deleted
    最大長: 1
    デフォルト値: false
    フィルタが削除されたかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Can Delete
    読取り専用: true
    インバウンド・メッセージ・フィルタを削除できるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Description
    最大長: 400
    フィルタの説明。
  • タイトル: Field Name
    最大長: 64
    フィルタが適用されるフィールドの名前。
  • タイトル: Filter ID
    インバウンド・メッセージ・フィルタの一意の識別子。
  • タイトル: Filter Type Code
    最大長: 30
    フィルタのタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_INBND_FLTR_FIELD_TYPEで定義されます。
  • タイトル: Filter Type Value
    最大長: 255
    インバウンドEメール・フィルタのフィルタ・タイプ参照コードに対応する表示値を示します。
  • タイトル: Last Updated Date
    読取り専用: true
    インバウンド・メッセージ・フィルタが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    インバウンド・メッセージ・フィルタを最後に更新したユーザー。
  • Links
  • タイトル: Order Number
    フィルタを適用する順序。 複数のフィルタがある場合にのみ有効です。
  • タイトル: Pattern
    最大長: 400
    フィルタのパターン値。
  • タイトル: Can Update
    読取り専用: true
    インバウンド・メッセージ・フィルタを更新できるかどうかを示します。 デフォルト値はfalseです。
トップに戻る

例:

次のURI構文でGETを使用して、すべてのインバウンド・メッセージ・フィルタの詳細を取得します:

リクエストURIの例

次に、リクエストURLの例を示します。

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET /crmRestApi/resources/11.13.18.05/inboundMsgFilters/ HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200: OK
Date: Mon, 18 Jan 2017 08:45:04 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

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

Content type:
{
"items": [
  {
"FilterId": 300100091717107,
"FilterTypeCd": "ORA_SVC_MIME",
"FieldName": "MIMEAttachment",
"Pattern": "application/pdf",
"OrderNumber": 300100091712547,
"Description": "Automation Filter. DO NOT EDIT OR CHANGE THE ORDER",
"CustomFilterFlag": true,
"DeletedFlag": false,
"CreationDate": "2016-10-20T03:05:11-07:00",
"CreatedBy": "xInboundEmailUI1",
"LastUpdateDate": "2016-11-22T14:30:01-08:00",
"LastUpdatedBy": "MHoope",
"ActionCd": "ORA_SVC_REJECT",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107",
"name": "inboundMsgFilters",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000778"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107",
"name": "inboundMsgFilters",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107/lov/ActionCdLookupPVO",
"name": "ActionCdLookupPVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107/lov/YesNoLookupPVO",
"name": "YesNoLookupPVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107/lov/FilterTypeLookupPVO",
"name": "FilterTypeLookupPVO",
"kind": "collection"
}
],
},
  {
"FilterId": 300100091712546,
"FilterTypeCd": "ORA_SVC_SUBJECT",
"FieldName": "SUBJECT_Created_By_Automation",
"Pattern": "RejectThisSUB.*",
"OrderNumber": 300100091716735,
"Description": "Automation Filter. DO NOT EDIT OR CHANGE THE ORDER",
"CustomFilterFlag": false,
"DeletedFlag": false,
"CreationDate": "2016-10-20T02:09:17-07:00",
"CreatedBy": "xInboundEmailUI1",
"LastUpdateDate": "2017-01-12T11:37:03-08:00",
"LastUpdatedBy": "xInboundEmailUI1",
"ActionCd": "ORA_SVC_REJECT",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091712546",
"name": "inboundMsgFilters",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000001178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091712546",
"name": "inboundMsgFilters",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091712546/lov/ActionCdLookupPVO",
"name": "ActionCdLookupPVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091712546/lov/YesNoLookupPVO",
"name": "YesNoLookupPVO",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091712546/lov/FilterTypeLookupPVO",
"name": "FilterTypeLookupPVO",
"kind": "collection"
}
],
},


...


}
],
"count": 7,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters",
"name": "inboundMsgFilters",
"kind": "collection"
}
],
} 
「トップに戻る」