Optimizely Job Definition Parameters API

The Job Definition Parameters API from Optimizely — 5 operation(s) for job definition 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/JobDefinitionParameters List job definition parameters · Returns the EntitySet JobDefinitionParameters #
Ask an LLM
“Which parameters are defined for my integration job definitions?”
“Can I filter job parameters to a single job definition?”
Tell an agent
List all job definition parameters.
List job parameters matching {filter}.
POST /api/v1/admin/JobDefinitionParameters Add a parameter to a job definition · Post a new entity to EntitySet JobDefinitionParameters #
Ask an LLM
“How do I add an input parameter to an integration job definition?”
“What value type, prompt and default does a new job parameter need?”
Tell an agent
Add parameter {name} to job definition {jobDefinitionId} with default {defaultValue}.
Create job parameter {name} of type {valueType} prompting {prompt}.
GET /api/v1/admin/JobDefinitionParameters({id}) Get a job definition parameter · Returns the entity with the key from JobDefinitionParameters #
Ask an LLM
“What default value and prompt does a given job parameter have?”
“Can I look up one job definition parameter by id?”
Tell an agent
Get job definition parameter {id}.
Fetch job parameter {id} returning only {select}.
PUT /api/v1/admin/JobDefinitionParameters({id}) Replace a job definition parameter · Replace entity in EntitySet JobDefinitionParameters #
Ask an LLM
“How do I overwrite a job parameter's whole definition?”
“Can I resend name, type, prompt and default to replace a job parameter?”
Tell an agent
Replace job parameter {id} with name {name} and type {valueType}.
Overwrite the full job parameter record {id} with prompt {prompt}.
DELETE /api/v1/admin/JobDefinitionParameters({id}) Delete one job definition parameter · Delete entity in EntitySet JobDefinitionParameters #
Ask an LLM
“How do I remove a parameter from a job definition?”
“Can deleting a job parameter use an If-Match ETag?”
Tell an agent destructive · confirm first
Delete job definition parameter {id}.
Delete job parameter {id} only if its ETag still matches {etag}.
PATCH /api/v1/admin/JobDefinitionParameters({id}) Change a job parameter's default or order · Update entity in EntitySet JobDefinitionParameters #
Ask an LLM
“Can I change only the default value of a job parameter?”
“How do I reorder a job parameter's sequence?”
Tell an agent
Set the default of job parameter {id} to {defaultValue}.
Move job parameter {id} to sequence {sequence}.
GET /api/v1/admin/JobDefinitionParameters/Default.Default() Get default values for a new job parameter · Call operation Default #
Ask an LLM
“What defaults does a new job definition parameter start with?”
“Is there a blank job parameter template?”
Tell an agent
Get the default template for a job definition parameter.
Fetch an empty job parameter with default values.
DELETE /api/v1/admin/jobdefinitionparameters/delete Bulk delete job definition parameters · Job definition parameters delete route #
Ask an LLM
“Can I remove many job parameters in one call?”
“How do I bulk-delete job definition parameters by id?”
Tell an agent destructive · confirm first
Bulk delete job definition parameters {ids}.
Permanently remove every job parameter in {ids}.
GET /api/v1/admin/jobdefinitionparameters({key})/customproperties({custompropertyKey}) Get a custom property on a job parameter · Job definition parameters get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on a job definition parameter?”
“Can I read one custom attribute of a job parameter?”
Tell an agent
Get custom property {custompropertyKey} on job parameter {key}.
Read extra attribute {custompropertyKey} of job definition parameter {key}.

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-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-parameters-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Job Definition Parameters API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Job Definition Parameters
paths:
  /api/v1/admin/JobDefinitionParameters:
    get:
      tags:
      - Job Definition Parameters
      summary: Returns the EntitySet JobDefinitionParameters
      operationId: JobDefinitionParameters_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 Parameters
      summary: Post a new entity to EntitySet JobDefinitionParameters
      operationId: JobDefinitionParameters_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.JobDefinitionParameter'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionParameters({id}):
    get:
      tags:
      - Job Definition Parameters
      summary: Returns the entity with the key from JobDefinitionParameters
      operationId: JobDefinitionParameters_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 Parameters
      summary: Replace entity in EntitySet JobDefinitionParameters
      operationId: JobDefinitionParameters_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.JobDefinitionParameter'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Job Definition Parameters
      summary: Delete entity in EntitySet JobDefinitionParameters
      operationId: JobDefinitionParameters_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 Parameters
      summary: Update entity in EntitySet JobDefinitionParameters
      operationId: JobDefinitionParameters_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.JobDefinitionParameter'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionParameters/Default.Default():
    get:
      tags:
      - Job Definition Parameters
      summary: Call operation Default
      operationId: JobDefinitionParameters_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/jobdefinitionparameters/delete:
    delete:
      tags:
      - Job Definition Parameters
      operationId: JobDefinitionParameters_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 parameters delete route
      x-summary-source: derived
  /api/v1/admin/jobdefinitionparameters({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Job Definition Parameters
      operationId: JobDefinitionParameters_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 parameters get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.JobDefinitionParameter:
      required:
      - valueType
      - defaultValue
      - prompt
      - name
      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
        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