Optimizely Integration Job Parameters API

The Integration Job Parameters API from Optimizely — 5 operation(s) for integration job 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/IntegrationJobParameters List integration job parameters · Returns the EntitySet IntegrationJobParameters #
Ask an LLM
“What parameter values were passed to our integration jobs?”
“Can I filter job parameters down to a single integration job run?”
Tell an agent
List all integration job parameters.
List integration job parameters where {filter}.
POST /api/v1/admin/IntegrationJobParameters Add a parameter value to an integration job · Post a new entity to EntitySet IntegrationJobParameters #
Ask an LLM
“How do I supply a parameter value for an integration job before it runs?”
“Can a job parameter be tied to a specific job definition step parameter?”
Tell an agent
Add parameter value {value} to integration job {integrationJobId}.
Set job definition parameter {jobDefinitionParameterId} to {value} on integration job {integrationJobId}.
GET /api/v1/admin/IntegrationJobParameters({id}) Get an integration job parameter · Returns the entity with the key from IntegrationJobParameters #
Ask an LLM
“What value does a particular integration job parameter hold?”
“Can I fetch one job parameter record by its id?”
Tell an agent
Get integration job parameter {id}.
Show the value of job parameter {id}.
PUT /api/v1/admin/IntegrationJobParameters({id}) Replace an integration job parameter · Replace entity in EntitySet IntegrationJobParameters #
Ask an LLM
“Can I rewrite a job parameter record entirely, including which job it belongs to?”
“Does replacing a job parameter clear fields I leave out?”
Tell an agent
Replace integration job parameter {id} with value {value}.
Overwrite job parameter {id} so it belongs to integration job {integrationJobId} with value {value}.
DELETE /api/v1/admin/IntegrationJobParameters({id}) Delete an integration job parameter · Delete entity in EntitySet IntegrationJobParameters #
Ask an LLM
“How do I remove a parameter I set on an integration job by mistake?”
“Can I protect a job parameter delete with an If-Match ETag?”
Tell an agent destructive · confirm first
Delete integration job parameter {id}.
Delete job parameter {id} if its ETag still equals {etag}.
PATCH /api/v1/admin/IntegrationJobParameters({id}) Change the value of an integration job parameter · Update entity in EntitySet IntegrationJobParameters #
Ask an LLM
“Can I just change the value of one job parameter?”
“Is a partial update supported for integration job parameters?”
Tell an agent
Change the value of job parameter {id} to {value}.
Patch job parameter {id} to use step parameter {jobDefinitionStepParameterId}.
GET /api/v1/admin/IntegrationJobParameters/Default.Default() Call the integration job parameters Default function · Call operation Default #
Ask an LLM
“What does the Default function on integration job parameters return?”
“Is there a default integration job parameter entry?”
Tell an agent
Call the Default function on integration job parameters.
Fetch the default integration job parameter result.
DELETE /api/v1/admin/integrationjobparameters/delete Bulk delete integration job parameters · Integration job parameters delete route #
Ask an LLM
“Can I clear several integration job parameters in one request?”
“Is there a bulk delete by id list for job parameters?”
Tell an agent destructive · confirm first
Delete integration job parameters {ids}.
Bulk remove the job parameters with ids {ids}.
GET /api/v1/admin/integrationjobparameters({key})/customproperties({custompropertyKey}) Get a custom property of an integration job parameter · Integration job parameters get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property attached to an integration job parameter?”
“Where is a custom value for a job parameter stored?”
Tell an agent
Get custom property {custompropertyKey} of job parameter {key}.
Show custom value {custompropertyKey} on integration job 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-integration-job-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-integration-job-parameters-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Integration Job Parameters API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Integration Job Parameters
paths:
  /api/v1/admin/IntegrationJobParameters:
    get:
      tags:
      - Integration Job Parameters
      summary: Returns the EntitySet IntegrationJobParameters
      operationId: IntegrationJobParameters_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:
      - Integration Job Parameters
      summary: Post a new entity to EntitySet IntegrationJobParameters
      operationId: IntegrationJobParameters_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.IntegrationJobParameter'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/IntegrationJobParameters({id}):
    get:
      tags:
      - Integration Job Parameters
      summary: Returns the entity with the key from IntegrationJobParameters
      operationId: IntegrationJobParameters_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:
      - Integration Job Parameters
      summary: Replace entity in EntitySet IntegrationJobParameters
      operationId: IntegrationJobParameters_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.IntegrationJobParameter'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Integration Job Parameters
      summary: Delete entity in EntitySet IntegrationJobParameters
      operationId: IntegrationJobParameters_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:
      - Integration Job Parameters
      summary: Update entity in EntitySet IntegrationJobParameters
      operationId: IntegrationJobParameters_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.IntegrationJobParameter'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/IntegrationJobParameters/Default.Default():
    get:
      tags:
      - Integration Job Parameters
      summary: Call operation Default
      operationId: IntegrationJobParameters_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/integrationjobparameters/delete:
    delete:
      tags:
      - Integration Job Parameters
      operationId: IntegrationJobParameters_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: Integration job parameters delete route
      x-summary-source: derived
  /api/v1/admin/integrationjobparameters({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Integration Job Parameters
      operationId: IntegrationJobParameters_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: Integration job parameters get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.IntegrationJobParameter:
      required:
      - value
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        integrationJobId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        jobDefinitionStepParameterId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        jobDefinitionParameterId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        value:
          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