Jump to

• Request
• Response
• Examples

Get valid operators and data types

get

/access-governance/access-reviews/20250331/campaigns/operators

Retrieves a list of operators and data types. Applicable for Resource Ownership reviews.

Request

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  The maximum number of items to return.

  Default Value: 10
• page: string
  Minimum Length: 1

  A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.

Header Parameters

• opc-request-id: string
  The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of valid operators.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : OperatorSummaryCollection

Type: object

Valid operator list by data type. Contains Operator items.

Show Source

• items(required): array items
  List of Valid Operators.

{
    "type":"object",
    "description":"Valid operator list by data type. Contains Operator items.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of Valid Operators.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/OperatorSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of Valid Operators.

Show Source

• Array of: object OperatorSummary
  Valid operator list by data type. Contains Operator items.

{
    "description":"List of Valid Operators.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/OperatorSummary"
    }
}

Nested Schema : OperatorSummary

Type: object

Valid operator list by data type. Contains Operator items.

Show Source

• dataType(required): string
  Allowed Values: [ "DATE", "NUMBER", "STRING", "BOOLEAN" ]

  Data Type.
• validOperators(required): array validOperators
  List of Valid Operators.

{
    "type":"object",
    "description":"Valid operator list by data type. Contains Operator items.",
    "required":[
        "dataType",
        "validOperators"
    ],
    "properties":{
        "dataType":{
            "description":"Data Type.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DataType",
            "enum":[
                "DATE",
                "NUMBER",
                "STRING",
                "BOOLEAN"
            ]
        },
        "validOperators":{
            "description":"List of Valid Operators.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Operator"
            }
        }
    }
}

Nested Schema : validOperators

Type: array

List of Valid Operators.

Show Source

• Array of: string
  Allowed Values: [ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TO", "FROM", "CONTAINS", "NOT_CONTAINS" ]

  Expression operator.

{
    "description":"List of Valid Operators.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Operator"
    }
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Back to Top

Examples

The following example shows how to retrieve a list of operators for filtering criteria types during campaign creation.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 'https://<service-instance>/access-governance/access-reviews/${version}/campaigns/operators'

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "dataType": "DATE",
      "validOperators": [
        "BEFORE",
        "AFTER",
        "TILL",
        "FROM",
        "BTW"
      ]
    },
    {
      "dataType": "NUMBER",
      "validOperators": [
        "EQ",
        "NE",
        "GT",
        "LT",
        "GTE",
        "LTE",
        "BTW"
      ]
    },
    {
      "dataType": "STRING",
      "validOperators": [
        "EQ",
        "NE",
        "CON",
        "NCON",
        "BW",
        "NBW",
        "EW",
        "NEW"
      ]
    },
    {
      "dataType": "BOOLEAN",
      "validOperators": [
        "EQ",
        "NE"
      ]
    }
  ]
}

Back to Top