Simplified configuration and integration with Workflow Service via APIM and PSG
- lifecycle: Development - In Progress
- inventory: Imported Service - Service Catalog Request
- 0:
- description: Original Location
- url: https://127.0.0.1/api
- classifications:
- 0: NGA Compliant
- 1: Cross LOB Global
- 2: Workflow (Rules and Workflow)
- 3: 169073 - Global Digital Cross Channel Platform - NAM
- 4: MEXICO
- 5: NAM
- profile: domain
- interfaceType: REST API
Paths
/v1/rulesAndWorkflow/workflow/run
This API is used to Run strategy via APIM and PSG
Strategy can be invoked by Consumers. This Api takes strategy name, Load it from DB and run it accordingly it has been configured
128 bit UUID that you generate for every request
{
"default": "a5b0b6d0-5c6b-48c2-aa3c-9925325d943b"
}Client Id of the Consumer provided by APIM
Content types that are acceptable for the response. Currently we support application/json
{
"default": "application\/json"
}The Authorization Token received in earlier API call. This will contain the Access Token
2 character ISO format country code.
3 character business code
Channel Id of the incoming request
Content types that are acceptable for the request. Currently we support application/json. This is present only for PUT/POST Methods.
{
"default": "application\/json"
}tenant specific to Application/Consumer which is being used to fetch the Application/Consumer specific Alert templates
List of acceptable human languages for response in ISO format
Successful operation.
Missing or invalid Parameters
Authorization token is missing or invalid
The request operation is not configured to access this resource
The requested resource was not found
The request failed due to an internal error/server unavailability
Definitions
{
"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"
}
}
}
}
}
}
}
}
}
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"example": "1463747186587"
}
}
}
{
"properties": {
"type": {
"type": "string",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again
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
error - The request was accepted but could not be processed successfully
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
",
"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"
]
}