Optimizely Rule Clauses API
The Rule Clauses API from Optimizely — 15 operation(s) for rule clauses.
The Rule Clauses API from Optimizely — 15 operation(s) for rule clauses.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/optimizely-rule-clauses-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
version: admin-v1
title: Admin API V1 Rule Clauses API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Rule Clauses
paths:
/api/v1/admin/RuleClauses:
get:
tags:
- Rule Clauses
summary: Returns the EntitySet RuleClauses
operationId: RuleClauses_Get
parameters:
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $filter
in: query
description: Filters the results, based on a Boolean condition.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
- name: $apply
in: query
description: Aggregates the results according to one or more transformations.
required: false
schema:
type: string
- name: $orderby
in: query
description: Sorts the results.
required: false
schema:
type: string
- name: $top
in: query
description: Returns only the first n results.
required: false
schema:
type: integer
format: int32
- name: $skip
in: query
description: Skips the first n results.
required: false
schema:
type: integer
format: int32
- name: $count
in: query
description: Includes a count of the matching results in the response.
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
post:
tags:
- Rule Clauses
summary: Post a new entity to EntitySet RuleClauses
operationId: RuleClauses_Post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.RuleClause'
description: The entity to post
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/RuleClauses({id}):
get:
tags:
- Rule Clauses
summary: Returns the entity with the key from RuleClauses
operationId: RuleClauses_GetById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
put:
tags:
- Rule Clauses
summary: Replace entity in EntitySet RuleClauses
operationId: RuleClauses_PutById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.RuleClause'
description: The entity to put
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
delete:
tags:
- Rule Clauses
summary: Delete entity in EntitySet RuleClauses
operationId: RuleClauses_DeleteById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
- name: If-Match
in: header
description: If-Match header
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
patch:
tags:
- Rule Clauses
summary: Update entity in EntitySet RuleClauses
operationId: RuleClauses_PatchById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.RuleClause'
description: The entity to patch
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/RuleClauses/Default.Default():
get:
tags:
- Rule Clauses
summary: Call operation Default
operationId: RuleClauses_Default
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/RuleClauses({id})/Default.import:
post:
tags:
- Rule Clauses
summary: Call operation import
operationId: RuleClauses_ImportProductsAsyncById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
requestBody:
$ref: '#/components/requestBodies/System.Threading.CancellationToken'
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/RuleClauses({id})/Default.importcustomers:
post:
tags:
- Rule Clauses
summary: Call operation importcustomers
operationId: RuleClauses_ImportCustomersAsyncById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/System.Threading.CancellationToken'
description: importcustomers action parameters
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/RuleClauses/Default.createtemporary:
post:
tags:
- Rule Clauses
summary: Call operation createtemporary
operationId: RuleClauses_CreateTemporaryAsync_1
requestBody:
content:
application/json:
schema:
required:
- ruleTypeId
- ruleTypeOptionId
type: object
properties:
existingRuleClauseId:
format: guid
type: string
ruleTypeId:
format: guid
type: string
ruleTypeOptionId:
format: guid
type: string
entityName:
type: string
description: createtemporary action parameters
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/RuleClauses/Default.copyfromtemporary:
post:
tags:
- Rule Clauses
summary: Call operation copyfromtemporary
operationId: RuleClauses_CopyFromTemporary_1
requestBody:
content:
application/json:
schema:
required:
- targetRuleClauseId
- tempRuleClauseId
type: object
properties:
targetRuleClauseId:
format: guid
type: string
tempRuleClauseId:
format: guid
type: string
entityName:
type: string
description: copyfromtemporary action parameters
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses/copyfromtemporary:
post:
tags:
- Rule Clauses
operationId: RuleClauses_CopyFromTemporary_2
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses/createtemporary:
post:
tags:
- Rule Clauses
operationId: RuleClauses_CreateTemporaryAsync_2
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses({key})/import:
post:
tags:
- Rule Clauses
operationId: RuleClauses_ImportProductsAsyncByKey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses({key})/importcustomers:
post:
tags:
- Rule Clauses
operationId: RuleClauses_ImportCustomersAsyncByKey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses/delete:
delete:
tags:
- Rule Clauses
operationId: RuleClauses_DeleteRoute
parameters:
- name: ids
in: query
required: true
explode: true
schema:
type: array
items:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses({key})/customers({customerKey}):
get:
tags:
- Rule Clauses
operationId: RuleClauses_GetCustomerByKeyAndCustomerkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: customerKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses({key})/customproperties({custompropertyKey}):
get:
tags:
- Rule Clauses
operationId: RuleClauses_GetCustomPropertyByKeyAndCustompropertykey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: custompropertyKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
/api/v1/admin/ruleclauses({key})/products({productKey}):
get:
tags:
- Rule Clauses
operationId: RuleClauses_GetProductByKeyAndProductkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: productKey
in: path
required: true
schema:
type: string
format: uuid
- name: $expand
in: query
description: Expands related entities inline.
required: false
schema:
type: string
- name: $select
in: query
description: Selects which properties to include in the response.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
components:
schemas:
System.Threading.CancellationToken:
type: object
properties:
isCancellationRequested:
type: boolean
readOnly: true
canBeCanceled:
type: boolean
readOnly: true
waitHandle:
$ref: '#/components/schemas/System.Threading.WaitHandle'
Insite.Data.Entities.RuleClause:
required:
- condition
- criteriaType
- criteriaObject
- criteriaProperty
- criteriaValue
- comparisonOperator
- simpleValue
- valueList
- valueMinimum
- valueMaximum
type: object
properties:
id:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
ruleManagerId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
ruleTypeOptionId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
executionGroup:
format: int32
type: integer
executionOrder:
format: int32
type: integer
condition:
maxLength: 50
minLength: 0
type: string
criteriaType:
maxLength: 50
minLength: 0
type: string
criteriaObject:
maxLength: 255
minLength: 0
type: string
criteriaProperty:
maxLength: 100
minLength: 0
type: string
criteriaValue:
maxLength: 255
minLength: 0
type: string
comparisonOperator:
maxLength: 50
minLength: 0
type: string
simpleValue:
maxLength: 2048
minLength: 0
type: string
valueList:
maxLength: 2048
minLength: 0
type: string
valueMinimum:
maxLength: 100
minLength: 0
type: string
valueMaximum:
maxLength: 100
minLength: 0
type: string
createdOn:
format: date-time
type: string
createdBy:
type: string
modifiedOn:
format: date-time
type: string
modifiedBy:
type: string
Microsoft.Win32.SafeHandles.SafeWaitHandle:
type: object
properties:
isInvalid:
type: boolean
readOnly: true
isClosed:
type: boolean
readOnly: true
System.Threading.WaitHandle:
type: object
properties:
handle:
type: object
safeWaitHandle:
$ref: '#/components/schemas/Microsoft.Win32.SafeHandles.SafeWaitHandle'
requestBodies:
System.Threading.CancellationToken:
content:
application/json:
schema:
$ref: '#/components/schemas/System.Threading.CancellationToken'
description: import action parameters
required: true
securitySchemes:
access_token:
type: apiKey
description: Token used to access storefront API.
name: access_token
in: query