Optimizely

Optimizely Job Definition Step Field Maps API

The Job Definition Step Field Maps API from Optimizely — 5 operation(s) for job definition step field maps.

GitHub OpenAPI

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/JobDefinitionStepFieldMaps List integration job field mappings · Returns the EntitySet JobDefinitionStepFieldMaps #
Ask an LLM
“Which field mappings are defined on integration job steps in Optimizely Commerce?”
“Can I filter field maps to one job definition step?”
Tell an agent
List all job step field mappings.
Show field maps matching {filter}.
POST /api/v1/admin/JobDefinitionStepFieldMaps Map a source field to a target in a job step · Post a new entity to EntitySet JobDefinitionStepFieldMaps #
Ask an LLM
“How do I map an ERP column to a Commerce property in an integration job step?”
“Can I decide what happens when a lookup fails or a value is empty?”
Tell an agent
Map {fromProperty} to {toProperty} as a {fieldType} field in step {jobDefinitionStepId}.
Map {fieldType} {fromProperty} to {toProperty}; on lookup error {lookupErrorHandling}, on empty {emptyValueHandling}.
GET /api/v1/admin/JobDefinitionStepFieldMaps({id}) Get one job step field mapping · Returns the entity with the key from JobDefinitionStepFieldMaps #
Ask an LLM
“What source and target properties does a given field map connect?”
“Can I look up a single field mapping by id?”
Tell an agent
Fetch field map {id}.
Show the from and to properties of field mapping {id}.
PUT /api/v1/admin/JobDefinitionStepFieldMaps({id}) Replace a job step field mapping · Replace entity in EntitySet JobDefinitionStepFieldMaps #
Ask an LLM
“Can I overwrite an entire field mapping definition?”
“Does replacing a field map require resending its handling rules?”
Tell an agent
Replace field map {id} to map {fromProperty} onto {toProperty}.
Overwrite the full definition of field mapping {id}.
DELETE /api/v1/admin/JobDefinitionStepFieldMaps({id}) Delete one job step field mapping · Delete entity in EntitySet JobDefinitionStepFieldMaps #
Ask an LLM
“How do I drop a single field mapping from a job step?”
“Can deleting a field map be guarded by its ETag?”
Tell an agent destructive · confirm first
Delete field map {id}.
Delete field mapping {id} only if its ETag is {etag}.
PATCH /api/v1/admin/JobDefinitionStepFieldMaps({id}) Tweak a job step field mapping · Update entity in EntitySet JobDefinitionStepFieldMaps #
Ask an LLM
“Can I mark an existing field map as the ERP key?”
“Is it possible to stop a mapping from overwriting existing values?”
Tell an agent
Set the ERP key flag on field map {id} to {isErpKey}.
Set overwrite to {overwrite} on field mapping {id}.
GET /api/v1/admin/JobDefinitionStepFieldMaps/Default.Default() Get default values for a field mapping · Call operation Default #
Ask an LLM
“What defaults does a new job step field map start with?”
“Is there a blank field mapping template?”
Tell an agent
Get the default field values for a new job step field map.
Show the empty field mapping template.
DELETE /api/v1/admin/jobdefinitionstepfieldmaps/delete Bulk delete job step field mappings · Job definition step field maps delete route #
Ask an LLM
“Can I remove many field mappings in one request?”
“Is there a batch delete for job step field maps by id list?”
Tell an agent destructive · confirm first
Bulk delete field maps {ids}.
Permanently delete every field mapping in {ids}.
GET /api/v1/admin/jobdefinitionstepfieldmaps({key})/customproperties({custompropertyKey}) Get a custom property on a field mapping · Job definition step field maps get custom property by key and custompropertykey #
Ask an LLM
“How can I read a custom property stored on a job step field map?”
“Can I fetch one custom field value from a field mapping record?”
Tell an agent
Get custom property {custompropertyKey} of field map {key}.
Show the {custompropertyKey} custom property on field mapping {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-job-definition-step-field-maps-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-step-field-maps-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-step-field-maps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Job Definition Step Field Maps API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Job Definition Step Field Maps
paths:
  /api/v1/admin/JobDefinitionStepFieldMaps:
    get:
      tags:
      - Job Definition Step Field Maps
      summary: Returns the EntitySet JobDefinitionStepFieldMaps
      operationId: JobDefinitionStepFieldMaps_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 Field Maps
      summary: Post a new entity to EntitySet JobDefinitionStepFieldMaps
      operationId: JobDefinitionStepFieldMaps_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.JobDefinitionStepFieldMap'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionStepFieldMaps({id}):
    get:
      tags:
      - Job Definition Step Field Maps
      summary: Returns the entity with the key from JobDefinitionStepFieldMaps
      operationId: JobDefinitionStepFieldMaps_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 Field Maps
      summary: Replace entity in EntitySet JobDefinitionStepFieldMaps
      operationId: JobDefinitionStepFieldMaps_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.JobDefinitionStepFieldMap'
        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 Field Maps
      summary: Delete entity in EntitySet JobDefinitionStepFieldMaps
      operationId: JobDefinitionStepFieldMaps_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 Field Maps
      summary: Update entity in EntitySet JobDefinitionStepFieldMaps
      operationId: JobDefinitionStepFieldMaps_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.JobDefinitionStepFieldMap'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/JobDefinitionStepFieldMaps/Default.Default():
    get:
      tags:
      - Job Definition Step Field Maps
      summary: Call operation Default
      operationId: JobDefinitionStepFieldMaps_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/jobdefinitionstepfieldmaps/delete:
    delete:
      tags:
      - Job Definition Step Field Maps
      operationId: JobDefinitionStepFieldMaps_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 field maps delete route
      x-summary-source: derived
  /api/v1/admin/jobdefinitionstepfieldmaps({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Job Definition Step Field Maps
      operationId: JobDefinitionStepFieldMaps_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 field maps get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.JobDefinitionStepFieldMap:
      required:
      - fieldType
      - fromProperty
      - toProperty
      - lookupErrorHandling
      - emptyValueHandling
      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
        fieldType:
          maxLength: 255
          minLength: 0
          type: string
        fromProperty:
          maxLength: 255
          minLength: 0
          type: string
        toProperty:
          maxLength: 255
          minLength: 0
          type: string
        overwrite:
          type: boolean
        isErpKey:
          type: boolean
        lookupErrorHandling:
          maxLength: 100
          minLength: 0
          type: string
        emptyValueHandling:
          maxLength: 100
          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