Get an inbound message filter
get
/crmRestApi/resources/11.13.18.05/inboundMsgFilters/{FilterId}
Request
Path Parameters
-
FilterId(required): integer(int64)
The unique identifier of the inbound message filter.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : inboundMsgFilters-item-response
Type:
Show Source
object
-
ActionCd: string
Title:
Action Code
Maximum Length:30
The code indicating if an Accept or a Reject action is applied on the filter. A list of accepted values is defined in the lookup ORA_SVC_INBND_FLTR_ACTION_TYPE. -
ActionCdMeaning: string
Title:
Action Value
Maximum Length:255
Indicates the display value corresponding to the action lookup code for the inbound email filters. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the inbound message filter. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inbound message filter was created. -
CustomFilterFlag: boolean
Title:
User-Defined Filter
Maximum Length:1
Default Value:false
Indicates whether the filter is user defined. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the filter is deleted. The default value is false. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the inbound message filter can be deleted. The default value is false. -
Description: string
Title:
Description
Maximum Length:400
The description of the filter. -
FieldName: string
Title:
Field Name
Maximum Length:64
The name of the field on which the filter is to be applied. -
FilterId: integer
(int64)
Title:
Filter ID
The unique identifier of the inbound message filter. -
FilterTypeCd: string
Title:
Filter Type Code
Maximum Length:30
The code indicating the type of the filter. A list of accepted values is defined in the lookup ORA_SVC_INBND_FLTR_FIELD_TYPE. -
FilterTypeCdMeaning: string
Title:
Filter Type Value
Maximum Length:255
Indicates the display value corresponding to the filter type lookup code for the inbound email filters. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inbound message filter was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the inbound message filter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: integer
(int64)
Title:
Order Number
The order in which the filters must be applied. Valid only if there are more than one filters. -
Pattern: string
Title:
Pattern
Maximum Length:400
The pattern value of the filter. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the inbound message filter can be updated. The default value is false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ActionCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_FLTR_ACTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: ActionCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FilterTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_FLTR_FIELD_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: FilterTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating whether an inbound message filter is deleted.
The following properties are defined on the LOV link relation:- Source Attribute: DeletedFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
Use GET with the following URI syntax to get details of a specific inbound message filter:
Example of Request URI
The following shows an example of the request URL.
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107
Example of Request Header
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100091717107 HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Mon, 18 Jan 2017 08:50:04 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following shows an example of the response body in JSON format.
Content type: { "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" } ], }