添付の更新
patch
/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/attachments/{attachmentsUniqID}
リクエスト
パス・パラメータ
- attachmentsUniqID(required): string
これは、下書き購買オーダーの添付リソースの複合キーを構成し、下書き購買オーダーの添付のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、下書き購買オーダーの添付の特定のインスタンスにナビゲートしてハッシュ・キーを取得するために、下書き購買オーダー収集リソースの添付を問い合せる必要があります。
- draftPurchaseOrdersUniqID(required): string
これは、下書き購買オーダー・リソースの複合キーを構成し、下書き購買オーダーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ドラフト購買オーダーの特定のインスタンスに移動してハッシュ・キーを取得するために、ドラフト購買オーダー・コレクション・リソースを問い合せる必要があります。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされているメディア・タイプ
- application/json
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
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: string (byte)
タイトル:
File Contents添付文書の内容。 -
FileName: string
タイトル:
File Name最大長:2048添付ドキュメントのファイル名。 -
FileUrl: string
タイトル:
File Url添付ドキュメントのURL (Uniform Resource Locator)。 -
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 (Uniform Resource Identifier)。 -
Url: string
タイトル:
Url最大長:4000添付されたドキュメントを識別するURI (Uniform Resource Identifier)。
レスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : draftPurchaseOrders-attachments-item-response
タイプ:
ソースを表示
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: string (byte)
タイトル:
File Contents添付文書の内容。 -
FileName: string
タイトル:
File Name最大長:2048添付ドキュメントのファイル名。 -
FileUrl: string
タイトル:
File Url添付ドキュメントのURL (Uniform Resource Locator)。 -
FileWebImage: string (byte)
タイトル:
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 (Uniform Resource Identifier)。 -
Url: string
タイトル:
Url最大長:4000添付されたドキュメントを識別するURI (Uniform Resource Identifier)。 -
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.
例
この例では、添付の更新方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/draftPurchaseOrdersUniqID/child/attachments/AttachedDocumentId"
リクエスト本文の例
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 この例では、ファイル添付が正常に更新されています。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが更新するレコードで使用される属性値を指定します。
{
"Description": "Updated attachment description"
}
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{
"AttachedDocumentId": 300100197971814,
"LastUpdateDate": "2020-10-16T10:31:21.962+00:00",
"LastUpdatedBy": "CVBUYER01",
"DatatypeCode": "FILE",
"FileName": "REST Attachment.txt",
"DmFolderPath": null,
"DmDocumentId": "UCMFA00023337",
"DmVersionNumber": "23340",
"Url": null,
"CategoryName": "TO_SUPPLIER",
"UserName": "To Supplier",
"Uri": null,
"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a23340?XFND_SCHEME_ID=1&XFND_CERT_FP;=0A3C9E5F872EB24E37333CB5F528CEEFA1491781&XFND_RANDOM;=-693685438684314435&XFND_EXPIRES;=1602846011744&XFND_SIGNATURE;=Opi6NJ2mRKQlWSibPtP71xq5xJEzNVyyFWkSvPa9sKFLOOgTyoAd68Q~lXZ8ErNfRJJrLfwRtWOaq-2OWnS9HgE6yt9Q3l~u6n6yT4giFaFJhe6X~XnX7eI7OukYRzRpT6m3RIEDFzRcX1S9-PJBA7vyaZ6Z2IGHYpVi3LTRBSkEoVhs2wXtC0jttJ6i40s1jZCMgel~gtubQNsPB13uwOjf7jmB0w6MQiby5P26d44Eid~OAMwZu7M75Csky8E15qDVzuCGEI2o8wYDBtjZnsIKkggs5XRwEB8cQQpR0c~g0dM4dGEP-0cbiBI7vg2pd7dyOib2r8sUV7t8VTK9HA__&Id;=23340&download;",
"UploadedText": null,
"UploadedFileContentType": "text/plain",
"UploadedFileLength": 7,
"UploadedFileName": null,
"ContentRepositoryFileShared": "false",
"Title": "REST Attachment.txt",
"Description": "Updated attachment description",
"ErrorStatusCode": null,
"ErrorStatusMessage": null,
"CreatedBy": "CVBUYER01",
"CreationDate": "2020-10-16T10:31:21+00:00",
"ExpirationDate": null,
"LastUpdatedByUserName": "Clare Jones",
"CreatedByUserName": "Clare Jones",
"AsyncTrackerId": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765",
"name": "attachments",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765",
"name": "attachments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749",
"name": "draftPurchaseOrders",
"kind": "item"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/attachments/00020000000EACED00057708000110F085B277660000000EACED00057708000110F085B27765/enclosure/FileContents",
"name": "FileContents",
"kind": "other"
}
]
}