Optimizely Job Definition Step Parameters API

The Job Definition Step Parameters API from Optimizely — 5 operation(s) for job definition step parameters.

Operations 9

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/JobDefinitionStepParameters List integration job step parameters · Returns the EntitySet JobDefinitionStepParameters #
Ask an LLM
“Which parameters are defined on my integration job steps in Optimizely Configured Commerce?”
“Can I filter step parameters to one job definition step and sort by sequence?”
Tell an agent
List all job definition step parameters.
List job step parameters matching {filter}, ordered by {orderby}.
POST /api/v1/admin/JobDefinitionStepParameters Add a parameter to a job definition step · Post a new entity to EntitySet JobDefinitionStepParameters #
Ask an LLM
“How do I add a prompted parameter with a default value to an integration job step?”
“What value types and prompts are needed for a new step parameter?”
Tell an agent
Add parameter {name} of type {valueType} with default {defaultValue} and prompt {prompt}.
Create a step parameter on job step {jobDefinitionStepId} at sequence {sequence}.
GET /api/v1/admin/JobDefinitionStepParameters({id}) Get one job step parameter · Returns the entity with the key from JobDefinitionStepParameters #
Ask an LLM
“How do I look up a single job step parameter's default value by ID?”
“Can I expand the parent step when fetching one step parameter?”
Tell an agent
Show job definition step parameter {id}.
Fetch step parameter {id} with {expand} expanded.
PUT /api/v1/admin/JobDefinitionStepParameters({id}) Replace a job step parameter · Replace entity in EntitySet JobDefinitionStepParameters #
Ask an LLM
“Can I overwrite a job step parameter with a complete new definition?”
“What happens to step parameter fields I omit on a full replace?”
Tell an agent
Replace step parameter {id} with name {name}, type {valueType} and default {defaultValue}.
Overwrite the whole job step parameter {id}, setting its prompt to {prompt}.
DELETE /api/v1/admin/JobDefinitionStepParameters({id}) Delete a job step parameter · Delete entity in EntitySet JobDefinitionStepParameters #
Ask an LLM
“How do I remove one parameter from an integration job step?”
“Can I make deleting a step parameter conditional on an ETag?”
Tell an agent destructive · confirm first
Delete job step parameter {id}.
Delete step parameter {id} only if its ETag matches {etag}.
PATCH /api/v1/admin/JobDefinitionStepParameters({id}) Update a job step parameter · Update entity in EntitySet JobDefinitionStepParameters #
Ask an LLM
“Can I change just the default value of a job step parameter?”
“How would I reorder a parameter within its job step?”
Tell an agent
Patch step parameter {id} so its default value is {defaultValue}.
Move job step parameter {id} to sequence {sequence}.
GET /api/v1/admin/JobDefinitionStepParameters/Default.Default() Get default values for a job step parameter · Call operation Default #
Ask an LLM
“What defaults does the admin pre-fill for a new job step parameter?”
“Where do I get a blank step parameter template?”
Tell an agent
Get the default job step parameter template.
Show me the pre-filled defaults for a new step parameter.
DELETE /api/v1/admin/jobdefinitionstepparameters/delete Bulk delete job step parameters · Job definition step parameters delete route #
Ask an LLM
“How do I delete several job step parameters in one request?”
“Can I bulk-remove step parameters by ID?”
Tell an agent destructive · confirm first
Bulk delete job step parameters {ids}.
Permanently remove the step parameters with IDs {ids}.
GET /api/v1/admin/jobdefinitionstepparameters({key})/customproperties({custompropertyKey}) Get a custom property on a job step parameter · Job definition step parameters get custom property by key and custompropertykey #
Ask an LLM
“How can I read one custom property stored on a job step parameter?”
“Can I select fields from a step parameter's custom property?”
Tell an agent
Show custom property {custompropertyKey} on job step parameter {key}.
Fetch step parameter {key}'s custom property {custompropertyKey}, selecting {select}.

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-step-parameters-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.

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

OpenAPI Specification

optimizely-job-definition-step-parameters-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Job Definition Step Parameters API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Job Definition Step Parameters
paths:
  /api/v1/admin/JobDefinitionStepParameters:
    get:
      tags:
      - Job Definition Step Parameters
      summary: Returns the EntitySet JobDefinitionStepParameters
      operationId: JobDefinitionStepParameters_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 Step Parameters
      summary: Post a new entity to EntitySet JobDefinitionStepParameters
      operationId: JobDefinitionStepParameters_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.JobDefinitionStepParameter'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionStepParameters({id}):
    get:
      tags:
      - Job Definition Step Parameters
      summary: Returns the entity with the key from JobDefinitionStepParameters
      operationId: JobDefinitionStepParameters_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 Step Parameters
      summary: Replace entity in EntitySet JobDefinitionStepParameters
      operationId: JobDefinitionStepParameters_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.JobDefinitionStepParameter'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Job Definition Step Parameters
      summary: Delete entity in EntitySet JobDefinitionStepParameters
      operationId: JobDefinitionStepParameters_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 Step Parameters
      summary: Update entity in EntitySet JobDefinitionStepParameters
      operationId: JobDefinitionStepParameters_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.JobDefinitionStepParameter'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionStepParameters/Default.Default():
    get:
      tags:
      - Job Definition Step Parameters
      summary: Call operation Default
      operationId: JobDefinitionStepParameters_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/jobdefinitionstepparameters/delete:
    delete:
      tags:
      - Job Definition Step Parameters
      operationId: JobDefinitionStepParameters_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 step parameters delete route
      x-summary-source: derived
  /api/v1/admin/jobdefinitionstepparameters({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Job Definition Step Parameters
      operationId: JobDefinitionStepParameters_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 step parameters get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.JobDefinitionStepParameter:
      required:
      - valueType
      - defaultValue
      - prompt
      - name
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        jobDefinitionStepId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        sequence:
          format: int32
          type: integer
        valueType:
          maxLength: 255
          minLength: 0
          type: string
        defaultValue:
          type: string
        prompt:
          maxLength: 1024
          minLength: 0
          type: string
        name:
          maxLength: 255
          minLength: 0
          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