Jump to

• Request
• Response
• Examples

Add an Intelligence Model Filter

post

/rest/v19/intelligenceSetup/models/{modelId}/filters

Use this endpoint to create an intelligence model filter.

Request

Supported Media Types

• application/json

Path Parameters

• modelId(required): integer(int64)

Body ()

Root Schema : IntelligenceFilter

Type: object

Show Source

• _proxy_id: integer()
  Title: Proxy ID

  Read Only: true

  The proxy identifier for the resource that was added.
• attributeId(required): integer()
  Title: Attribute ID

  ID of the attribute used on the left hand side of the filter.
• attributeLabel: string()
  Title: Attribute Label

  Read Only: true

  Label of the attribute used on the left hand side of the filter.
• attributeValue(required): string()
  Title: Value

  Value on the right hand side of the filter. This value must either be the variable name of the source attribute or prefixed with '#SPECIFIC_' for static values.
• attributeValueLabel: string()
  Title: Value

  Read Only: true

  Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Model.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Model.
• id: integer()
  Title: ID

  Read Only: true

  ID of the Intelligence Filter.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• operator(required): string()
  Title: Operator

  Allowed Values: [ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]

  Operator used in the filter.

{
    "required":[
        "attributeId",
        "attributeValue",
        "operator"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Model.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Model.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"ID of the Intelligence Filter.",
            "title":"ID",
            "readOnly":true
        },
        "_proxy_id":{
            "type":"integer",
            "format":"",
            "description":"The proxy identifier for the resource that was added.",
            "title":"Proxy ID",
            "readOnly":true
        },
        "attributeId":{
            "type":"integer",
            "format":"",
            "description":"ID of the attribute used on the left hand side of the filter.",
            "title":"Attribute ID"
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"Label of the attribute used on the left hand side of the filter.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"Operator used in the filter.",
            "title":"Operator",
            "enum":[
                "_eq",
                "_not_eq",
                "_gr",
                "_le",
                "_gr_eq",
                "_le_eq",
                "_none",
                "_like",
                "_notlike",
                "_emp",
                "_not_emp"
            ]
        },
        "attributeValue":{
            "type":"string",
            "format":"",
            "description":"Value on the right hand side of the filter. This value must either be the variable name of the source attribute or prefixed with '#SPECIFIC_' for static values.",
            "title":"Value"
        },
        "attributeValueLabel":{
            "type":"string",
            "format":"",
            "description":"Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.",
            "title":"Value",
            "readOnly":true
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : IntelligenceFilter

Type: object

Show Source

• _proxy_id: integer()
  Title: Proxy ID

  Read Only: true

  The proxy identifier for the resource that was added.
• attributeId(required): integer()
  Title: Attribute ID

  ID of the attribute used on the left hand side of the filter.
• attributeLabel: string()
  Title: Attribute Label

  Read Only: true

  Label of the attribute used on the left hand side of the filter.
• attributeValue(required): string()
  Title: Value

  Value on the right hand side of the filter. This value must either be the variable name of the source attribute or prefixed with '#SPECIFIC_' for static values.
• attributeValueLabel: string()
  Title: Value

  Read Only: true

  Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Model.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Model.
• id: integer()
  Title: ID

  Read Only: true

  ID of the Intelligence Filter.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• operator(required): string()
  Title: Operator

  Allowed Values: [ "_eq", "_not_eq", "_gr", "_le", "_gr_eq", "_le_eq", "_none", "_like", "_notlike", "_emp", "_not_emp" ]

  Operator used in the filter.

{
    "required":[
        "attributeId",
        "attributeValue",
        "operator"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Model.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Model.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"ID of the Intelligence Filter.",
            "title":"ID",
            "readOnly":true
        },
        "_proxy_id":{
            "type":"integer",
            "format":"",
            "description":"The proxy identifier for the resource that was added.",
            "title":"Proxy ID",
            "readOnly":true
        },
        "attributeId":{
            "type":"integer",
            "format":"",
            "description":"ID of the attribute used on the left hand side of the filter.",
            "title":"Attribute ID"
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"Label of the attribute used on the left hand side of the filter.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"Operator used in the filter.",
            "title":"Operator",
            "enum":[
                "_eq",
                "_not_eq",
                "_gr",
                "_le",
                "_gr_eq",
                "_le_eq",
                "_none",
                "_like",
                "_notlike",
                "_emp",
                "_not_emp"
            ]
        },
        "attributeValue":{
            "type":"string",
            "format":"",
            "description":"Value on the right hand side of the filter. This value must either be the variable name of the source attribute or prefixed with '#SPECIFIC_' for static values.",
            "title":"Value"
        },
        "attributeValueLabel":{
            "type":"string",
            "format":"",
            "description":"Label of the attribute used as the Value on the right hand side of the filter. If this value is static, then this will just be the value.",
            "title":"Value",
            "readOnly":true
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to create an intelligence model filter by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/intelligenceSetup/models/334523/filters

Request Body Sample

{
   "attributeId": 18064711,
   "operator": "_eq",
   "attributeValue": "ORDER_PLACED"
 }

Response Body Sample

{
  "createdBy": {
    "firstName": "Alex",
    "lastName": "Smith",
    "emailId": "[e-mail]"
  },
  "lastModifiedBy": {
    "firstName": "Alex",
    "lastName": "Smith",
    "emailId": "[e-mail]"
  },
  "dateModified": "2025-03-08T20:13:50Z",
  "dateAdded": "2025-03-08T20:13:50Z",
  "id": 3023620976,
  "attributeId": 18064711,
  "operator": "_eq",
  "attributeValue": "ORDER_PLACED"
}

Back to Top