Optimizely Job Definition Steps API

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

Operations 11

GET /api/v1/admin/JobDefinitionSteps Returns the EntitySet JobDefinitionSteps #
POST /api/v1/admin/JobDefinitionSteps Post a new entity to EntitySet JobDefinitionSteps #
GET /api/v1/admin/JobDefinitionSteps({id}) Returns the entity with the key from JobDefinitionSteps #
PUT /api/v1/admin/JobDefinitionSteps({id}) Replace entity in EntitySet JobDefinitionSteps #
DELETE /api/v1/admin/JobDefinitionSteps({id}) Delete entity in EntitySet JobDefinitionSteps #
PATCH /api/v1/admin/JobDefinitionSteps({id}) Update entity in EntitySet JobDefinitionSteps #
GET /api/v1/admin/JobDefinitionSteps/Default.Default() Call operation Default #
DELETE /api/v1/admin/jobdefinitionsteps/delete #
GET /api/v1/admin/jobdefinitionsteps({key})/customproperties({custompropertyKey}) #
GET /api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepfieldmaps({jobdefinitionstepfieldmapKey}) #
GET /api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepparameters({jobdefinitionstepparameterKey}) #

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-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 email required.

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: []
  /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: []
  /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: []
  /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: []
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