Oracle E-Business Suite Service Discovery API

WADL retrieval and service metadata

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

oracle-e-business-suite-service-discovery-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Oracle EBS e-Commerce Gateway Accounts Payable Service Discovery API
  description: RESTful APIs for Oracle E-Business Suite e-Commerce Gateway providing EDI (Electronic Data Interchange) transaction support. Enables exchange of standard ASC X12 and EDIFACT documents with trading partners through flat ASCII file integration with third-party EDI translators. Supports inbound and outbound document processing for purchase orders, invoices, ship notices, and other business documents.
  version: 12.2.0
  contact:
    name: Oracle Support
    email: support@oracle.com
    url: https://support.oracle.com
  license:
    name: Oracle Proprietary
    url: https://www.oracle.com/legal/terms/
  x-logo:
    url: https://www.oracle.com/a/ocom/img/oracle-logo.svg
servers:
- url: https://{instance}.oracle.com/webservices/rest
  description: Oracle EBS ISG REST endpoint
  variables:
    instance:
      default: ebs-host
      description: The Oracle EBS instance hostname
tags:
- name: Service Discovery
  description: WADL retrieval and service metadata
paths:
  /{serviceAlias}:
    get:
      operationId: getServiceWADL
      summary: Retrieve Wadl Description for a Deployed Service
      description: Returns the WADL (Web Application Description Language) document describing the available methods, parameters, and data types for the specified deployed REST service.
      tags:
      - Service Discovery
      parameters:
      - name: serviceAlias
        in: path
        required: true
        description: The alias of the deployed REST service
        schema:
          type: string
        example: approvals
      - name: WADL
        in: query
        required: true
        description: Flag to request the WADL description
        schema:
          type: string
          enum:
          - ''
        example: ''
      responses:
        '200':
          description: WADL document for the service
          content:
            application/xml:
              schema:
                type: string
                description: WADL XML document
              examples:
                Getservicewadl200Example:
                  summary: Default getServiceWADL 200 response
                  x-microcks-default: true
                  value: example_value
        '404':
          description: Service not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getservicewadl404Example:
                  summary: Default getServiceWADL 404 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      detail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
            message:
              type: string
              description: Human-readable error message
            detail:
              type: string
              description: Detailed error information
          example: example_value
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with Oracle EBS username and password
    tokenAuth:
      type: apiKey
      in: cookie
      name: accessToken
      description: Token-based authentication using the ISG login access token