Jump to

• Request
• Response

Search email message statuses

post

/crmRestApi/resources/11.13.18.05/inboundMessages/action/searchEmailMessageStatuses

The method searches email message statuses using sender, recipient, and optional time range filters.

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

• fromTime: string
  The start date and time.
• recipient: string
  The email address of the recipient.
• sender: string
  The email address of the sender.
• toTime: string
  The end date and time.

{
    "type":"object",
    "properties":{
        "sender":{
            "type":"string",
            "description":"The email address of the sender.",
            "nullable":true
        },
        "recipient":{
            "type":"string",
            "description":"The email address of the recipient.",
            "nullable":true
        },
        "fromTime":{
            "type":"string",
            "description":"The start date and time.",
            "nullable":true
        },
        "toTime":{
            "type":"string",
            "description":"The end date and time.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  Returns email message status records.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Returns email message status records."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Returns email message status records."
}

Returns email message status records.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top