Jump to

• Request
• Response
• Examples

Get an inbound message

get

/crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}

Request

Path Parameters

• InboundMessageId(required): integer(int64)
  The unique identifier of an inbound message.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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:
  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.

Body ()

Root Schema : inboundMessages-item-response

Type: object

Show Source

• AcknowledgedDate: string (date-time)
  Title: Acknowledged Date

  The date when the inbound message was acknowledged.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.
• BatchId: integer (int64)
  Title: Batch ID

  The unique identifier of the batch in which the inbound message will be processed.
• Body: string (byte)
  Title: Body

  The content of the inbound message.
• BUOrgId: integer (int64)
  Title: Business Unit ID

  Read Only: true

  The unique ID of the business unit name associated to inbound email.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel for the inbound message.
• ChannelTypeCdMeaning: string
  Title: Channel Type Value

  Maximum Length: 255

  The display value corresponding to the channel type lookup code for the inbound email.
• ConnectionTypeCd: string
  Title: Connection Type Code

  Maximum Length: 30

  Default Value: ORA_SVC_UMS

  Indicates the connection type that was used to read the inbound message.
• ConnectionTypeCdMeaning: string
  Title: Connection Type Value

  Maximum Length: 255

  Indicates the display value corresponding to the connection type lookup code for the inbound message.
• ContentTypeCd: string
  Title: Content Type

  Maximum Length: 30

  The content type of the inbound message.
• ContentTypeCdMeaning: string
  Title: Content Type Value

  Maximum Length: 255

  The display value corresponding to the content type lookup code for the inbound email.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the inbound message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the inbound message was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates whether the inbound message can be deleted.
• FusionRecipient: string
  Title: Inbound Message Account

  Maximum Length: 320

  The account to which the service requests are forwarded.
• InboundMessageId: integer (int64)
  Title: Inbound Message ID

  The unique identifier of an inbound message.
• InboundMsgParts: array Inbound Message Parts
  Title: Inbound Message Parts

  The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the inbound message was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the inbound message.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the business object associated with the inbound message.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The type of business object associated with the inbound message, for example SVC_SERVICE_REQUESTS.
• ObjectTypeCdMeaning: string
  Title: Object Type Value

  Maximum Length: 255

  The display value corresponding to the object type lookup code for the inbound email.
• PlainTextBody: string (byte)
  Title: Plain Text Body

  The plain text content of the inbound message.
• ReceivedChannelCd: string
  Title: Received Channel Code

  Maximum Length: 30

  The channel type of the inbound message. For example E-Mail or SMS.
• ReceivedDateTime: string (date-time)
  Title: Received Date Time

  Indicates the date and time when the mailbox received the email.
• RetryCount: integer (int64)
  Title: Retry Count

  The number of times the system attempted to process the inbound messages.
• Sender: string
  Title: Sender

  Maximum Length: 320

  The sender of an inbound message.
• SenderPartyId: integer (int64)
  Title: Sender Party ID

  The party identifier of the person who sent the message.
• SourceMessageId: string
  Title: Source Message ID

  Maximum Length: 2000

  The message ID in the source system.
• StatusCd: string
  Title: Status Code

  Maximum Length: 30

  The current status of the inbound message. For example Received, Processed, or Deleted.
• StatusDetails: string
  Title: Status Details

  Maximum Length: 1000

  The details of the inbound email processing status.
• StatusTypeCdMeaning: string
  Title: Status Type Value

  Maximum Length: 255

  The display value corresponding to the status type lookup code for the inbound email.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The application context of inbound messages.
• StripeCdMeaning: string
  Title: Stripe Value

  Maximum Length: 255

  The display value corresponding to the stripe type lookup code for the inbound email.
• StripeCode: string
  Title: Stripe Code

  The application stripe of the inbound message.
• Subject: string
  Title: Subject

  Maximum Length: 400

  The subject of the inbound message.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the inbound message can be updated.

{
    "type":"object",
    "properties":{
        "AcknowledgedDate":{
            "title":"Acknowledged Date",
            "type":"string",
            "description":"The date when the inbound message was acknowledged.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.",
            "items":{
                "$ref":"#/components/schemas/inboundMessages-Attachments-item-response"
            }
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique ID of the business unit name associated to inbound email.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"The unique identifier of the batch in which the inbound message will be processed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Body":{
            "title":"Body",
            "type":"string",
            "description":"The content of the inbound message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel for the inbound message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelTypeCdMeaning":{
            "title":"Channel Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the channel type lookup code for the inbound email.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReceivedChannelCd"
                ]
            },
            "x-queryable":true
        },
        "ConnectionTypeCd":{
            "title":"Connection Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the connection type that was used to read the inbound message.",
            "nullable":true,
            "default":"ORA_SVC_UMS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConnectionTypeCdMeaning":{
            "title":"Connection Type Value",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the display value corresponding to the connection type lookup code for the inbound message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ConnectionTypeCd"
                ]
            },
            "x-queryable":true
        },
        "ContentTypeCd":{
            "title":"Content Type",
            "maxLength":30,
            "type":"string",
            "description":"The content type of the inbound message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContentTypeCdMeaning":{
            "title":"Content Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the content type lookup code for the inbound email.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContentTypeCd"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inbound message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inbound message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the inbound message can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FusionRecipient":{
            "title":"Inbound Message Account",
            "maxLength":320,
            "type":"string",
            "description":"The account to which the service requests are forwarded.",
            "nullable":true,
            "x-queryable":true
        },
        "InboundMessageId":{
            "title":"Inbound Message ID",
            "type":"integer",
            "description":"The unique identifier of an inbound message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InboundMsgParts":{
            "title":"Inbound Message Parts",
            "type":"array",
            "description":"The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.",
            "items":{
                "$ref":"#/components/schemas/inboundMessages-InboundMsgParts-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inbound message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inbound message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the business object associated with the inbound message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of business object associated with the inbound message, for example SVC_SERVICE_REQUESTS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectTypeCdMeaning":{
            "title":"Object Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object type lookup code for the inbound email.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectTypeCd"
                ]
            },
            "x-queryable":true
        },
        "PlainTextBody":{
            "title":"Plain Text Body",
            "type":"string",
            "description":"The plain text content of the inbound message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ReceivedChannelCd":{
            "title":"Received Channel Code",
            "maxLength":30,
            "type":"string",
            "description":"The channel type of the  inbound message. For example E-Mail or SMS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReceivedDateTime":{
            "title":"Received Date Time",
            "type":"string",
            "description":"Indicates the date and time when the mailbox received the email.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RetryCount":{
            "title":"Retry Count",
            "type":"integer",
            "description":"The number of times the system attempted to process the inbound messages.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Sender":{
            "title":"Sender",
            "maxLength":320,
            "type":"string",
            "description":"The sender of an inbound message.",
            "nullable":false,
            "x-queryable":true
        },
        "SenderPartyId":{
            "title":"Sender Party ID",
            "type":"integer",
            "description":"The party identifier of the person who sent the message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceMessageId":{
            "title":"Source Message ID",
            "maxLength":2000,
            "type":"string",
            "description":"The message ID in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The current status of the inbound message. For example Received, Processed, or Deleted.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The details of the inbound email processing status.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusTypeCdMeaning":{
            "title":"Status Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status type lookup code for the inbound email.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application context of inbound messages.",
            "nullable":true,
            "x-queryable":true
        },
        "StripeCdMeaning":{
            "title":"Stripe Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the stripe type lookup code for the inbound email.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "StripeCode":{
            "title":"Stripe Code",
            "type":"string",
            "description":"The application stripe of the inbound message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":400,
            "type":"string",
            "description":"The subject of the inbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the inbound message can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.

Show Source

• Array of: object inboundMessages-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.",
    "items":{
        "$ref":"#/components/schemas/inboundMessages-Attachments-item-response"
    }
}

Nested Schema : Inbound Message Parts

Type: array

Title: Inbound Message Parts

The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.

Show Source

• Array of: object inboundMessages-InboundMsgParts-item-response

{
    "title":"Inbound Message Parts",
    "type":"array",
    "description":"The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.",
    "items":{
        "$ref":"#/components/schemas/inboundMessages-InboundMsgParts-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : inboundMessages-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The name of the user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Indicates the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attached file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login of the user associated with the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The name of the user who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login of the user associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : inboundMessages-InboundMsgParts-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the inbound message part.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the inbound message part was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates if the inbound message part can be deleted.
• InboundMessageId: integer (int64)
  Title: Inbound Message ID

  The unique identifier of the inbound message with which the message part is associated.
• InboundMsgPartId: integer (int64)
  Title: Inbound Message Part ID

  The unique identifier of the message part.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the inbound message part was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the inbound message part.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartName: string
  Title: Part Name

  Maximum Length: 64

  The header name of the inbound message part.
• PartTypeCd: string
  Title: Part Type Code

  Maximum Length: 30

  The type of the inbound message part.
• PartTypeCdMeaning: string
  Title: Part Type Value

  Maximum Length: 255

  The display value corresponding to the part type lookup code for the inbound message.
• PartValue: string
  Title: Part Value

  Maximum Length: 2000

  The value of the inbound message part.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the inbound message part can be updated.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inbound message part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inbound message part was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the inbound message part can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InboundMessageId":{
            "title":"Inbound Message ID",
            "type":"integer",
            "description":"The unique identifier of the inbound message with which the message part is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InboundMsgPartId":{
            "title":"Inbound Message Part ID",
            "type":"integer",
            "description":"The unique identifier of the message part.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inbound message part was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the inbound message part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The header name of the inbound message part.",
            "nullable":true,
            "x-queryable":true
        },
        "PartTypeCd":{
            "title":"Part Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the inbound message part.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartTypeCdMeaning":{
            "title":"Part Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the part type lookup code for the inbound message.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PartTypeCd"
                ]
            },
            "x-queryable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The value of the inbound message part.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the inbound message part can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

Attachments

Operation: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments

Parameters:

• InboundMessageId: $request.path.InboundMessageId

The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.

ChannelTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: ReceivedChannelCd; Target Attribute: LookupCode
• Display Attribute: LookupCode

ContentTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_CONTENT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: ContentTypeCd; Target Attribute: LookupCode
• Display Attribute: LookupCode

InboundMsgParts

Operation: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts

Parameters:

• InboundMessageId: $request.path.InboundMessageId

The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.

ObjectTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_OBJECT_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectTypeCd; Target Attribute: LookupCode
• Display Attribute: LookupCode

StatusTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_MSG_STATUS_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCd; Target Attribute: LookupCode
• Display Attribute: LookupCode

StripeCodeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: StripeCode; Target Attribute: LookupCode
• Display Attribute: LookupCode

Back to Top

Examples

Use GET with the following URI syntax to get details of a specific inbound message:

Example of Request URI

The following shows an example of the request URL.

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080 HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200: OK
Date: Mon, 18 Jan 2017 09:15:04 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following shows an example of the response body in JSON format.

Content type:
{
"InboundMessageId": 300100095233080,
"Sender": "[e-mail]",
"FusionRecipient": "[e-mail]",
"Subject": "Testing REST API",
"ContentTypeCd": "ORA_SVC_TEXT_HTML",
"StatusCd": "ORA_SVC_PROCESSED",
"ReceivedChannelCd": "ORA_SVC_EMAIL",
"AcknowledgedDate": "2016-05-24T01:47:47-07:00",
"CreationDate": "2017-01-18T01:04:38-08:00",
"CreatedBy": "SALES_ADMIN",
"LastUpdateDate": "2017-01-18T01:04:38-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"ChannelId": 2,
"ObjectId": 300100095233089,
"ObjectTypeCd": "SVC_SERVICE_REQUESTS",
"BatchId": 300100095233079,
"RetryCount": 0,
"StripeCode": "ORA_SVC_CRM",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080",
"name": "inboundMessages",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080",
"name": "inboundMessages",
"kind": "item"
},
  {
"rel": "child",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080/child/InboundMsgParts",
"name": "InboundMsgParts",
"kind": "collection"
},
  {
"rel": "child",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
  {
"rel": "enclosure",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080/enclosure/Body",
"name": "Body",
"kind": "other"
},
  {
"rel": "enclosure",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095233080/enclosure/PlainTextBody",
"name": "PlainTextBody",
"kind": "other"
}
],
}

Back to Top