Jump to

• Request
• Response
• Examples

Create an inbound message filter

post

/crmRestApi/resources/11.13.18.05/inboundMsgFilters

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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

{
    "type":"object",
    "properties":{
        "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"
                ]
            }
        },
        "Pattern":{
            "title":"Pattern",
            "maxLength":"400",
            "type":"string",
            "description":"The pattern value of the filter.",
            "nullable":false
        },
        "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"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"400",
            "type":"string",
            "description":"The description of the filter.",
            "nullable":true
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "FilterId":{
            "title":"Filter ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message filter.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the field on which the filter is to be applied.",
            "nullable":true
        }
    }
}

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-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."
        }
    }
}

Links

ActionCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

FilterTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

YesNoLookupPVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Back to Top

Examples

Use POST with the following URI syntax to create an 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

Example of Request Header

The following shows an example of the request header.

POST /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 Request Body

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

Content type:
{
      "FilterTypeCd": "ORA_SVC_SUBJECT",
      "FieldName": "Subject",
      "Pattern": ".*spam.*",
      "Description": "This filter is to reject mail if subject is spam",
      "CustomFilterFlag": false,
      "DeletedFlag": false,
      "ActionCd": "ORA_SVC_REJECT"
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201: Created
Date: Mon, 18 Jan 2017 08:43: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": 300100095325310,
"FilterTypeCd": "ORA_SVC_SUBJECT",
"FieldName": "Subject",
"Pattern": ".*spam.*",
"OrderNumber": 300100095325311,
"Description": "This filter is to reject mail if subject is spam",
"CustomFilterFlag": false,
"DeletedFlag": false,
"CreationDate": "2017-01-18T00:43:03-08:00",
"CreatedBy": "SALES_ADMIN",
"LastUpdateDate": "2017-01-18T00:43:03-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"ActionCd": "ORA_SVC_REJECT",
"links": [
  
{
"rel": "self",
"href": " http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100095325310",
"name": "inboundMsgFilters",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
}
,
  
{
"rel": "canonical",
"href": " http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100095325310",
"name": "inboundMsgFilters",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": " http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100095325310/lov/ActionCdLookupPVO",
"name": "ActionCdLookupPVO",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": " http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100095325310/lov/YesNoLookupPVO",
"name": "YesNoLookupPVO",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": " http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMsgFilters/300100095325310/lov/FilterTypeLookupPVO",
"name": "FilterTypeLookupPVO",
"kind": "collection"
}
],
}

Back to Top