openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/UPX_KPI_API_FORECAST_PREPARE:
    post:
      tags:
      - UPX_KPI_API
      operationId: /rfc/UPX_KPI_API_FORECAST_PREPARE
      requestBody:
        content:
          application/json:
            schema:
              properties:
                I_APP:
                  type: string
                  maxLength: 3
                  description: CRM Planning Application
                I_CUSTOM:
                  type: string
                  description: Key for Distribution Forced via API
                I_DISPLAY:
                  type: string
                  maxLength: 1
                  description: Checkbox Field
                I_OBJECTID:
                  type: string
                  maxLength: 60
                  description: Field for any characteristic value
                I_PROFILE:
                  type: string
                  maxLength: 8
                  description: Planning Profile
                I_SPREADKEY:
                  type: string
                  maxLength: 20
                  description: Key for Distribution Forced via API
                ET_HTML_DATA:
                  type: array
                  items:
                    type: object
                    properties:
                      LINE:
                        type: string
                        maxLength: 255
                        description: HTML container
                ET_HTML_VIEW:
                  type: array
                  items:
                    type: object
                    properties:
                      LINE:
                        type: string
                        maxLength: 255
                        description: HTML container
                ET_RETURN:
                  type: array
                  items:
                    type: object
                    properties:
                      TYPE:
                        type: string
                        maxLength: 1
                        description: 'Message type: S Success, E Error, W Warning, I Info, A Abort'
                      ID:
                        type: string
                        maxLength: 20
                        description: Message Class
                      NUMBER:
                        type: integer
                        format: int64
                        description: Message Number
                      MESSAGE:
                        type: string
                        maxLength: 220
                        description: Message Text
                      LOG_NO:
                        type: string
                        maxLength: 20
                        description: 'Application log: log number'
                      LOG_MSG_NO:
                        type: integer
                        format: int64
                        description: 'Application log: Internal message serial number'
                      MESSAGE_V1:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MESSAGE_V2:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MESSAGE_V3:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MESSAGE_V4:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      PARAMETER:
                        type: string
                        maxLength: 32
                        description: Parameter Name
                      ROW:
                        type: integer
                        format: int32
                        description: Lines in parameter
                      FIELD:
                        type: string
                        maxLength: 30
                        description: Field in parameter
                      SYSTEM:
                        type: string
                        maxLength: 10
                        description: Logical system from which message originates
                IT_ATTRIBUTE:
                  type: array
                  items:
                    type: object
                    properties:
                      PROFILE:
                        type: string
                        maxLength: 8
                        description: Planning Profile
                      CHANM:
                        type: string
                        maxLength: 30
                        description: Characteristic
                      CHAVL:
                        type: string
                        maxLength: 60
                        description: Field for Any Characteristic Value
                IT_ICONLIST:
                  type: array
                  items:
                    type: object
                    properties:
                      ICON:
                        type: string
                        maxLength: 40
                        description: Name
                      OBJTYPE:
                        type: string
                        maxLength: 1
                        description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                        enum:
                        - R
                        - L
                        - P
                        - ''
                        - F
                      CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      OBJID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      URL:
                        type: string
                        maxLength: 255
                        description: Char255
                IT_PATTERN:
                  type: array
                  items:
                    type: object
                    properties:
                      PROFILE:
                        type: string
                        maxLength: 8
                        description: Planning Profile
                      SEQNO:
                        type: integer
                        format: int64
                        description: Synchronized Combination ID
                      FACTOR:
                        type: integer
                        format: int64
                        description: 'Result of KPI Valuation: Value'
                IT_SPREADING:
                  type: array
                  items:
                    type: object
                    properties:
                      POS:
                        type: integer
                        format: int64
                        description: Synchronized Combination ID
                      PROFILE:
                        type: string
                        maxLength: 8
                        description: Planning Profile
                      REFERENCE:
                        type: string
                        maxLength: 8
                        description: Planning Profile
                IT_SPREAD_CHANM:
                  type: array
                  items:
                    type: object
                    properties:
                      POS:
                        type: integer
                        format: int64
                        description: Synchronized Combination ID
                      CHANM:
                        type: string
                        maxLength: 30
                        description: Characteristic
                IT_SPREAD_CHAVL:
                  type: array
                  items:
                    type: object
                    properties:
                      POS:
                        type: integer
                        format: int64
                        description: Synchronized Combination ID
                      SEQNO:
                        type: integer
                        format: int64
                        description: Synchronized Combination ID
                      COMB:
                        type: integer
                        format: int64
                        description: Synchronized Combination ID
                      CHANM:
                        type: string
                        maxLength: 30
                        description: Characteristic
                      CHAVL:
                        type: string
                        maxLength: 60
                        description: Field for Any Characteristic Value
                IT_TIMEFRAME:
                  type: array
                  items:
                    type: object
                    properties:
                      PROFILE:
                        type: string
                        maxLength: 8
                        description: Planning Profile
                      POS:
                        type: integer
                        format: int64
                        description: Synchronized Combination ID
                      CHAVL:
                        type: string
                        maxLength: 60
                        description: Field for Any Characteristic Value
              required:
              - I_APP
              - I_OBJECTID
              - I_PROFILE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  E_CHANGED:
                    type: string
                    maxLength: 1
                    description: Key for Distribution Forced via API
                  ET_HTML_DATA:
                    type: array
                    items:
                      type: object
                      properties:
                        LINE:
                          type: string
                          maxLength: 255
                          description: HTML container
                  ET_HTML_VIEW:
                    type: array
                    items:
                      type: object
                      properties:
                        LINE:
                          type: string
                          maxLength: 255
                          description: HTML container
                  ET_RETURN:
                    type: array
                    items:
                      type: object
                      properties:
                        TYPE:
                          type: string
                          maxLength: 1
                          description: 'Message type: S Success, E Error, W Warning, I Info, A Abort'
                        ID:
                          type: string
                          maxLength: 20
                          description: Message Class
                        NUMBER:
                          type: integer
                          format: int64
                          description: Message Number
                        MESSAGE:
                          type: string
                          maxLength: 220
                          description: Message Text
                        LOG_NO:
                          type: string
                          maxLength: 20
                          description: 'Application log: log number'
                        LOG_MSG_NO:
                          type: integer
                          format: int64
                          description: 'Application log: Internal message serial number'
                        MESSAGE_V1:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V2:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V3:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V4:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        PARAMETER:
                          type: string
                          maxLength: 32
                          description: Parameter Name
                        ROW:
                          type: integer
                          format: int32
                          description: Lines in parameter
                        FIELD:
                          type: string
                          maxLength: 30
                          description: Field in parameter
                        SYSTEM:
                          type: string
                          maxLength: 10
                          description: Logical system from which message originates
                  IT_ATTRIBUTE:
                    type: array
                    items:
                      type: object
                      properties:
                        PROFILE:
                          type: string
                          maxLength: 8
                          description: Planning Profile
                        CHANM:
                          type: string
                          maxLength: 30
                          description: Characteristic
                        CHAVL:
                          type: string
                          maxLength: 60
                          description: Field for Any Characteristic Value
                  IT_ICONLIST:
                    type: array
                    items:
                      type: object
                      properties:
                        ICON:
                          type: string
                          maxLength: 40
                          description: Name
                        OBJTYPE:
                          type: string
                          maxLength: 1
                          description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                          enum:
                          - R
                          - L
                          - P
                          - ''
                          - F
                        CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        OBJID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        URL:
                          type: string
                          maxLength: 255
                          description: Char255
                  IT_PATTERN:
                    type: array
                    items:
                      type: object
                      properties:
                        PROFILE:
                          type: string
                          maxLength: 8
                          description: Planning Profile
                        SEQNO:
                          type: integer
                          format: int64
                          description: Synchronized Combination ID
                        FACTOR:
                          type: integer
                          format: int64
                          description: 'Result of KPI Valuation: Value'
                  IT_SPREADING:
                    type: array
                    items:
                      type: object
                      properties:
                        POS:
                          type: integer
                          format: int64
                          description: Synchronized Combination ID
                        PROFILE:
                          type: string
                          maxLength: 8
                          description: Planning Profile
                        REFERENCE:
                          type: string
                          maxLength: 8
                          description: Planning Profile
                  IT_SPREAD_CHANM:
                    type: array
                    items:
                      type: object
                      properties:
                        POS:
                          type: integer
                          format: int64
                          description: Synchronized Combination ID
                        CHANM:
                          type: string
                          maxLength: 30
                          description: Characteristic
                  IT_SPREAD_CHAVL:
                    type: array
                    items:
                      type: object
                      properties:
                        POS:
                          type: integer
                          format: int64
                          description: Synchronized Combination ID
                        SEQNO:
                          type: integer
                          format: int64
                          description: Synchronized Combination ID
                        COMB:
                          type: integer
                          format: int64
                          description: Synchronized Combination ID
                        CHANM:
                          type: string
                          maxLength: 30
                          description: Characteristic
                        CHAVL:
                          type: string
                          maxLength: 60
                          description: Field for Any Characteristic Value
                  IT_TIMEFRAME:
                    type: array
                    items:
                      type: object
                      properties:
                        PROFILE:
                          type: string
                          maxLength: 8
                          description: Planning Profile
                        POS:
                          type: integer
                          format: int64
                          description: Synchronized Combination ID
                        CHAVL:
                          type: string
                          maxLength: 60
                          description: Field for Any Characteristic Value
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
