Optimizely

Optimizely Job Definitions API

The Job Definitions API from Optimizely — 8 operation(s) for job definitions.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/JobDefinitions List integration job definitions · Returns the EntitySet JobDefinitions #
Ask an LLM
“How can I see every integration job definition configured in Configured Commerce?”
“Can I filter job definitions to recurring ones or by job type?”
Tell an agent
List all integration job definitions.
List job definitions matching {filter}, sorted by {orderby}.
POST /api/v1/admin/JobDefinitions Create an integration job definition · Post a new entity to EntitySet JobDefinitions #
Ask an LLM
“What must I supply to define a new import or export job?”
“Can I set up a job definition that runs on a cron schedule?”
Tell an agent
Create job definition {name} of type {jobType} from standard job {standardJobName}.
Define job {name} that recurs on cron {recurringCronExpression} and notifies {notifyEmail}.
GET /api/v1/admin/JobDefinitions({id}) Get a job definition · Returns the entity with the key from JobDefinitions #
Ask an LLM
“Can I see the schedule and processors of one job definition?”
“When did a particular job definition last run and with what status?”
Tell an agent
Show job definition {id}.
Get job definition {id} expanding {expand}.
PUT /api/v1/admin/JobDefinitions({id}) Replace a job definition · Replace entity in EntitySet JobDefinitions #
Ask an LLM
“Can I overwrite an entire job definition with a new configuration?”
“What's the full-replacement call for a job definition?”
Tell an agent
Replace job definition {id} with name {name} and type {jobType}.
Overwrite job definition {id} entirely, using description {description}.
DELETE /api/v1/admin/JobDefinitions({id}) Delete a job definition · Delete entity in EntitySet JobDefinitions #
Ask an LLM
“How do I remove an integration job definition I no longer use?”
“Can I delete a job definition conditionally on its ETag?”
Tell an agent destructive · confirm first
Delete job definition {id}.
Delete job definition {id} only if its ETag equals {etag}.
PATCH /api/v1/admin/JobDefinitions({id}) Update a job definition's settings · Update entity in EntitySet JobDefinitions #
Ask an LLM
“Can I change only the notification email on a job definition?”
“Is there a partial update to raise a job's max retries?”
Tell an agent
Set the notify email on job definition {id} to {notifyEmail}.
Patch job definition {id} so max retries is {maxRetries}.
GET /api/v1/admin/JobDefinitions/Default.Default() Get default values for a job definition · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a new job definition?”
“Is there a blank template for a job definition?”
Tell an agent
Get the default job definition template.
Show pre-filled values for a new job definition.
DELETE /api/v1/admin/jobdefinitions/delete Delete several job definitions · Job definitions delete route #
Ask an LLM
“Can I bulk delete job definitions in a single request?”
“Which call removes a list of job definitions by ID?”
Tell an agent destructive · confirm first
Bulk delete job definitions {ids}.
Remove the job definitions listed in {ids}.
GET /api/v1/admin/jobdefinitions({key})/customproperties({custompropertyKey}) Get a custom property on a job definition · Job definitions get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom field stored on a job definition?”
“Where are extra attributes of a job definition kept?”
Tell an agent
Get custom property {custompropertyKey} on job definition {key}.
Show job definition {key}'s custom field {custompropertyKey}.
GET /api/v1/admin/jobdefinitions({key})/integrationjobs({integrationjobKey}) Get one run of a job definition · Job definitions get integration job by key and integrationjobkey #
Ask an LLM
“Can I look up a specific job run that belongs to a job definition?”
“Which call returns one integration job under its definition?”
Tell an agent
Get integration job {integrationjobKey} run by job definition {key}.
Show run {integrationjobKey} of job definition {key}.
GET /api/v1/admin/jobdefinitions({key})/jobdefinitionparameters({jobdefinitionparameterKey}) Get a parameter of a job definition · Job definitions get job definition parameter by key and… #
Ask an LLM
“Can I read one configured parameter on a job definition?”
“Where do I see a job definition's input parameter value?”
Tell an agent
Get parameter {jobdefinitionparameterKey} of job definition {key}.
Show job definition {key}'s parameter {jobdefinitionparameterKey}.
GET /api/v1/admin/jobdefinitions({key})/jobdefinitionsteps({jobdefinitionstepKey}) Get a step of a job definition · Job definitions get job definition step by key and jobdefinitionstepkey #
Ask an LLM
“Can I inspect a single processing step inside a job definition?”
“Which call returns one step of a multi-step integration job?”
Tell an agent
Get step {jobdefinitionstepKey} of job definition {key}.
Show job definition {key}'s step {jobdefinitionstepKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-job-definitions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-job-definitions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-job-definitions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Job Definitions API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Job Definitions
paths:
  /api/v1/admin/JobDefinitions:
    get:
      tags:
      - Job Definitions
      summary: Returns the EntitySet JobDefinitions
      operationId: JobDefinitions_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:
      - Job Definitions
      summary: Post a new entity to EntitySet JobDefinitions
      operationId: JobDefinitions_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.JobDefinition'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitions({id}):
    get:
      tags:
      - Job Definitions
      summary: Returns the entity with the key from JobDefinitions
      operationId: JobDefinitions_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:
      - Job Definitions
      summary: Replace entity in EntitySet JobDefinitions
      operationId: JobDefinitions_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.JobDefinition'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Job Definitions
      summary: Delete entity in EntitySet JobDefinitions
      operationId: JobDefinitions_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:
      - Job Definitions
      summary: Update entity in EntitySet JobDefinitions
      operationId: JobDefinitions_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.JobDefinition'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitions/Default.Default():
    get:
      tags:
      - Job Definitions
      summary: Call operation Default
      operationId: JobDefinitions_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/jobdefinitions/delete:
    delete:
      tags:
      - Job Definitions
      operationId: JobDefinitions_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: []
      summary: Job definitions delete route
      x-summary-source: derived
  /api/v1/admin/jobdefinitions({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Job Definitions
      operationId: JobDefinitions_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: []
      summary: Job definitions get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/jobdefinitions({key})/integrationjobs({integrationjobKey}):
    get:
      tags:
      - Job Definitions
      operationId: JobDefinitions_GetIntegrationJobByKeyAndIntegrationjobkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: integrationjobKey
        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: []
      summary: Job definitions get integration job by key and integrationjobkey
      x-summary-source: derived
  /api/v1/admin/jobdefinitions({key})/jobdefinitionparameters({jobdefinitionparameterKey}):
    get:
      tags:
      - Job Definitions
      operationId: JobDefinitions_GetJobDefinitionParameterByKeyAndJobdefinitionparameterkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: jobdefinitionparameterKey
        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: []
      summary: Job definitions get job definition parameter by key and…
      x-summary-source: derived
  /api/v1/admin/jobdefinitions({key})/jobdefinitionsteps({jobdefinitionstepKey}):
    get:
      tags:
      - Job Definitions
      operationId: JobDefinitions_GetJobDefinitionStepByKeyAndJobdefinitionstepkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: jobdefinitionstepKey
        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: []
      summary: Job definitions get job definition step by key and jobdefinitionstepkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.JobDefinition:
      required:
      - standardJobName
      - name
      - description
      - jobType
      - notifyEmail
      - notifyCondition
      - preProcessor
      - integrationProcessor
      - postProcessor
      - lastRunJobNumber
      - lastRunStatus
      - recurringType
      - linkedJobCondition
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        integrationConnectionId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        standardJobName:
          maxLength: 50
          minLength: 0
          type: string
        name:
          maxLength: 255
          minLength: 0
          type: string
        description:
          maxLength: 2048
          minLength: 0
          type: string
        jobType:
          maxLength: 255
          minLength: 0
          type: string
        debuggingEnabled:
          type: boolean
        passThroughJob:
          type: boolean
        notifyEmail:
          maxLength: 255
          minLength: 0
          type: string
        notifyCondition:
          maxLength: 255
          minLength: 0
          type: string
        linkedJobId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        passDataSetToLinkedJob:
          type: boolean
        useDeltaDataSet:
          type: boolean
        preProcessor:
          maxLength: 510
          minLength: 0
          type: string
        integrationProcessor:
          maxLength: 510
          minLength: 0
          type: string
        postProcessor:
          maxLength: 510
          minLength: 0
          type: string
        lastRunDateTime:
          format: date-time
          type: string
        lastRunJobNumber:
          maxLength: 255
          minLength: 0
          type: string
        lastRunStatus:
          maxLength: 255
          minLength: 0
          type: string
        recurringJob:
          type: boolean
        recurringStartDateTime:
          format: date-time
          type: string
        recurringEndDateTime:
          format: date-time
          type: string
        recurringInterval:
          format: int32
          type: integer
        recurringType:
          maxLength: 50
          minLength: 0
          type: string
        recurringStartTime:
          format: date-time
          type: string
        recurringStartDay:
          format: int32
          type: integer
        recurringAdvancedMode:
          type: boolean
        recurringCronExpression:
          maxLength: 200
          minLength: 0
          type: string
        emailTemplateId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        runStepsInParallel:
          type: boolean
        linkedJobCondition:
          maxLength: 50
          minLength: 0
          type: string
        maxErrorsBeforeFail:
          format: int32
          type: integer
        maxWarningsBeforeFail:
          format: int32
          type: integer
        maxRetries:
          format: int32
          type: integer
        maxDeactivationPercent:
          format: int32
          type: integer
        maxTimeoutMinutes:
          format: int32
          type: integer
        refreshBatchSize:
          format: int32
          type: integer
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query