Optimizely

Optimizely Job Definition Steps API

The Job Definition Steps API from Optimizely — 7 operation(s) for job definition steps.

GitHub OpenAPI

Operations 11

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/JobDefinitionSteps List integration job steps · Returns the EntitySet JobDefinitionSteps #
Ask an LLM
“Which steps make up my integration job definitions?”
“Can I filter job definition steps by job and sort them by sequence?”
Tell an agent
List all job definition steps.
List job definition steps matching {filter}, ordered by {orderby}.
POST /api/v1/admin/JobDefinitionSteps Add a step to an integration job · Post a new entity to EntitySet JobDefinitionSteps #
Ask an LLM
“How do I add a new step to an integration job definition?”
“What select, from and where clauses does a new job step need?”
Tell an agent
Add step {name} for object {objectName} to job definition {jobDefinitionId}.
Create job step {name} selecting {selectClause} from {fromClause} where {whereClause}.
GET /api/v1/admin/JobDefinitionSteps({id}) Get an integration job step · Returns the entity with the key from JobDefinitionSteps #
Ask an LLM
“How do I see the query and delete action configured on one job step?”
“What object does a specific job definition step process?”
Tell an agent
Get job definition step {id}.
Show the clauses of job step {id}.
PUT /api/v1/admin/JobDefinitionSteps({id}) Replace an integration job step · Replace entity in EntitySet JobDefinitionSteps #
Ask an LLM
“How do I overwrite a whole job definition step in one call?”
“Does replacing a job step require every clause again?”
Tell an agent
Replace job step {id} with name {name}, object {objectName} and where clause {whereClause}.
Fully overwrite job definition step {id} with delete action {deleteAction}.
DELETE /api/v1/admin/JobDefinitionSteps({id}) Delete an integration job step · Delete entity in EntitySet JobDefinitionSteps #
Ask an LLM
“How do I remove one step from an integration job?”
“Can I delete a job step only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete job definition step {id}.
Delete job step {id} if its ETag is {etag}.
PATCH /api/v1/admin/JobDefinitionSteps({id}) Update an integration job step · Update entity in EntitySet JobDefinitionSteps #
Ask an LLM
“How do I change the sequence of a job step?”
“Can I switch a job step to only update existing records?”
Tell an agent
Move job step {id} to sequence {sequence}.
Set only-update-existing-records to {onlyUpdateExistingRecords} on job step {id}.
GET /api/v1/admin/JobDefinitionSteps/Default.Default() Get the default job step template · Call operation Default #
Ask an LLM
“What default values does a new job definition step start with?”
“Where can I get a blank job step record?”
Tell an agent
Get the default job definition step template.
Show default values for a new job step.
DELETE /api/v1/admin/jobdefinitionsteps/delete Bulk delete job steps · Job definition steps delete route #
Ask an LLM
“How do I delete several job definition steps at once?”
“Can I remove a batch of job steps by their ids?”
Tell an agent destructive · confirm first
Delete job definition steps {ids}.
Bulk remove job steps with ids {ids}.
GET /api/v1/admin/jobdefinitionsteps({key})/customproperties({custompropertyKey}) Get a job step custom property · Job definition steps get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a job definition step?”
“Where is one custom property value for a job step?”
Tell an agent
Get custom property {custompropertyKey} of job step {key}.
Show job step {key}'s custom property {custompropertyKey}.
GET /api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepfieldmaps({jobdefinitionstepfieldmapKey}) Get a job step field mapping · Job definition steps get job definition step field map by key and… #
Ask an LLM
“How do I see how one source field maps to a target field in a job step?”
“Can I fetch a single field map on an integration job step?”
Tell an agent
Get field map {fieldMapKey} of job step {key}.
Show field mapping {fieldMapKey} on job definition step {key}.
GET /api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepparameters({jobdefinitionstepparameterKey}) Get a job step parameter · Job definition steps get job definition step parameter by key and… #
Ask an LLM
“How do I read one parameter passed to an integration job step?”
“Can I fetch a single parameter on a job definition step?”
Tell an agent
Get parameter {parameterKey} of job step {key}.
Show job definition step {key}'s parameter {parameterKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-job-definition-steps-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-definition-steps-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-definition-steps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Job Definition Steps API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Job Definition Steps
paths:
  /api/v1/admin/JobDefinitionSteps:
    get:
      tags:
      - Job Definition Steps
      summary: Returns the EntitySet JobDefinitionSteps
      operationId: JobDefinitionSteps_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 Definition Steps
      summary: Post a new entity to EntitySet JobDefinitionSteps
      operationId: JobDefinitionSteps_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.JobDefinitionStep'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionSteps({id}):
    get:
      tags:
      - Job Definition Steps
      summary: Returns the entity with the key from JobDefinitionSteps
      operationId: JobDefinitionSteps_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 Definition Steps
      summary: Replace entity in EntitySet JobDefinitionSteps
      operationId: JobDefinitionSteps_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.JobDefinitionStep'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Job Definition Steps
      summary: Delete entity in EntitySet JobDefinitionSteps
      operationId: JobDefinitionSteps_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 Definition Steps
      summary: Update entity in EntitySet JobDefinitionSteps
      operationId: JobDefinitionSteps_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.JobDefinitionStep'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionSteps/Default.Default():
    get:
      tags:
      - Job Definition Steps
      summary: Call operation Default
      operationId: JobDefinitionSteps_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/jobdefinitionsteps/delete:
    delete:
      tags:
      - Job Definition Steps
      operationId: JobDefinitionSteps_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 definition steps delete route
      x-summary-source: derived
  /api/v1/admin/jobdefinitionsteps({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Job Definition Steps
      operationId: JobDefinitionSteps_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 definition steps get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepfieldmaps({jobdefinitionstepfieldmapKey}):
    get:
      tags:
      - Job Definition Steps
      operationId: JobDefinitionSteps_GetJobDefinitionStepFieldMapByKeyAndJobdefinitionstepfieldmapkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: jobdefinitionstepfieldmapKey
        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 definition steps get job definition step field map by key and…
      x-summary-source: derived
  /api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepparameters({jobdefinitionstepparameterKey}):
    get:
      tags:
      - Job Definition Steps
      operationId: JobDefinitionSteps_GetJobDefinitionStepParameterByKeyAndJobdefinitionstepparameterkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: jobdefinitionstepparameterKey
        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 definition steps get job definition step parameter by key and…
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.JobDefinitionStep:
      required:
      - name
      - objectName
      - integrationProcessorOverride
      - selectClause
      - fromClause
      - whereClause
      - parameterizedWhereClause
      - deleteAction
      - deleteActionFieldToSet
      - deleteActionValueToSet
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        jobDefinitionId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        sequence:
          format: int32
          type: integer
        name:
          maxLength: 255
          minLength: 0
          type: string
        objectName:
          maxLength: 255
          minLength: 0
          type: string
        integrationConnectionOverrideId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        integrationProcessorOverride:
          maxLength: 510
          minLength: 0
          type: string
        selectClause:
          type: string
        fromClause:
          type: string
        whereClause:
          type: string
        parameterizedWhereClause:
          type: string
        deleteAction:
          maxLength: 255
          minLength: 0
          type: string
        deleteActionFieldToSet:
          maxLength: 255
          minLength: 0
          type: string
        deleteActionValueToSet:
          maxLength: 255
          minLength: 0
          type: string
        deleteChildren:
          type: boolean
        skipHeaderRow:
          type: boolean
        onlyUpdateExistingRecords:
          type: boolean
        flatFileErrorHandling:
          type: string
        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