Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

インバウンド・メッセージの取得

get

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

リクエスト

パス・パラメータ

InboundMessageId(required): integer(int64)

インバウンド・メッセージの一意の識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : inboundMessages-item-response

タイプ: object

ソースを表示

AcknowledgedDate: string (date-time)

タイトル: Acknowledged Date

インバウンド・メッセージが確認された日付。
Attachments: array Attachments

タイトル: Attachments

添付リソースは、インバウンド・メッセージとともに添付として送信されるファイルのリストを作成、表示、更新および削除するために使用されます。たとえば、エラー・メッセージのスクリーンショットを含むドキュメントです。
BatchId: integer (int64)

タイトル: Batch ID

インバウンド・メッセージが処理されるバッチの一意の識別子。
本文: 文字列(バイト)

タイトル: Body

インバウンド・メッセージのコンテンツ。
BUOrgId: integer (int64)

タイトル: Business Unit ID

読取り専用: true

インバウンドEメールに関連付けられたビジネス・ユニット名の一意のID。
ChannelId: integer (int64)

タイトル: Channel ID

インバウンド・メッセージに対するチャネルの一意の識別子。
ChannelTypeCdMeaning: string

タイトル: Channel Type Value

最大長: 255

インバウンドEメールのチャネル・タイプ参照コードに対応する表示値。
ConnectionTypeCd: string

タイトル: Connection Type Code

最大長: 30

デフォルト値: ORA_SVC_UMS

インバウンド・メッセージの読取りに使用された接続タイプを示します。
ConnectionTypeCdMeaning: string

タイトル: Connection Type Value

最大長: 255

インバウンド・メッセージの接続タイプ参照コードに対応する表示値を示します。
ContentTypeCd: string

タイトル: Content Type

最大長: 30

インバウンド・メッセージのコンテンツ・タイプ。
ContentTypeCdMeaning: string

タイトル: Content Type Value

最大長: 255

インバウンドEメールのコンテンツ・タイプ参照コードに対応する表示値。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

インバウンド・メッセージを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

インバウンド・メッセージが作成された日付。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

インバウンド・メッセージを削除できるかどうかを示します。
FusionRecipient: string

タイトル: Inbound Message Account

最大長: 320

サービス・リクエストが転送される取引先。
InboundMessageId: integer (int64)

タイトル: Inbound Message ID

インバウンド・メッセージの一意の識別子。
InboundMsgParts: array Inbound Message Parts

タイトル: Inbound Message Parts

インバウンド・メッセージ・パート・リソースは、インバウンド・メッセージのコンポーネント・リスト(送信元、送信先、CC、重要度など)の作成、表示、更新および削除に使用されます。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

インバウンド・メッセージが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

インバウンド・メッセージを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectId: integer (int64)

タイトル: Object ID

インバウンド・メッセージに関連付けられたビジネス・オブジェクトの一意の識別子。
ObjectTypeCd: string

タイトル: Object Type

最大長: 30

インバウンド・メッセージに関連付けられたビジネス・オブジェクトのタイプ(SVC_SERVICE_REQUESTSなど)。
ObjectTypeCdMeaning: string

タイトル: Object Type Value

最大長: 255

インバウンドEメールのオブジェクト・タイプ参照コードに対応する表示値。
PlainTextBody: 文字列(バイト)

タイトル: Plain Text Body

インバウンド・メッセージのプレーン・テキスト・コンテンツ。
ReceivedChannelCd: string

タイトル: Received Channel Code

最大長: 30

インバウンド・メッセージのチャネル・タイプ。たとえば、EメールやSMSです。
ReceivedDateTime: string (date-time)

タイトル: Received Date Time

メールボックスがEメールを受信した日時を示します。
RetryCount: integer (int64)

タイトル: Retry Count

システムがインバウンド・メッセージの処理を試行した回数。
Sender: string

タイトル: Sender

最大長: 320

インバウンド・メッセージの送信者。
SenderPartyId: integer (int64)

タイトル: Sender Party ID

メッセージを送信した個人のパーティ識別子。
SourceMessageId: string

タイトル: Source Message ID

最大長: 2000

ソース・システムのメッセージID。
StatusCd: string

タイトル: Status Code

最大長: 30

インバウンド・メッセージの現在のステータス。たとえば、受信済、処理済、削除済などです。
StatusDetails: string

タイトル: Status Details

最大長: 1000

インバウンドEメール処理ステータスの詳細。
StatusTypeCdMeaning: string

タイトル: Status Type Value

最大長: 255

インバウンドEメールのステータス・タイプ参照コードに対応する表示値。
StripeCd: string

タイトル: Stripe Code

最大長: 30

インバウンド・メッセージのアプリケーション・コンテキスト。
StripeCdMeaning: string

タイトル: Stripe Value

最大長: 255

インバウンドEメールのストライプ・タイプ参照コードに対応する表示値。
StripeCode: string

タイトル: Stripe Code

インバウンド・メッセージのアプリケーション・ストライプ。
Subject: string

タイトル: Subject

最大長: 400

インバウンド・メッセージの件名。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

インバウンド・メッセージを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the inbound message can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "SourceMessageId":{
            "title":"Source Message ID",
            "maxLength":2000,
            "type":"string",
            "description":"The message ID in the source system.",
            "nullable":true,
            "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Body":{
            "title":"Body",
            "type":"string",
            "description":"The content of the inbound message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "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
        },
        "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
        },
        "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
        },
        "PlainTextBody":{
            "title":"Plain Text Body",
            "type":"string",
            "description":"The plain text content of the inbound message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the inbound message can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "Sender":{
            "title":"Sender",
            "maxLength":320,
            "type":"string",
            "description":"The sender of an inbound message.",
            "nullable":false,
            "x-queryable":true
        },
        "AcknowledgedDate":{
            "title":"Acknowledged Date",
            "type":"string",
            "description":"The date when the inbound message was acknowledged.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FusionRecipient":{
            "title":"Inbound Message Account",
            "maxLength":320,
            "type":"string",
            "description":"The account to which the service requests are forwarded.",
            "nullable":true,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application context of inbound messages.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

ネストされたスキーマ : 添付ファイル

タイプ: array

タイトル: Attachments

添付リソースは、インバウンド・メッセージとともに添付として送信されるファイルのリストを作成、表示、更新および削除するために使用されます。たとえば、エラー・メッセージのスクリーンショットを含むドキュメントです。

ソースを表示

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"
    }
}

ネストされたスキーマ : インバウンド・メッセージ部品

タイプ: array

タイトル: Inbound Message Parts

インバウンド・メッセージ・パート・リソースは、インバウンド・メッセージのコンポーネント・リスト(送信元、送信先、CC、重要度など)の作成、表示、更新および削除に使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : inboundMessages-Attachments-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

ファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付文書の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリ。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

添付を作成したユーザー。
CreatedByUserName: string

タイトル: Created By User Name

読取り専用: true

レコードを作成したユーザーの名前。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

添付ファイルが作成された日付。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

添付のデータ型を示します。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元となる文書ID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付のフォルダ・パス。
DmVersionNumber: string

最大長: 255

添付の作成元となる文書バージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・コード(ある場合)。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツの有効期限。
FileContents: 文字列(バイト)

タイトル: File Contents

添付ファイルの内容。
FileName: string

タイトル: File Name

最大長: 2048

添付のファイル名。
FileUrl: string

タイトル: File Url

添付ファイルのURL。
FileWebImage: 文字列(バイト)

タイトル: File Web Image

読取り専用: true

ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

添付が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

添付を最後に更新したユーザー。
LastUpdatedByUserName: string

タイトル: Last Updated By User

読取り専用: true

レコードを最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Title: string

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付のコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルの長さ。
UploadedFileName: string

タイトル: Uploaded File Name

添付ファイルの名前。
UploadedText: string

タイトル: Uploaded Text

添付のテキスト。
Uri: string

タイトル: Uri

最大長: 4000

添付のURI。
Url: string

タイトル: Url

最大長: 4000

添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付に関連付けられているユーザーのログイン。

{
    "type":"object",
    "properties":{
        "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
        },
        "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"
            }
        },
        "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
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

ネストされたスキーマ : inboundMessages-InboundMsgParts-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

インバウンド・メッセージ・パートを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

インバウンド・メッセージ・パートが作成された日付。
DeleteFlag: boolean

タイトル: Can Delete

読取り専用: true

インバウンド・メッセージ・パートを削除できるかどうかを示します。
InboundMessageId: integer (int64)

タイトル: Inbound Message ID

メッセージ・パートが関連付けられているインバウンド・メッセージの一意の識別子。
InboundMsgPartId: integer (int64)

タイトル: Inbound Message Part ID

メッセージ・パートの一意の識別子。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

インバウンド・メッセージ部分が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

インバウンド・メッセージ・パートを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PartName: string

タイトル: Part Name

最大長: 64

インバウンド・メッセージ部分のヘッダー名。
PartTypeCd: string

タイトル: Part Type Code

最大長: 30

インバウンド・メッセージ部分のタイプ。
PartTypeCdMeaning: string

タイトル: Part Type Value

最大長: 255

インバウンド・メッセージの部品タイプ参照コードに対応する表示値。
PartValue: string

タイトル: Part Value

最大長: 2000

インバウンド・メッセージ部分の値。
UpdateFlag: boolean

タイトル: Can Update

読取り専用: true

インバウンド・メッセージ・パートを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the inbound message part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartValue":{
            "title":"Part Value",
            "maxLength":2000,
            "type":"string",
            "description":"The value of the inbound message part.",
            "nullable":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
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the inbound message part can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartName":{
            "title":"Part Name",
            "maxLength":64,
            "type":"string",
            "description":"The header name of the inbound message part.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

リンク

添付

操作: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments

パラメータ:

InboundMessageId: $request.path.InboundMessageId

ChannelTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ReceivedChannelCd;ターゲット属性: LookupCode
表示属性: LookupCode

ContentTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_CONTENT_TYPE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ContentTypeCd;ターゲット属性: LookupCode
表示属性: LookupCode

InboundMsgParts

操作: /crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/InboundMsgParts

パラメータ:

InboundMessageId: $request.path.InboundMessageId

ObjectTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_OBJECT_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ObjectTypeCd;ターゲット属性: LookupCode
表示属性: LookupCode

StatusTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_INBND_MSG_STATUS_TYPE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StatusCd;ターゲット属性: LookupCode
表示属性: LookupCode

StripeCodeLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StripeCode;ターゲット属性: LookupCode
表示属性: LookupCode

トップに戻る

例:

特定のインバウンド・メッセージの詳細を取得するには、次のURI構文でGETを使用します:

リクエストURIの例

次に、リクエストURLの例を示します。

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

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

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

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

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

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

Content type:
{
"InboundMessageId": 300100095233080,
"Sender": "abc@oracle.com",
"FusionRecipient": "recipient@servername.fa.us2.oraclecloud.com",
"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"
}
],
}

「トップに戻る」