1つの添付の更新
patch
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/attachments/{attachmentsUniqID}
リクエスト
パス・パラメータ
- SupplierId(required): integer(int64)
サプライヤを一意に識別する値。
- attachmentsUniqID(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のデフォルト・バージョンを選択します。
ルート・スキーマ : suppliers-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/suppliers/SupplierId/child/attachments/AttachedDocumentId"
リクエスト本文の例
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが更新するレコードで使用される属性値を指定します。
{ "Title": "New URL after supplier acquisition", "Description": "New URL after supplier acquisition" }
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "AttachedDocumentId": 300100184758381, "LastUpdateDate": "2020-02-03T11:39:43.377+00:00", "LastUpdatedBy": "BUYER01", "DatatypeCode": "WEB_PAGE", "FileName": null, "DmFolderPath": "", "DmDocumentId": null, "DmVersionNumber": null, "Url": "https://example.com", "CategoryName": "TO_SUPPLIER", "UserName": "To Supplier", "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "New URL after supplier acquisition", "Description": "New URL after supplier acquisition", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "BUYER01", "CreationDate": "2020-02-03T11:39:43+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Clare Jones", "CreatedByUserName": "Clare Jones", "AsyncTrackerId": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/attachments/00020000000EACED00057708000110F084E8D86D0000000EACED00057708000110F084E8D86C", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/attachments/00020000000EACED00057708000110F084E8D86D0000000EACED00057708000110F084E8D86C", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527", "name": "suppliers", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/attachments/00020000000EACED00057708000110F084E8D86D0000000EACED00057708000110F084E8D86C/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] }