Jump to

• Request
• Response

View Business Message Payload

get

/ic/api/b2b/v1/monitoring/businessmessages/{id}/payload

Displays the business message payload up to a maximum size of 500 KB. To view the complete content, use the Download B2B Business Message Payload API function to download the complete payload, and then view it.

Note:

Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.

Request

Path Parameters

• id(required): string
  Business message payload ID.

Query Parameters

• payloadId: string
  Payload ID.
• type: string
  Business message payload type.

  Default Value: native

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : PayloadRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object PayloadRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "content":{
                    "type":"string"
                },
                "truncated":{
                    "type":"boolean"
                },
                "title":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : PayloadRs-allOf[2]

Type: object

Show Source

• content: string
• title: string
• truncated: boolean

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string"
        },
        "truncated":{
            "type":"boolean"
        },
        "title":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

404 Response

Payload not found

500 Response

Server error

Back to Top