Jump to

• Request
• Response
• Examples

Get all inbound message filters

get

/crmRestApi/resources/11.13.18.05/inboundMsgFilters

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • InboundMsgFiltersVOAltKey: Finds an inbound message filter with the specified alternate key.
    Finder Variables:
    • ActionCd; string; Indicates whether an Accept or a Reject action is applied on the filter.
    • FieldName; string; The name of the field on which the filter is to be applied.
    • FilterTypeCd; string; Indicates the type of the filter.
    • Pattern; string; The pattern value of the filter.
  • PrimaryKey: Finds an inbound message filter with the specified primary key.
    Finder Variables:
    • FilterId; integer; The unique identifier of the inbound message filter.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionCd; string; 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; Indicates the display value corresponding to the action lookup code for the inbound email filters.
  • CreatedBy; string; The user who created the inbound message filter.
  • CreationDate; string; The date when the inbound message filter was created.
  • CustomFilterFlag; boolean; Indicates whether the filter is user defined.
  • DeletedFlag; boolean; Indicates whether the filter is deleted. The default value is false.
  • Description; string; The description of the filter.
  • FieldName; string; The name of the field on which the filter is to be applied.
  • FilterId; integer; The unique identifier of the inbound message filter.
  • FilterTypeCd; string; 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; Indicates the display value corresponding to the filter type lookup code for the inbound email filters.
  • LastUpdateDate; string; The date when the inbound message filter was last updated.
  • LastUpdatedBy; string; The user who last updated the inbound message filter.
  • OrderNumber; integer; The order in which the filters must be applied. Valid only if there are more than one filters.
  • Pattern; string; The pattern value of the filter.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

Response

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.

Body ()

Root Schema : inboundMsgFilters

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/inboundMsgFilters-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object inboundMsgFilters-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/inboundMsgFilters-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : inboundMsgFilters-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the inbound message filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomFilterFlag":{
            "title":"User-Defined Filter",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the filter is user defined.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "FilterTypeCd"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inbound message filter was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Pattern":{
            "title":"Pattern",
            "maxLength":"400",
            "type":"string",
            "description":"The pattern value of the filter.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the inbound message filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FilterTypeCd":{
            "title":"Filter Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the filter. A list of accepted values is defined in the lookup ORA_SVC_INBND_FLTR_FIELD_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"400",
            "type":"string",
            "description":"The description of the filter.",
            "nullable":true,
            "x-queryable":true
        },
        "FilterTypeCdMeaning":{
            "title":"Filter Type Value",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the display value corresponding to the filter type lookup code for the inbound email filters.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FilterTypeCd"
                ]
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "type":"integer",
            "description":"The order in which the filters must be applied. Valid only if there are more than one filters.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FilterId":{
            "title":"Filter ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message filter.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the inbound message filter can be deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate"
            }
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the inbound message filter can be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate; HideInCreateTask; HideInEmailTemplate"
            }
        },
        "ActionCd":{
            "title":"Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionCdMeaning":{
            "title":"Action Value",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the display value corresponding to the action lookup code for the inbound email filters.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionCd"
                ]
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the filter is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the field on which the filter is to be applied.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inbound message filter was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

Use GET with the following URI syntax to get details of all inbound message filters:

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

Example of Request Header

The following shows an example of the request header.

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

Example of Response Header

The following shows an example of the response header.

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

Example of Response Body

The following shows an example of the response body in JSON format.

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"
}
],
} 

Back to Top