Jump to

• Request
• Response

Update outbound message and processing status

post

/crmRestApi/resources/11.13.18.05/outboundMessages/action/updateOutboundMsgProcessingStatus

This method lets you update the processing status of the outbound message and the processing status object.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• alternateMsgId: string
  The outbound message with unique identifier of the outbound email in the email delivery application.
• objectTypeCode: string
  The source object type code of the outbound message.
• outboundMsgId: number
  Identify outbound message row that need to be updated.
• processingStatusCd: string
  The processing status code of outbound message.
• retryCount: number
  The retry count of the outbound message.
• statusDetails: string
  The status details of the outbound message.

{
    "type":"object",
    "properties":{
        "objectTypeCode":{
            "type":"string",
            "description":"The source object type code of the outbound message.",
            "nullable":true
        },
        "alternateMsgId":{
            "type":"string",
            "description":"The outbound message with unique identifier of the outbound email in the email delivery application.",
            "nullable":true
        },
        "outboundMsgId":{
            "type":"number",
            "description":"Identify outbound message row that need to be updated.",
            "nullable":true
        },
        "processingStatusCd":{
            "type":"string",
            "description":"The processing status code of outbound message.",
            "nullable":true
        },
        "retryCount":{
            "type":"number",
            "description":"The retry count of the outbound message.",
            "nullable":true
        },
        "statusDetails":{
            "type":"string",
            "description":"The status details of the outbound message.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): boolean
  The response payload includes details of outbound message and processing statuses update.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"boolean",
            "description":"The response payload includes details of outbound message and processing statuses update."
        }
    },
    "additionalProperties":false
}

Back to Top