Skip to main content

ResponseWrapperProductEventMappingDto

Generic API response wrapper for Product-Event Mapping

statusstring

Response status

Possible values: [SUCCESS, ERROR]

Example: SUCCESS
messagestring

Message describing the response

Example: Request successful
codeMessagestring

Code message describing the response

Example: SUC-001
data objectnullable

Product-Event Mapping Data Transfer Object

idstring<uuid>required

Unique identifier of the product-event mapping

Example: 550e8400-e29b-41d4-a716-446655440000
definitionIdstring<uuid>

Reference to product_event_definitions.id (FK)

Example: 660e8400-e29b-41d4-a716-446655440001
userIdstring<uuid>required

Identifier of the user who created the mapping

Example: 550e8400-e29b-41d4-a716-446655440000
moduleCodestringrequired

Module code (TF for Trade Finance, SCF for Supply Chain Finance)

Possible values: <= 10 characters

Example: TF
moduleNamestringrequired

Human-readable module name

Possible values: <= 100 characters

Example: Trade Finance
productCodestringrequired

Product code (e.g., ILC, ELC)

Possible values: <= 50 characters

Example: ILC
productNamestringrequired

Human-readable product name

Possible values: <= 200 characters

Example: Import Letter of Credit
eventCodestringrequired

Event code (e.g., ISS, AMD)

Possible values: <= 50 characters

Example: ISS
eventNamestringrequired

Human-readable event name

Possible values: <= 200 characters

Example: Issuance
targetAudiencestring[]required

List of target audiences for this mapping (Corporate, Bank, Agent)

Possible values: [Corporate, Bank, Agent]

Example: ["Corporate","Bank"]
businessApplicationstring[]required

List of business applications (Adria TSCF Client, Adria Process Orchestrator, Adria TSCF Bank)

Example: ["Adria TSCF Client","Adria Process Orchestrator"]
createdAtstring<date-time>

Timestamp when the mapping was created

Example: 2025-01-15T09:36:22.500Z
updatedAtstring<date-time>

Timestamp when the mapping was last updated

Example: 2025-01-15T09:36:22.500Z
error objectnullable

Details of any error that occurred

codestring

Error code

Example: ERR_GENERAL_0004
messagestring

Human-readable error message

Example: The requested resource was not found
details object[]

List of error details

  • Array [
  • codestring

    Specific error code

    Example: ER4001
    messagestring

    What went wrong

    Example: Invalid input
    targetstring

    Field that caused the issue

    Example: productCode
  • ]
  • suggestionsstring[]

    Suggested actions to resolve the error

    Example: ["Check the resource ID","Ensure the resource exists"]
    metaData object

    Additional metadata about the error

    property name*string
    timestampstring<date-time>

    Timestamp of when the response was generated

    Example: 2025-01-15T09:36:22.500Z
    ResponseWrapperProductEventMappingDto
    {
    "status": "SUCCESS",
    "message": "Request successful",
    "codeMessage": "SUC-001",
    "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "definitionId": "660e8400-e29b-41d4-a716-446655440001",
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "moduleCode": "TF",
    "moduleName": "Trade Finance",
    "productCode": "ILC",
    "productName": "Import Letter of Credit",
    "eventCode": "ISS",
    "eventName": "Issuance",
    "targetAudience": [
    "Corporate",
    "Bank"
    ],
    "businessApplication": [
    "Adria TSCF Client",
    "Adria Process Orchestrator"
    ],
    "createdAt": "2025-01-15T09:36:22.500Z",
    "updatedAt": "2025-01-15T09:36:22.500Z"
    },
    "error": {
    "code": "ERR_GENERAL_0004",
    "message": "The requested resource was not found",
    "details": [
    {
    "code": "ER4001",
    "message": "Invalid input",
    "target": "productCode"
    }
    ],
    "suggestions": [
    "Check the resource ID",
    "Ensure the resource exists"
    ],
    "metaData": {}
    },
    "timestamp": "2025-01-15T09:36:22.500Z"
    }