{ "openapi" : "3.1.1", "info" : { "x-api-id" : "6f4d2ab6-26f1-498d-be88-ea7a6b037aeb", "title" : "Alliance Workflow API", "description" : "This API enables third-party applications to integrate with Alliance Access in order to consume financial messages for processing and send back the results.\n\n**v1.0.1-for-alliance-access Release Notes**\n* Fixes wrong format for ids query parameter value.\n", "version" : "1.0.1-for-alliance-access", "x-audience" : "component-internal", "contact" : { "name" : "Developer Hub", "url" : "https://developer.swift.com", "email" : "developer-support@swift.com" }, "license" : { "name" : "API Restricted License", "url" : "https://developer.swift.com/api-license" } }, "tags" : [ { "name" : "Poll Pending Financial Messages", "description" : "Operations used to get the list of financial messages to process." }, { "name" : "Read Financial Messages", "description" : "Operations used to retrieve messages and their metadata." }, { "name" : "Data Flow", "description" : "Operations used to interact with the Alliance Workflow." } ], "security" : [ { "mutualTLS" : [ ] } ], "servers" : [ { "description" : "A placeholder to be used when the API is exposed inside customers' premises.", "url" : "https://localhost/alliance-workflow/v1" } ], "paths" : { "/messages" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read the full financial messages, including their payload, history and metadata.", "description" : "Read the full financial messages, including their payload, history and metadata.\nIt also gives back the status in which the financial messages currently are and their related workflow action ID.", "operationId" : "getSlashMessages", "parameters" : [ { "$ref" : "#/components/parameters/GetSlashMessages_QueryParameter_ids" } ], "responses" : { "200" : { "description" : "A list of full financial messages, including payload, history and metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Messages" }, "examples" : { "A list of full financial messages" : { "$ref" : "#/components/examples/Messages" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/messages/history" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read only the message histories, including some metadata.", "description" : "Read only the message histories, including some metadata.\nIt also gives back the status in which the financial messages currently are and their related workflow action ID.", "operationId" : "getSlashMessagesSlashHistory", "parameters" : [ { "$ref" : "#/components/parameters/GetSlashMessagesSlashHistory_QueryParameter_ids" } ], "responses" : { "200" : { "description" : "A list of message histories, including some metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessageHistories" }, "examples" : { "A list of message histories" : { "$ref" : "#/components/examples/MessageHistories" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/messages/payload" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read only the message payloads, including some metadata.", "description" : "Read only the message payloads, including some metadata.\nIt also gives back the status in which the financial messages currently are and their related workflow action ID.", "operationId" : "getSlashMessagesSlashPayload", "parameters" : [ { "$ref" : "#/components/parameters/GetSlashMessagesSlashPayload_QueryParameter_ids" } ], "responses" : { "200" : { "description" : "A list of message payloads, including some metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagePayloads" }, "examples" : { "A list of message payloads" : { "$ref" : "#/components/examples/MessagePayloads" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/messages/summary" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read only the message summaries, including some metadata.", "description" : "Read only the message summaries, including some metadata.\nIt also gives back the status in which the financial messages currently are and their related workflow action ID.", "operationId" : "getSlashMessagesSlashSummary", "parameters" : [ { "$ref" : "#/components/parameters/GetSlashMessagesSlashSummary_QueryParameter_ids" } ], "responses" : { "200" : { "description" : "A list of message summaries, including some metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessageSummaries" }, "examples" : { "A list of message summaries" : { "$ref" : "#/components/examples/MessageSummaries" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/messages/{message-id}" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read the full financial message, including payload, history and metadata.", "description" : "Read the full financial message, including payload, history and metadata.\nIt also gives back the status in which the financial message currently is and the related workflow action ID.", "operationId" : "getSlashMessagesSlashMessageId", "parameters" : [ { "$ref" : "#/components/parameters/message-id" } ], "responses" : { "200" : { "description" : "The full financial message, including payload, history and metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Message" }, "examples" : { "The full financial message" : { "$ref" : "#/components/examples/Message" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/messages/{message-id}/history" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read only the message history, including some metadata.", "description" : "Read only the message history, including some metadata.\nIt also gives back the status in which the financial message currently is and the related workflow action ID.", "operationId" : "getSlashMessagesSlashMessageIdSlashHistory", "parameters" : [ { "$ref" : "#/components/parameters/message-id" } ], "responses" : { "200" : { "description" : "The message history, including some metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessageHistory" }, "examples" : { "The message history" : { "$ref" : "#/components/examples/MessageHistory" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/messages/{message-id}/payload" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read only the message payload, including some metadata.", "description" : "Read only the message payload, including some metadata.\nIt also gives back the status in which the financial message currently is and the related workflow action ID.", "operationId" : "getSlashMessagesSlashMessageIdSlashPayload", "parameters" : [ { "$ref" : "#/components/parameters/message-id" } ], "responses" : { "200" : { "description" : "The message payload, including some metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessagePayload" }, "examples" : { "The message payload" : { "$ref" : "#/components/examples/MessagePayload" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/messages/{message-id}/summary" : { "get" : { "tags" : [ "Read Financial Messages" ], "summary" : "Read only the message summary, including some metadata.", "description" : "Read only the message summary, including some metadata.\nIt also gives back the status in which the financial message currently is and the related workflow action ID.", "operationId" : "getSlashMessagesSlashMessageIdSlashSummary", "parameters" : [ { "$ref" : "#/components/parameters/message-id" } ], "responses" : { "200" : { "description" : "The message summary, including some metadata.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MessageSummary" }, "examples" : { "The message summary" : { "$ref" : "#/components/examples/MessageSummary" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/workflow-actions" : { "get" : { "tags" : [ "Poll Pending Financial Messages" ], "summary" : "Get a list of workflow actions, each representing a financial message in a dedicated status, waiting for an action from a third party application.", "description" : "Get a list of workflow actions, each representing a financial message in a dedicated status, waiting for an action from a third party application.", "operationId" : "getSlashWorkflowActions", "parameters" : [ { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_limit" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_message_direction" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_message_format" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_message_message_identifier" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_message_receiver_responder" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_message_sender_requestor" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_message_service" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_status" }, { "$ref" : "#/components/parameters/GetSlashWorkflowActions_QueryParameter_token" } ], "responses" : { "200" : { "description" : "A list of workflow actions, each representing a financial message in a dedicated status, waiting for an action from a third party application.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowActions" }, "examples" : { "A list of workflow actions" : { "$ref" : "#/components/examples/WorkflowActions" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } }, "patch" : { "tags" : [ "Data Flow" ], "summary" : "Enable the 3rd party application to transition a batch of financial messages in the interface.", "description" : "Enable the 3rd party application to transition a batch of financial messages in the interface.\nThe Transition will be represented by a free text, that must be aligned with the name of the function result, to later trigger the routing.\nThe API client may optionally send a list of metadata in a list of key/value pairs. The interface application associates the sent metadata with the financial message being processed.", "operationId" : "patchSlashWorkflowActions", "parameters" : [ ], "requestBody" : { "description" : "A batch containing the new Transitions for the Financial Messages.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowActionTransitionUpdates" }, "examples" : { "A batch containing the new Transitions for the Financial Messages" : { "$ref" : "#/components/examples/WorkflowActionTransitionUpdates" } } } } }, "responses" : { "200" : { "description" : "A list of transition statuses.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowActionTransitionStatuses" }, "examples" : { "A list of transition statuses" : { "$ref" : "#/components/examples/WorkflowActionTransitionStatuses" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "413" : { "$ref" : "#/components/responses/413-ContentTooLarge" }, "415" : { "$ref" : "#/components/responses/415-UnsupportedMediaType" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/workflow-actions/{workflow-action-id}" : { "get" : { "tags" : [ "Poll Pending Financial Messages" ], "summary" : "Get a specific workflow action, based on a workflow action ID, representing a financial message in a dedicated status, waiting for an action from a third party application.", "description" : "Get a specific workflow action, based on a workflow action ID, representing a financial message in a dedicated status, waiting for an action from a third party application.", "operationId" : "getSlashWorkflowActionsSlashWorkflowActionId", "parameters" : [ { "$ref" : "#/components/parameters/workflow-action-id" } ], "responses" : { "200" : { "description" : "A specific workflow action, based on a workflow action ID, representing a financial message in a dedicated status, waiting for an action from a third party application.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowAction" }, "examples" : { "A specific workflow action" : { "$ref" : "#/components/examples/WorkflowAction" } } } } }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "406" : { "$ref" : "#/components/responses/406-NotAcceptable" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } }, "/workflow-actions/{workflow-action-id}/transitions" : { "post" : { "tags" : [ "Data Flow" ], "summary" : "Enable the 3rd party application to transition a financial message in the interface.", "description" : "Enable the 3rd party application to transition a financial message in the interface.\nThe Transition will be represented by a free text, that must be aligned with the name of the function result, to later trigger the routing.\nThe API client may optionally send a list of metadata in a list of key/value pairs. The interface application associates the sent metadata with the financial message being processed.", "operationId" : "postSlashWorkflowActionsSlashWorkflowActionIdSlashTransitions", "parameters" : [ { "$ref" : "#/components/parameters/workflow-action-id" } ], "requestBody" : { "description" : "The new Transition for the Financial Message.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowActionTransitionUpdate" }, "examples" : { "The new Transition for the Financial Message" : { "$ref" : "#/components/examples/WorkflowActionTransitionUpdate" } } } } }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "$ref" : "#/components/responses/400-BadRequest" }, "401" : { "$ref" : "#/components/responses/401-Unauthorized" }, "404" : { "$ref" : "#/components/responses/404-NotFound" }, "413" : { "$ref" : "#/components/responses/413-ContentTooLarge" }, "415" : { "$ref" : "#/components/responses/415-UnsupportedMediaType" }, "429" : { "$ref" : "#/components/responses/429-TooManyRequests" }, "500" : { "$ref" : "#/components/responses/500-InternalServerError" }, "503" : { "$ref" : "#/components/responses/503-ServiceUnavailable" } } } } }, "components" : { "securitySchemes" : { "mutualTLS" : { "type" : "mutualTLS" } }, "parameters" : { "message-id" : { "name" : "message-id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/message-id" }, "examples" : { "message-id" : { "$ref" : "#/components/examples/message-id" } } }, "workflow-action-id" : { "name" : "workflow-action-id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/workflow-action-id" }, "examples" : { "workflow-action-id" : { "$ref" : "#/components/examples/workflow-action-id" } } }, "GetSlashWorkflowActions_QueryParameter_limit" : { "name" : "limit", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/limit" }, "examples" : { "limit" : { "$ref" : "#/components/examples/limit" } }, "description" : "When present, it should return the list of results in pagination mode.\nThe maximum number of entries to return per page." }, "GetSlashWorkflowActions_QueryParameter_message_direction" : { "name" : "message_direction", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/message_direction" }, "examples" : { "message_direction" : { "$ref" : "#/components/examples/message_direction" } }, "description" : "Direction of the message, taken from the perspective of the interface. A message sent, by the interface to the Swift network, is OUTGOING. A message received, from the Swift network to the interface, is INCOMING." }, "GetSlashWorkflowActions_QueryParameter_message_format" : { "name" : "message_format", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/message_format" }, "examples" : { "message_format" : { "$ref" : "#/components/examples/message_format" } }, "description" : "Format of the message." }, "GetSlashWorkflowActions_QueryParameter_message_message_identifier" : { "name" : "message_message_identifier", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/message_message_identifier" }, "examples" : { "message_message_identifier" : { "$ref" : "#/components/examples/message_message_identifier" } }, "description" : "Message identifier of the message." }, "GetSlashWorkflowActions_QueryParameter_message_receiver_responder" : { "name" : "message_receiver_responder", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/message_receiver_responder" }, "examples" : { "message_receiver_responder" : { "$ref" : "#/components/examples/message_receiver_responder" } }, "description" : "The network address of the receiver of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files." }, "GetSlashWorkflowActions_QueryParameter_message_sender_requestor" : { "name" : "message_sender_requestor", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/message_sender_requestor" }, "examples" : { "message_sender_requestor" : { "$ref" : "#/components/examples/message_sender_requestor" } }, "description" : "The network address of the sender of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files." }, "GetSlashWorkflowActions_QueryParameter_message_service" : { "name" : "message_service", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/message_service" }, "examples" : { "message_service" : { "$ref" : "#/components/examples/message_service" } }, "description" : "Name of SwiftNet service." }, "GetSlashWorkflowActions_QueryParameter_status" : { "name" : "status", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/status" }, "examples" : { "status" : { "$ref" : "#/components/examples/status" } }, "description" : "Status of the workflow action." }, "GetSlashWorkflowActions_QueryParameter_token" : { "name" : "token", "in" : "query", "required" : false, "schema" : { "$ref" : "#/components/schemas/token" }, "examples" : { "token" : { "$ref" : "#/components/examples/token" } }, "description" : "When present, it should return the list of results in pagination mode.\nAn opaque token used to retrieve the next page." }, "GetSlashMessages_QueryParameter_ids" : { "name" : "ids", "in" : "query", "explode" : false, "required" : true, "schema" : { "$ref" : "#/components/schemas/ids" }, "examples" : { "ids" : { "$ref" : "#/components/examples/ids" } }, "description" : "The list of message identifiers to be retrieved." }, "GetSlashMessagesSlashSummary_QueryParameter_ids" : { "name" : "ids", "in" : "query", "explode" : false, "required" : true, "schema" : { "$ref" : "#/components/schemas/ids" }, "examples" : { "ids" : { "$ref" : "#/components/examples/ids" } }, "description" : "The list of message identifiers to be retrieved." }, "GetSlashMessagesSlashPayload_QueryParameter_ids" : { "name" : "ids", "in" : "query", "explode" : false, "required" : true, "schema" : { "$ref" : "#/components/schemas/ids" }, "examples" : { "ids" : { "$ref" : "#/components/examples/ids" } }, "description" : "The list of message identifiers to be retrieved." }, "GetSlashMessagesSlashHistory_QueryParameter_ids" : { "name" : "ids", "in" : "query", "explode" : false, "required" : true, "schema" : { "$ref" : "#/components/schemas/ids" }, "examples" : { "ids" : { "$ref" : "#/components/examples/ids" } }, "description" : "The list of message identifiers to be retrieved." } }, "responses" : { "400-BadRequest" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "401-Unauthorized" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "404-NotFound" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "406-NotAcceptable" : { "description" : "Not Acceptable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "413-ContentTooLarge" : { "description" : "Content Too Large", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "415-UnsupportedMediaType" : { "description" : "Unsupported Media Type", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "429-TooManyRequests" : { "description" : "Too Many Requests", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "500-InternalServerError" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } }, "503-ServiceUnavailable" : { "description" : "Service Unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "examples" : { "Error" : { "$ref" : "#/components/examples/Error" } } } } } }, "schemas" : { "Error" : { "type" : "object", "additionalProperties" : false, "required" : [ "code", "severity", "text" ], "properties" : { "code" : { "type" : "string", "maxLength" : 30, "description" : "Identifies the type of error, and the system or service where the error originated." }, "severity" : { "type" : "string", "enum" : [ "Fatal", "Transient" ], "description" : "Fatal errors are permanent, and any request should not be retried without modifications. Transient errors are temporary, and any request can be retried after some time." }, "text" : { "type" : "string", "maxLength" : 255, "description" : "Describes technical details of the error." }, "user_message" : { "type" : "string", "maxLength" : 255, "description" : "Contains a non technical, user-friendly error message suitable for display in a GUI or a CLI." }, "more_info" : { "type" : "string", "format" : "uri", "description" : "Points to a resource containing more details about the error." } }, "description" : "An error returned when the API call fails." }, "MessageHistories" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MessageHistory" }, "minItems" : 1, "uniqueItems" : true }, "MessageHistory" : { "description" : "Local object, only used for 'allOf' usage in schema.", "type" : "object", "properties" : { "created_by" : { "description" : "Name of the creator of the message. Depending on 'creator' value, this fields will either contain an operator name, or the name of the application that created the message.", "type" : "string" }, "creation_date" : { "description" : "Date and time of the creation of the message.", "type" : "string", "format" : "date-time" }, "creator" : { "description" : "Name of an operator on interface application that created the message.", "type" : "string", "enum" : [ "BACK_OFFICE", "GUI", "SWIFTNET_INTERFACE", "FIN_INTERFACE", "OTHER" ] }, "direction" : { "description" : "Direction of the message, taken from the perspective of Swift network.", "type" : "string", "enum" : [ "INCOMING", "OUTGOING" ] }, "format" : { "description" : "Format of the message.", "type" : "string", "enum" : [ "SWIFT", "XML", "FILE", "OTHER" ] }, "id" : { "description" : "Unique identifier of the message in the interface application.", "type" : "string" }, "last_modification_date" : { "description" : "Date and time of the last modification of the message.", "type" : "string", "format" : "date-time" }, "message_identifier" : { "description" : "Message identifier of the message.", "type" : "string" }, "message_user_reference" : { "description" : "User Reference of the message.", "type" : "string" }, "modified_by" : { "description" : "Name of the last operator on the interface application that modified the message.", "type" : "string" }, "network_priority" : { "description" : "Priority to deliver a message over the Swift network.", "type" : "string", "enum" : [ "SYSTEM", "URGENT", "NORMAL" ] }, "possible_duplicate" : { "description" : "Indicates if the message is flagged as duplicate in the interface application.", "type" : "boolean" }, "receiver_responder" : { "description" : "The network address of the receiver of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "sender_message_reference" : { "description" : "Sender Reference of the message.", "type" : "string" }, "sender_requestor" : { "description" : "The network address of the sender of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "service" : { "description" : "Name of SwiftNet service.", "type" : "string" }, "touched_by_human" : { "description" : "Indicates if the message was touched at least once by a human operator on the interface application.", "type" : "boolean" }, "uetr" : { "description" : "Unique End-to-end Transaction Reference (UETR) of the message, used to uniquely identify a gpi payment transaction and all messages in that transaction.", "type" : "string" }, "unit" : { "description" : "Specific to Access - Name of the unit assigned to the message instance.", "type" : "string" }, "url" : { "description" : "URL to retrieve the related message (HATEOAS pattern).", "type" : "string" }, "usage_identifier" : { "description" : "Structured ID that identified the 'usage guideline' that is applicable to the message.", "type" : "string" }, "workflow_action" : { "$ref" : "#/components/schemas/WorkflowActionHeader" }, "history" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HistoryLine" }, "minItems" : 0, "uniqueItems" : true } }, "required" : [ "created_by", "creation_date", "creator", "direction", "format", "id", "last_modification_date", "message_identifier", "modified_by", "possible_duplicate", "receiver_responder", "sender_requestor", "service", "touched_by_human", "url", "workflow_action", "history" ], "additionalProperties" : false }, "WorkflowActionHeader" : { "description" : "Header of a workflow action", "type" : "object", "properties" : { "id" : { "description" : "Unique identifier of the workflow action.", "type" : "string" }, "status" : { "description" : "Current status of the workflow action, representing the status on which the related message currently is.", "type" : "string" } }, "required" : [ "id", "status" ], "additionalProperties" : false }, "HistoryLine" : { "description" : "A history line representing an action or intervention that happened on the message.", "type" : "object", "properties" : { "description" : { "description" : "Text description of the history line", "type" : "string" }, "instance_number" : { "description" : "Number of the instance of the message for which the history line applies to", "type" : "integer" }, "instance_type" : { "description" : "Type of instance for which the history line applies to", "type" : "string", "enum" : [ "ORIGINAL", "COPY", "NOTIFICATION", "OTHER" ] }, "user" : { "description" : "Name of the operator that initiate the action/intervention triggering the history line.", "type" : "string" }, "sequence_number" : { "description" : "Sequence number of the history line.", "type" : "integer" }, "timestamp" : { "description" : "Date and time of the creation of the history line.", "type" : "string", "format" : "date-time" }, "title" : { "description" : "Title of the history line.", "type" : "string" } }, "required" : [ "description", "user", "sequence_number", "timestamp" ], "additionalProperties" : false }, "MessagePayloads" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MessagePayload" }, "minItems" : 1, "uniqueItems" : true }, "MessagePayload" : { "description" : "Local object, only used for 'allOf' usage in schema.", "type" : "object", "properties" : { "created_by" : { "description" : "Name of the creator of the message. Depending on 'creator' value, this fields will either contain an operator name, or the name of the application that created the message.", "type" : "string" }, "creation_date" : { "description" : "Date and time of the creation of the message.", "type" : "string", "format" : "date-time" }, "creator" : { "description" : "Name of an operator on interface application that created the message.", "type" : "string", "enum" : [ "BACK_OFFICE", "GUI", "SWIFTNET_INTERFACE", "FIN_INTERFACE", "OTHER" ] }, "direction" : { "description" : "Direction of the message, taken from the perspective of Swift network.", "type" : "string", "enum" : [ "INCOMING", "OUTGOING" ] }, "format" : { "description" : "Format of the message.", "type" : "string", "enum" : [ "SWIFT", "XML", "FILE", "OTHER" ] }, "id" : { "description" : "Unique identifier of the message in the interface application.", "type" : "string" }, "last_modification_date" : { "description" : "Date and time of the last modification of the message.", "type" : "string", "format" : "date-time" }, "message_identifier" : { "description" : "Message identifier of the message.", "type" : "string" }, "message_user_reference" : { "description" : "User Reference of the message.", "type" : "string" }, "modified_by" : { "description" : "Name of the last operator on the interface application that modified the message.", "type" : "string" }, "network_priority" : { "description" : "Priority to deliver a message over the Swift network.", "type" : "string", "enum" : [ "SYSTEM", "URGENT", "NORMAL" ] }, "possible_duplicate" : { "description" : "Indicates if the message is flagged as duplicate in the interface application.", "type" : "boolean" }, "receiver_responder" : { "description" : "The network address of the receiver of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "sender_message_reference" : { "description" : "Sender Reference of the message.", "type" : "string" }, "sender_requestor" : { "description" : "The network address of the sender of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "service" : { "description" : "Name of SwiftNet service.", "type" : "string" }, "touched_by_human" : { "description" : "Indicates if the message was touched at least once by a human operator on the interface application.", "type" : "boolean" }, "uetr" : { "description" : "Unique End-to-end Transaction Reference (UETR) of the message, used to uniquely identify a gpi payment transaction and all messages in that transaction.", "type" : "string" }, "unit" : { "description" : "Specific to Access - Name of the unit assigned to the message instance.", "type" : "string" }, "url" : { "description" : "URL to retrieve the related message (HATEOAS pattern).", "type" : "string" }, "usage_identifier" : { "description" : "Structured ID that identified the 'usage guideline' that is applicable to the message.", "type" : "string" }, "workflow_action" : { "$ref" : "#/components/schemas/WorkflowActionHeader" }, "body" : { "description" : "Business payload of the message, base64 encoded. For ISO20022 messages, this field contains both the Application Header (if present) and the Document XML fragments.", "type" : "string", "format" : "byte" } }, "required" : [ "created_by", "creation_date", "creator", "direction", "format", "id", "last_modification_date", "message_identifier", "modified_by", "possible_duplicate", "receiver_responder", "sender_requestor", "service", "touched_by_human", "url", "workflow_action", "body" ], "additionalProperties" : false }, "MessageSummaries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MessageSummary" }, "minItems" : 1, "uniqueItems" : true }, "MessageSummary" : { "description" : "Local object, only used for 'allOf' usage in schema.", "type" : "object", "properties" : { "created_by" : { "description" : "Name of the creator of the message. Depending on 'creator' value, this fields will either contain an operator name, or the name of the application that created the message.", "type" : "string" }, "creation_date" : { "description" : "Date and time of the creation of the message.", "type" : "string", "format" : "date-time" }, "creator" : { "description" : "Name of an operator on interface application that created the message.", "type" : "string", "enum" : [ "BACK_OFFICE", "GUI", "SWIFTNET_INTERFACE", "FIN_INTERFACE", "OTHER" ] }, "direction" : { "description" : "Direction of the message, taken from the perspective of Swift network.", "type" : "string", "enum" : [ "INCOMING", "OUTGOING" ] }, "format" : { "description" : "Format of the message.", "type" : "string", "enum" : [ "SWIFT", "XML", "FILE", "OTHER" ] }, "id" : { "description" : "Unique identifier of the message in the interface application.", "type" : "string" }, "last_modification_date" : { "description" : "Date and time of the last modification of the message.", "type" : "string", "format" : "date-time" }, "message_identifier" : { "description" : "Message identifier of the message.", "type" : "string" }, "message_user_reference" : { "description" : "User Reference of the message.", "type" : "string" }, "modified_by" : { "description" : "Name of the last operator on the interface application that modified the message.", "type" : "string" }, "network_priority" : { "description" : "Priority to deliver a message over the Swift network.", "type" : "string", "enum" : [ "SYSTEM", "URGENT", "NORMAL" ] }, "possible_duplicate" : { "description" : "Indicates if the message is flagged as duplicate in the interface application.", "type" : "boolean" }, "receiver_responder" : { "description" : "The network address of the receiver of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "sender_message_reference" : { "description" : "Sender Reference of the message.", "type" : "string" }, "sender_requestor" : { "description" : "The network address of the sender of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "service" : { "description" : "Name of SwiftNet service.", "type" : "string" }, "touched_by_human" : { "description" : "Indicates if the message was touched at least once by a human operator on the interface application.", "type" : "boolean" }, "uetr" : { "description" : "Unique End-to-end Transaction Reference (UETR) of the message, used to uniquely identify a gpi payment transaction and all messages in that transaction.", "type" : "string" }, "unit" : { "description" : "Specific to Access - Name of the unit assigned to the message instance.", "type" : "string" }, "url" : { "description" : "URL to retrieve the related message (HATEOAS pattern).", "type" : "string" }, "usage_identifier" : { "description" : "Structured ID that identified the 'usage guideline' that is applicable to the message.", "type" : "string" }, "workflow_action" : { "$ref" : "#/components/schemas/WorkflowActionHeader" } }, "required" : [ "created_by", "creation_date", "creator", "direction", "format", "id", "last_modification_date", "message_identifier", "modified_by", "possible_duplicate", "receiver_responder", "sender_requestor", "service", "touched_by_human", "url", "workflow_action" ], "additionalProperties" : false }, "Messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "minItems" : 1, "uniqueItems" : true }, "Message" : { "description" : "Local object, only used for 'allOf' usage in schema.", "type" : "object", "properties" : { "created_by" : { "description" : "Name of the creator of the message. Depending on 'creator' value, this fields will either contain an operator name, or the name of the application that created the message.", "type" : "string" }, "creation_date" : { "description" : "Date and time of the creation of the message.", "type" : "string", "format" : "date-time" }, "creator" : { "description" : "Name of an operator on interface application that created the message.", "type" : "string", "enum" : [ "BACK_OFFICE", "GUI", "SWIFTNET_INTERFACE", "FIN_INTERFACE", "OTHER" ] }, "direction" : { "description" : "Direction of the message, taken from the perspective of Swift network.", "type" : "string", "enum" : [ "INCOMING", "OUTGOING" ] }, "format" : { "description" : "Format of the message.", "type" : "string", "enum" : [ "SWIFT", "XML", "FILE", "OTHER" ] }, "id" : { "description" : "Unique identifier of the message in the interface application.", "type" : "string" }, "last_modification_date" : { "description" : "Date and time of the last modification of the message.", "type" : "string", "format" : "date-time" }, "message_identifier" : { "description" : "Message identifier of the message.", "type" : "string" }, "message_user_reference" : { "description" : "User Reference of the message.", "type" : "string" }, "modified_by" : { "description" : "Name of the last operator on the interface application that modified the message.", "type" : "string" }, "network_priority" : { "description" : "Priority to deliver a message over the Swift network.", "type" : "string", "enum" : [ "SYSTEM", "URGENT", "NORMAL" ] }, "possible_duplicate" : { "description" : "Indicates if the message is flagged as duplicate in the interface application.", "type" : "boolean" }, "receiver_responder" : { "description" : "The network address of the receiver of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "sender_message_reference" : { "description" : "Sender Reference of the message.", "type" : "string" }, "sender_requestor" : { "description" : "The network address of the sender of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "service" : { "description" : "Name of SwiftNet service.", "type" : "string" }, "touched_by_human" : { "description" : "Indicates if the message was touched at least once by a human operator on the interface application.", "type" : "boolean" }, "uetr" : { "description" : "Unique End-to-end Transaction Reference (UETR) of the message, used to uniquely identify a gpi payment transaction and all messages in that transaction.", "type" : "string" }, "unit" : { "description" : "Specific to Access - Name of the unit assigned to the message instance.", "type" : "string" }, "url" : { "description" : "URL to retrieve the related message (HATEOAS pattern).", "type" : "string" }, "usage_identifier" : { "description" : "Structured ID that identified the 'usage guideline' that is applicable to the message.", "type" : "string" }, "workflow_action" : { "$ref" : "#/components/schemas/WorkflowActionHeader" }, "body" : { "description" : "Business payload of the message, base64 encoded. For ISO20022 messages, this field contains both the Application Header (if present) and the Document XML fragments.", "type" : "string", "format" : "byte" }, "history" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HistoryLine" }, "minItems" : 0, "uniqueItems" : true } }, "required" : [ "created_by", "creation_date", "creator", "direction", "format", "id", "last_modification_date", "message_identifier", "modified_by", "possible_duplicate", "receiver_responder", "sender_requestor", "service", "touched_by_human", "url", "workflow_action", "body", "history" ], "additionalProperties" : false }, "WorkflowAction" : { "description" : "Workflow action representing the interface waiting to perform an action on a specific message.", "type" : "object", "properties" : { "id" : { "description" : "Unique identifier of the workflow action.", "type" : "string" }, "status" : { "description" : "Current status of the workflow action, representing the status on which the related message currently is.", "type" : "string" }, "message" : { "$ref" : "#/components/schemas/MessageHeader" } }, "required" : [ "id", "status", "message" ], "additionalProperties" : false }, "MessageHeader" : { "description" : "Header containing the main metadata of a message.", "type" : "object", "properties" : { "direction" : { "description" : "Direction of the message, taken from the perspective of Swift network.", "type" : "string", "enum" : [ "INCOMING", "OUTGOING" ] }, "format" : { "description" : "Format of the message.", "type" : "string", "enum" : [ "SWIFT", "XML", "FILE", "OTHER" ] }, "id" : { "description" : "Unique identifier of the message in the interface application.", "type" : "string" }, "message_identifier" : { "description" : "Message identifier of the message.", "type" : "string" }, "receiver_responder" : { "description" : "The network address of the receiver of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "sender_requestor" : { "description" : "The network address of the sender of the message, expressed as a Logical Terminal on FIN (12 character BIC) for MT messages, or as a Distinguished Name (DN) on InterAct for MX messages or on FileAct for files.", "type" : "string" }, "service" : { "description" : "Name of SwiftNet service.", "type" : "string" }, "url" : { "description" : "URL to retrieve the related message (HATEOAS pattern).", "type" : "string" } }, "required" : [ "direction", "format", "id", "message_identifier", "receiver_responder", "sender_requestor", "service", "url" ], "additionalProperties" : false }, "WorkflowActions" : { "type" : "object", "properties" : { "workflow_actions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowAction" }, "minItems" : 0, "uniqueItems" : true }, "links" : { "type" : "object", "properties" : { "next" : { "description" : "The URL to the next page when results are returned through pagination.", "type" : "string", "format" : "uri-reference" } }, "required" : [ "next" ], "additionalProperties" : false } }, "required" : [ "workflow_actions" ], "additionalProperties" : false }, "WorkflowActionTransitionStatuses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowActionTransitionStatus" }, "minItems" : 1, "uniqueItems" : true }, "WorkflowActionTransitionStatus" : { "description" : "Status of a workflow action transition", "type" : "object", "properties" : { "workflow_action_identifier" : { "description" : "The unique identifier of the Workflow Action.", "type" : "string", "format" : "uuid" }, "transition_status" : { "description" : "Status of the individual transition", "type" : "string", "enum" : [ "SUCCESS", "NOT_FOUND", "BAD_REQUEST", "FAILURE" ] }, "error_details" : { "description" : "Optional error message, if the transition is not successful", "type" : "string" } }, "required" : [ "workflow_action_identifier", "transition_status" ], "additionalProperties" : false }, "WorkflowActionTransitionUpdates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowActionTransitionUpdateWithWorkflowActionIdentifier" }, "minItems" : 1, "uniqueItems" : true }, "WorkflowActionTransitionUpdateWithWorkflowActionIdentifier" : { "description" : "", "type" : "object", "properties" : { "workflow_action_identifier" : { "description" : "The unique identifier of the Workflow Action.", "type" : "string", "format" : "uuid" }, "workflow_action_transition_update" : { "$ref" : "#/components/schemas/WorkflowActionTransitionUpdate" } }, "required" : [ "workflow_action_identifier", "workflow_action_transition_update" ], "additionalProperties" : false }, "WorkflowActionTransitionUpdate" : { "description" : "", "type" : "object", "properties" : { "properties" : { "description" : "List of extra properties to be propagated to the message, when applying a transition", "type" : "array", "items" : { "$ref" : "#/components/schemas/Property" } }, "current_status" : { "description" : "Current status of the workflow action, representing the status on which the related message currently is.", "type" : "string" }, "delivery_details" : { "description" : "Details of the delivery to be added on the message during the transition, to describe delivery.", "type" : "string" }, "delivery_status" : { "description" : "Delivery status to be added on the message during the transition, to flag the message with a the related status.", "type" : "string", "enum" : [ "TIMED_OUT", "ACKED", "NACKED", "REJECTED_LOCALLY", "ABORTED" ] }, "description" : { "description" : "Description of the transition to be applied on the message, describing the reason why this transition is requested.", "type" : "string" }, "transition_name" : { "description" : "Name of the transition to be applied on the message.", "type" : "string" } }, "required" : [ "current_status", "transition_name" ], "additionalProperties" : false }, "Property" : { "description" : "Property of message represented by a key-value pair", "type" : "object", "properties" : { "name" : { "description" : "Name of the property.", "type" : "string" }, "value" : { "description" : "Value of the property.", "type" : "string" } }, "required" : [ "name", "value" ], "additionalProperties" : false }, "status" : { "type" : "string" }, "message_direction" : { "type" : "string", "enum" : [ "INCOMING", "OUTGOING" ] }, "message_format" : { "type" : "string", "enum" : [ "SWIFT", "XML", "FILE", "OTHER" ] }, "message_message_identifier" : { "type" : "string" }, "message_receiver_responder" : { "type" : "string" }, "message_sender_requestor" : { "type" : "string" }, "message_service" : { "type" : "string" }, "token" : { "type" : "string", "pattern" : "^((([A-Za-z0-9+/]{4})*)([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==))$" }, "limit" : { "type" : "integer", "minimum" : 1, "maximum" : 100, "default" : 25 }, "ids" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/message-id" }, "minItems" : 1, "maxItems" : 100 }, "message-id" : { "type" : "string", "pattern" : "^[A-Z0-9]{16}~[0-9]+$" }, "workflow-action-id" : { "type" : "string", "format" : "byte" } }, "examples" : { "Error" : { "value" : { "code" : "Swift.Service.Error1", "severity" : "Fatal", "text" : "Description of Swift.Service.Error1." } }, "MessageHistories" : { "value" : [ { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF20", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "sender_requestor" : "o=sndrbic8,o=swift", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" }, "history" : [ { "description" : "Created at [exampleQueueName] and assigned to unit [Unit1], priority [7]", "instance_number" : 0, "instance_type" : "ORIGINAL", "user" : "SYSTEM", "sequence_number" : 0, "timestamp" : "2012-04-23T18:25:43Z", "title" : "Instance created" }, { "description" : "Routed from [exampleQueueName] to [exampleSecondQueueName]; On Processing by Function xxxx with result Success;(Rule:USER,100)", "instance_number" : 1, "instance_type" : "COPY", "user" : "SYSTEM", "sequence_number" : 1, "timestamp" : "2012-04-23T18:25:44Z", "title" : "Intsance routed" } ] } ] }, "MessageHistory" : { "value" : { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "sender_requestor" : "o=sndrbic8,o=swift", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" }, "history" : [ { "description" : "Created at [exampleQueueName] and assigned to unit [Unit1], priority [7]", "instance_number" : 0, "instance_type" : "ORIGINAL", "user" : "SYSTEM", "sequence_number" : 0, "timestamp" : "2012-04-23T18:25:43Z", "title" : "Instance created" }, { "description" : "Routed from [exampleQueueName] to [exampleSecondQueueName]; On Processing by Function xxxx with result Success;(Rule:USER,100)", "instance_number" : 1, "instance_type" : "COPY", "user" : "SYSTEM", "sequence_number" : 1, "timestamp" : "2012-04-23T18:25:44Z", "title" : "Intsance routed" } ] } }, "MessagePayloads" : { "value" : [ { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "sender_requestor" : "o=sndrbic8,o=swift", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" }, "body" : "TG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgdE9yRXJyPgogICAgPC9SdHJMbXQ+CjwvRG9jdW1lbnQ+Cg==" } ] }, "MessagePayload" : { "value" : { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_requestor" : "o=sndrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" }, "body" : "TG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgdE9yRXJyPgogICAgPC9SdHJMbXQ+CjwvRG9jdW1lbnQ+Cg==" } }, "MessageSummaries" : { "value" : [ { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_requestor" : "o=sndrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" } } ] }, "MessageSummary" : { "value" : { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_requestor" : "o=sndrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" } } }, "Messages" : { "value" : [ { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_requestor" : "o=sndrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" }, "body" : "TG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgdE9yRXJyPgogICAgPC9SdHJMbXQ+CjwvRG9jdW1lbnQ+Cg==", "history" : [ { "description" : "Created at [exampleQueueName] and assigned to unit [Unit1], priority [7]", "instance_number" : 0, "instance_type" : "ORIGINAL", "user" : "SYSTEM", "sequence_number" : 0, "timestamp" : "2012-04-23T18:25:43Z", "title" : "Instance created" }, { "description" : "Routed from [exampleQueueName] to [exampleSecondQueueName]; On Processing by Function xxxx with result Success;(Rule:USER,100)", "instance_number" : 1, "instance_type" : "COPY", "user" : "SYSTEM", "sequence_number" : 1, "timestamp" : "2012-04-23T18:25:44Z", "title" : "Intsance routed" } ] } ] }, "Message" : { "value" : { "created_by" : "operator_name", "creation_date" : "2012-04-23T18:25:43Z", "creator" : "GUI", "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "last_modification_date" : "2012-04-23T18:30:43Z", "message_identifier" : "pacs.009.001.08", "message_user_reference" : "exampleuserreference", "modified_by" : "modifier_operator_name", "network_priority" : "NORMAL", "possible_duplicate" : false, "receiver_responder" : "o=rcvrbic8,o=swift", "sender_message_reference" : "examplesenderreference", "sender_requestor" : "o=sndrbic8,o=swift", "service" : "swift.finplus", "touched_by_human" : true, "uetr" : "f59411ee-9491-40b7-87a6-734bb2037881", "unit" : "Unit1", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0", "usage_identifier" : "swift.cbprplus.01", "workflow_action" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ", "status" : "exampleStatusName" }, "body" : "TG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgTG10Q3RyUHR5SWQ+CiAgICAgICAgICAgICAgICAgICAgICAgIDxUcD4KICAgICAgdE9yRXJyPgogICAgPC9SdHJMbXQ+CjwvRG9jdW1lbnQ+Cg==", "history" : [ { "description" : "Created at [exampleQueueName] and assigned to unit [Unit1], priority [7]", "instance_number" : 0, "instance_type" : "ORIGINAL", "user" : "SYSTEM", "sequence_number" : 0, "timestamp" : "2012-04-23T18:25:43Z", "title" : "Instance created" }, { "description" : "Routed from [exampleQueueName] to [exampleSecondQueueName]; On Processing by Function xxxx with result Success;(Rule:USER,100)", "instance_number" : 1, "instance_type" : "COPY", "user" : "SYSTEM", "sequence_number" : 1, "timestamp" : "2012-04-23T18:25:44Z", "title" : "Intsance routed" } ] } }, "WorkflowAction" : { "value" : { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ=", "message" : { "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "message_identifier" : "pacs.009.001.08", "receiver_responder" : "o=rcvrbic8,o=swift", "sender_requestor" : "o=sndrbic8,o=swift", "service" : "swift.finplus", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0" }, "status" : "exampleStatusName" } }, "WorkflowActions" : { "value" : { "workflow_actions" : [ { "id" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ=", "message" : { "direction" : "INCOMING", "format" : "XML", "id" : "1809DC60FFFFFFF2~0", "message_identifier" : "pacs.009.001.08", "receiver_responder" : "o=rcvrbic8,o=swift", "sender_requestor" : "o=sndrbic8,o=swift", "service" : "swift.finplus", "url" : "/alliance-workflow/v0/messages/1809DC60FFFFFFF2~0" }, "status" : "exampleStatusName" }, { "id" : "ZEdocGMybHpZVzVsZUdGdGNHeGxiMlpoYm1sa2RHOWlaV0poYzJVMk5HVnVZMjlr=", "message" : { "direction" : "OUTGOING", "format" : "SWIFT", "id" : "1105DC50FFFFFFF2~1", "message_identifier" : "fin.103", "receiver_responder" : "RCVRBIC8XXX", "sender_requestor" : "SNDRBIC8XXX", "service" : "swift.fin", "url" : "/alliance-workflow/v0/messages/1105DC50FFFFFFF2~1" }, "status" : "anotherExampleStatusName" } ], "links" : { "next" : "/alliance-workflow/v0/workflow_actions?limit=25&token=IjdJdjkA1jkjGdGNHeGxiMlpoYm1sa2RHOWlaV0poYzJVMk5HVnVZMjlr=" } } }, "WorkflowActionTransitionStatuses" : { "value" : [ { "workflow_action_identifier" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ=", "transition_status" : "SUCCESS" }, { "workflow_action_identifier" : "ZEdocGMybHpZVzVsZUdGdGNHeGxiMlpoYm1sa2RHOWlaV0poYzJVMk5HVnVZMjlr=", "transition_status" : "FAILURE", "error_details" : "Unexpected error occurred." } ] }, "WorkflowActionTransitionUpdates" : { "value" : [ { "workflow_action_identifier" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ=", "workflow_action_transition_update" : { "current_status" : "exampleStatusName", "delivery_details" : "ABORTED", "delivery_status" : "ABORTED", "description" : "My description", "properties" : [ { "name" : "exampleFirstName", "value" : "exampleFirstValue" }, { "name" : "exampleSecondName", "value" : "exampleSecondValue" } ], "transition_name" : "exampleTransitionName" } }, { "workflow_action_identifier" : "ZEdocGMybHpZVzVsZUdGdGNHeGxiMlpoYm1sa2RHOWlaV0poYzJVMk5HVnVZMjlr=", "workflow_action_transition_update" : { "current_status" : "anotherExampleStatusName", "delivery_details" : "ACK", "delivery_status" : "ACKED", "description" : "My description", "properties" : [ { "name" : "exampleFirstName", "value" : "exampleFirstValue" }, { "name" : "exampleSecondName", "value" : "exampleSecondValue" } ], "transition_name" : "exampleTransitionName" } } ] }, "WorkflowActionTransitionUpdate" : { "value" : { "current_status" : "exampleStatusName", "delivery_details" : "{1:F21BOFAPH2XAXXX000057000014094}{4:{177:2105041206}{451:1}{405:T03}{311:NAK}}", "delivery_status" : "REJECTED_LOCALLY", "description" : "My description", "properties" : [ { "name" : "exampleFirstName", "value" : "exampleFirstValue" }, { "name" : "exampleSecondName", "value" : "exampleSecondValue" } ], "transition_name" : "exampleTransitionName" } }, "status" : { "value" : "exampleStatusName" }, "message_direction" : { "value" : "OUTGOING" }, "message_format" : { "value" : "XML" }, "message_message_identifier" : { "value" : "pacs.009.001.08" }, "message_receiver_responder" : { "value" : "o=rcvrbic8,o=swift" }, "message_sender_requestor" : { "value" : "o=sndrbic8,o=swift" }, "message_service" : { "value" : "swift.finplus" }, "token" : { "value" : "MzA1MQ==" }, "limit" : { "value" : 25 }, "ids" : { "value" : [ "1809DC60FFFFFFF2~0", "17D3AE26FFFFFF9A~1", "1811B1CDFFFFFFCD~0", "18151680FFFFFFF9~0", "18151680FFFFFFF9~1" ] }, "message-id" : { "value" : "1809DC60FFFFFFF2~0" }, "workflow-action-id" : { "value" : "dGhpc2lzYW5leGFtcGxlb2ZhbmlkdG9iZWJhc2U2NGVuY29kZWQ" } } } }