1つの添付の更新
patch
/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/{purchaseRequisitionsUniqID}/child/attachments/{attachmentsUniqID}
リクエスト
パス・パラメータ
- attachmentsUniqID(required): string
これは、購買依頼の添付リソースの複合キーを構成し、購買依頼の添付のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために、購買依頼の添付コレクション・リソースの特定のインスタンスに移動するために、購買依頼の添付を問い合せる必要があります。
- purchaseRequisitionsUniqID(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
ファイルの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
webページ・タイプ添付のUniform Resource Locator。
レスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : purchaseRequisitions-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
ファイルのUniform Resource Locator。 -
FileWebImage: string (byte)
タイトル:
File Web Image
読取り専用:true
Base64でエンコードされた、.png形式で表示されるファイルのイメージ(ソースが変換可能なイメージの場合)。 -
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
webページ・タイプ添付のUniform Resource Locator。 -
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/purchaseRequisitions/{purchaseRequisitionsUniqID}/child/attachments/AttachedDocumentId"
リクエスト本文の例
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。
"{ ""Description"": ""Updated attachment description"" }"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
"{ ""AttachedDocumentId"": 300100543831490, ""LastUpdateDate"": ""2021-06-09T06:22:32.330+00:00"", ""LastUpdatedBy"": ""SSPUSER01"", ""DatatypeCode"": ""FILE"", ""FileName"": ""REST Attachment.txt"", ""DmFolderPath"": null, ""DmDocumentId"": ""UCMFA00045998"", ""DmVersionNumber"": ""46008"", ""Url"": null, ""CategoryName"": ""REQ_INTERNAL"", ""UserName"": ""Internal to Requisition"", ""Uri"": null, ""FileUrl"": ""/content/conn/FusionAppsContentRepository/uuid/dDocID%3a46008?XFND_SCHEME_ID=1&XFND_CERT_FP=AA7517E17BA650FAFA0DC0ED299FE7CE26598897&XFND_RANDOM=-5219829487492125093&XFND_EXPIRES=1623221229247&XFND_SIGNATURE=nKG3b5KiJq2mPIq9GDimHBU-iynR0gXbFrxgcgwzXxyBtO4uihHBAXyqxGlGKQf8J8mc8BfdMiNXq2qFmKjTSrB8kWEQU-vmrkJToUfYLXS12YEpgA4ToJ56WkY7g65ehTU0fXf~Xf0LEWfzHl1YS1eUYcNDfBpQ4MB9N3fnbCe1pA7HOoMvqAt6RrHkl-RQrGWpi3-6oouGWAoYlJiUuYW5-ocC9yW1PH9tRv1EIRx1-MXXgCzhF10LZ0u0I-N~c8dqlY3rNlzRGouCwEh8DTj53fuHHNn-GuAEqxbLkiqDRGp51vyQq2U3H2uPcnNNXZRgm43fRJDC6S6PL~ZN5g__&Id=46008&download"", ""UploadedText"": null, ""UploadedFileContentType"": ""text/plain"", ""UploadedFileLength"": 7, ""UploadedFileName"": null, ""ContentRepositoryFileShared"": ""false"", ""Title"": ""REST Attachment File"", ""Description"": ""Updated attachment description"", ""ErrorStatusCode"": null, ""ErrorStatusMessage"": null, ""CreatedBy"": ""SSPUSER01"", ""CreationDate"": ""2021-06-09T06:22:31+00:00"", ""ExpirationDate"": null, ""LastUpdatedByUserName"": ""SSPUSER01"", ""CreatedByUserName"": ""SSPUSER01"", ""AsyncTrackerId"": null, ""links"": [ { ""rel"": ""self"", ""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/attachments/00020000000EACED00057708000110F09A4FDDC20000000EACED00057708000110F09A4FDDC1"", ""name"": ""attachments"", ""kind"": ""item"" }, { ""rel"": ""canonical"", ""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/attachments/00020000000EACED00057708000110F09A4FDDC20000000EACED00057708000110F09A4FDDC1"", ""name"": ""attachments"", ""kind"": ""item"" }, { ""rel"": ""parent"", ""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486"", ""name"": ""purchaseRequisitions"", ""kind"": ""item"" }, { ""rel"": ""enclosure"", ""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/attachments/00020000000EACED00057708000110F09A4FDDC20000000EACED00057708000110F09A4FDDC1/enclosure/FileContents"", ""name"": ""FileContents"", ""kind"": ""other"" }, { ""rel"": ""enclosure"", ""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/attachments/00020000000EACED00057708000110F09A4FDDC20000000EACED00057708000110F09A4FDDC1/enclosure/FileWebImage"", ""name"": ""FileWebImage"", ""kind"": ""other"" } ] }"