添付の作成
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment
リクエスト
- OptyNumber(required): string
商談の一意の代替識別子。
- 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
アップロードされたファイルのトラッキングに使用される一意の識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリの名前。 - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データのタイプを示すコード。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付文書の一意の識別子。 -
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のデフォルト・バージョンを選択します。
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
アップロードされたファイルのトラッキングに使用される一意の識別子。 -
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
添付文書の一意の識別子。 -
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.
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
例:
次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、商談添付を作成する方法を示しています。
FILEタイプ添付の作成
cURLコマンド
curl --user sales_cloud_user @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_117503/child/Attachment
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{ "CategoryName": "MISC", "DatatypeCode": "FILE", "FileContents": "VGVzdCBjb250ZW50IHVwZGF0ZWQ=", "Title" : "Sample File attachment 07/28 test 123", "FileName": "New_Test_Attachment.txt" }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "LastUpdateDate": "2017-08-04T12:32:43.536+00:00", "LastUpdatedBy": "SALES_ADMIN", "DatatypeCode": "FILE", "FileName": "New_Test_Attachment.txt", "DmFolderPath": null, "Url": null, "CategoryName": "MISC", "UserName": null, "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a21564?&XFND_SCHEME_ID=1&XFND_CERT_FP=09B5C8AE7FFF1BC26FF8FFE8603DB27633015773&XFND_RANDOM=-5629498665627234903&XFND_EXPIRES=1501846632749&XFND_SIGNATURE=mgAmTnh0VhJgFOCQetpr-F7qla0ijIUVltQFXu~1LCfMi4QhqUViwdSgSa5RF8i2dkkjRztxHZIcoXX51drmgtI24txYNYKJeFmnhWrKr3volf~nLqJfwKvJiGigTK4hIsfoYVJoNS1imIdKFGiGy7bB0AqLemCrTCcHoIHEj23FDSqyJ31m48kwTa7pHUcXVmPxr0h-P177stprfjsfBoxh4bHQaLZwAHOVxV4UHmpfxNb1GbX6q9LOTFdSnvE2mEbGdxs98sf1Rv5LKsTL3aU~KzmS-JeizMv0t8IRrBJi6sOJs-seWAFxvOrRAvtXYpVdCBj6Axsq9PyoP8LXDg__&Id=21564&download", "UploadedText": null, "UploadedFileContentType": "text/plain", "UploadedFileLength": 20, "UploadedFileName": "New_Test_Attachment.txt", "ContentRepositoryFileShared": "false", "Title": "Sample File attachment 07/28 test 123", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-08-04T12:32:32.214+00:00", "ExpirationDate": null, ... }
TEXTタイプの添付の作成
cURLコマンド
curl --user sales_cloud_user @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_117503/child/Attachment
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{ "CategoryName": "MISC", "DatatypeCode": "TEXT", "UploadedText": "Sample Text 07/28 test 1111" }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "LastUpdateDate": "2017-08-04T13:10:20.579+00:00", "LastUpdatedBy": "SALES_ADMIN", "DatatypeCode": "TEXT", "FileName": "Sample Text 07_28 test 1111", "DmFolderPath": null, "Url": null, "CategoryName": "MISC", "UserName": null, "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a21577?XFND_SCHEME_ID=1&XFND_CERT_FP=09B5C8AE7FFF1BC26FF8FFE8603DB27633015773&XFND_RANDOM=1538444565440720007&XFND_EXPIRES=1501852824575&XFND_SIGNATURE=dTvPLbcQLKUrLCDNo1fh4wfO~gd~yuSW-yX2BAN1zXjMJxZOflWPDpfN2fi3LsD7Uqdi9J3MHnLrBkBQ7DuDwgg8DRi8lRe5B-wZMrFhnFbQmsC7Y94~gdfMi9kfnGbuFhiZFlwnMpUrOyox-9fdq8Y2swZp8gOHa6KNg-LwaYTqSBlnoocvATPyJhrwj5JJSP1spNLvkRhz0XRWL8qES3dUzOh1aydVSzUjHjzuhxB-c13F4OGsbuKUtloWjt5qVlAiLF9wrk9F40WqtCy71qAy3Y5v9WPyvogvcz7d~q4xZbyXtiIXrYJVQfOclT1RiK-N55-xW7pA2VJYm8HdlQ__&Id=21577&download", "UploadedText": null, "UploadedFileContentType": "text/plain", "UploadedFileLength": 30, "UploadedFileName": "Sample Text 07_28 test 1111-68552a79-263b-47e1-a2b0-2227c1daac81.txt", "ContentRepositoryFileShared": "false", "Title": "Sample Text 07/28 test 1111", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-08-04T13:10:09.202+00:00", "ExpirationDate": null, ... }
WEB_URLタイプのアタッチメントの作成
cURLコマンド
curl --user sales_cloud_user @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_117503/child/Attachment
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{ "CategoryName": "MISC", "DatatypeCode": "WEB_PAGE", "Url": "http://www.oracle.com" }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "LastUpdateDate": "2017-08-04T13:20:38.262+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": "http://www.oracle.com", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-08-04T13:20:38.206+00:00", "ExpirationDate": null, ... }