添付の作成
post
/crmRestApi/resources/11.13.18.05/inboundMessages/{InboundMessageId}/child/Attachments
リクエスト
パス・パラメータ
- InboundMessageId(required): integer(int64)
インバウンド・メッセージの一意の識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
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。 -
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。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : inboundMessages-Attachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
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
添付に関連付けられているユーザーのログイン。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
例:
次の例は、RESTリソースに対してPOSTリクエストを発行してインバウンド・メッセージの添付を作成する方法を示しています。
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
POST /crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/Attachments/ HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
リクエスト本文の例
次に、リクエスト本文の例を示します。
{ "Url": "http://www.oracle.com", "DatatypeCode": "WEB_PAGE", "Title": "REST API Attachment" }
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 201 CREATED Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
レスポンス本文の例
次の例は、レスポンス本文の内容を示しています。
{ "LastUpdateDate": "2017-04-21T12:06:39.085+00:00", "LastUpdatedBy": "Sales_admin", "DatatypeCode": "WEB_PAGE", "FileName": null, "DmFolderPath": null, "Url": "http://www.oracle.com", "CategoryName": "MISC", "UserName": null, "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "REST API Attachment", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "sales_admin", "CreationDate": "2017-04-21T12:06:39+00:00", "ExpirationDate": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/Attachments/00020000000EACED00057708000110F080C033BE0000000EACED00057708000110F080C033BD", "name": "Attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/Attachments/00020000000EACED00057708000110F080C033BE0000000EACED00057708000110F080C033BD", "name": "Attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695", "name": "inboundMessages", "kind": "item" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100091977695/child/Attachments/00020000000EACED00057708000110F080C033BE0000000EACED00057708000110F080C033BD/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] }