---
swagger: "2.0"
info:
  title: Workflow
  description: Simplified configuration and integration with Workflow Service  via
    APIM and PSG
  version: 1.0.0
  x-ibm-name: Workflow
basePath: /api
tags: []
schemes:
- https
paths:
  /v1/rulesAndWorkflow/workflow/run:
    post:
      summary: This API is used to Run strategy via APIM and PSG
      description: 'Strategy can be invoked by Consumers. This Api takes strategy
        name, Load it from DB and run it accordingly it has been configured '
      tags:
      - WORKFLOW-SERVICE
      operationId: processWorkflow
      parameters:
      - name: edelivery
        in: body
        schema:
          $ref: '#/definitions/runProcessFlowRequest'
      - name: uuid
        default: a5b0b6d0-5c6b-48c2-aa3c-9925325d943b
        in: header
        description: 128 bit UUID that you generate for every request
        required: true
        type: string
      - name: client_id
        in: query
        required: true
        description: Client Id of the Consumer provided by APIM
        type: string
        format: string
      - name: Accept
        default: application/json
        in: header
        description: Content types that are acceptable for the response. Currently
          we support application/json
        required: true
        type: string
      - name: Authorization
        in: header
        required: true
        description: The Authorization Token received in earlier API call. This will
          contain the Access Token
        type: string
        format: string
      - name: countryCode
        in: header
        description: 2 character ISO format country code.
        type: string
        required: false
      - name: businessCode
        in: header
        description: 3 character business code
        type: string
        required: false
      - name: channelId
        in: header
        description: Channel Id of the incoming request
        type: string
        required: false
      - name: Content-Type
        in: header
        required: true
        type: string
        description: Content types that are acceptable for the request. Currently
          we support application/json. This is present only for PUT/POST Methods.
        default: application/json
      - name: tenantName
        in: header
        required: true
        type: string
        description: tenant specific to Application/Consumer which is being used to
          fetch the Application/Consumer specific Alert templates
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response in ISO format
        type: string
        required: false
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/runProcessFlowResponse'
        400:
          description: Missing or invalid Parameters
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            uuid:
              type: string
              description: 128 bit UUID that was provided
            citiUUID:
              type: string
              description: Unique 128 bit UUID for this response
            Content-Type:
              type: string
              description: Content type of the response
        401:
          description: Authorization token is missing or invalid
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            uuid:
              type: string
              description: 128 bit UUID that was provided
            citiUUID:
              type: string
              description: Unique 128 bit UUID for this response
            Content-Type:
              type: string
              description: Content type of the response
        403:
          description: The request operation is not configured to access this resource
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            uuid:
              type: string
              description: 128 bit UUID that was provided
            citiUUID:
              type: string
              description: Unique 128 bit UUID for this response
            Content-Type:
              type: string
              description: Content type of the response
        404:
          description: The requested resource was not found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            uuid:
              type: string
              description: 128 bit UUID that was provided
            citiUUID:
              type: string
              description: Unique 128 bit UUID for this response
            Content-Type:
              type: string
              description: Content type of the response
        500:
          description: The request failed due to an internal error/server unavailability
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            uuid:
              type: string
              description: 128 bit UUID that was provided
            citiUUID:
              type: string
              description: Unique 128 bit UUID for this response
            Content-Type:
              type: string
              description: Content type of the response
definitions:
  runProcessFlowRequest:
    type: object
    properties:
      command:
        type: object
        properties:
          callerID:
            type: string
            example: edelivery
      data:
        type: object
        properties:
          strategyName:
            type: string
            example: EdeliveryPushNotificationStrategy
          customerDetails:
            type: object
            properties:
              customerLoginId:
                type: string
                example: "1001111178887"
              customerLoginIdBase:
                type: string
                example: "1001111178887"
              businessName:
                type: string
                example: USGCB
              customerType:
                type: string
                example: Bank
              locale:
                type: string
                example: en_US
          communicationDetails:
            type: object
            properties:
              alertData:
                type: object
                properties:
                  event:
                    type: string
                    example: BalanceTransferSubmitted
                    enum:
                    - BalanceTransferSubmitted
                    - BalanceTransferPending
                    - BalanceTransferCompleted
                  deviceType:
                    type: string
                    example: ipHone6s
              channelData:
                type: object
                properties:
                  channelType:
                    type: string
                    example: EMAIL
                  messageCode:
                    type: string
                    example: BLANACER_TRANSFER_ALERT
              multipleEmailrecipients:
                type: object
                properties:
                  toEmailChannelAddresses:
                    type: string
                    example: abc@text.com
                  ccEmailChannelAddresses:
                    type: string
                    example: abc@text.com
                  bccEmailChannelAddresses:
                    type: string
                    example: abc@text.com
                  replytoAddress:
                    type: string
                    example: abc@text.com
  runProcessFlowResponse:
    type: object
    properties:
      workflowId:
        type: string
        example: "1463747186587"
  ErrorResponse:
    properties:
      type:
        type: string
        enum:
        - error
        - warn
        - invalid
        - fatal
        description: <br>invalid - Request did not confirm to the specification and
          was unprocessed & rejected. Please fix the value and try again</br><br>warn
          - Request was partially processed.  E.g. some of the fields are missing
          in response to the system issues,  request was accepted successfully but
          will be processed asynchronously</br><br>error - The request was accepted
          but could not be processed successfully</br><br>fatal - There was an internal
          system error while processing the request. These are technical errors and
          will be resolved by Citi, and the consumer should retry after some time.
          Business errors will not be categorized as fatal </br>
        example: string
      code:
        type: string
        description: Error code which qualifies the error
        example: string
      details:
        type: string
        description: Human readable explanation specific to the occurrence of the
          problem
        example: string
      location:
        type: string
        description: The name of the field that resulted in the error
        example: string
      moreInfo:
        type: string
        description: URI to human readable documentation of the error
        example: string
    required:
    - type
    - code
x-ignite-status:
  lifecycle: Development - In Progress
  inventory: Imported Service - Service Catalog Request
x-servers:
- description: Original Location
  url: https://127.0.0.1/api
x-ignite-discovery:
  classifications:
  - NGA Compliant
  - Cross LOB Global
  - Workflow (Rules and Workflow)
  - 169073 - Global Digital Cross Channel Platform - NAM
  - MEXICO
  - NAM
  profile: domain
  interfaceType: REST API
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  OAuth2 Application Flow:
    type: oauth2
    description: ""
    flow: application
    scopes:
      /api/v1: ""
    tokenUrl: https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
  Client ID:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
  - /api/v1
  Client ID: []
x-ibm-endpoints:
- endpointUrl: https://api.banamex.com/mx-gcgapi
  type:
  - production
  - development
...