添付の作成
post
/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/{purchaseRequisitionsUniqID}/child/lines/{linesUniqID}/child/attachments
リクエスト
パス・パラメータ
- linesUniqID(required): string
これは、Linesリソースのコンポジット・キーを構成し、Linesのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Linesの特定のインスタンスに移動してハッシュ・キーを取得するために、Linesコレクション・リソースを問い合せる必要があります。
- purchaseRequisitionsUniqID(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: 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最大長:4000webページ・タイプ添付のUniform Resource Locator。
レスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : purchaseRequisitions-lines-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読取り専用:trueBase64でエンコードされた、.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最大長:4000webページ・タイプ添付の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 -u username:password -X POST -H ""Content-Type:application/vnd.oracle.adf.resourceitem+json"" -d 'request payload'
""https://servername/fscmRestApi/resources/version/purchaseRequisitions/{purchaseRequisitionsUniqID}/child/lines/{linesUniqID}/child/attachments"""
リクエスト本文の例
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。
"{
""DatatypeCode"": ""FILE"",
""CategoryName"": ""REQ_INTERNAL"",
""FileName"" : ""REST Attachment.txt"",
""UploadedFileContentType"" : ""text/plain"",
""ContentRepositoryFileShared"": ""false"",
""Title"" : ""REST Attachment File"",
""Description"" : ""File attachment"",
""FileContents"" : ""UmFnaGF2YQ==""
}"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
"{
""AttachedDocumentId"": 300100543831654,
""LastUpdateDate"": ""2021-06-09T07:04:46.647+00:00"",
""LastUpdatedBy"": ""SSPUSER01"",
""DatatypeCode"": ""FILE"",
""FileName"": ""REST Attachment.txt"",
""DmFolderPath"": null,
""DmDocumentId"": ""UCMFA00046072"",
""DmVersionNumber"": ""46082"",
""Url"": null,
""CategoryName"": ""REQ_INTERNAL"",
""UserName"": null,
""Uri"": null,
""FileUrl"": ""/content/conn/FusionAppsContentRepository/uuid/dDocID%3a46082?XFND_SCHEME_ID=1&XFND_CERT_FP=AA7517E17BA650FAFA0DC0ED299FE7CE26598897&XFND_RANDOM=9040748507019390915&XFND_EXPIRES=1623222886651&XFND_SIGNATURE=fQQsLauqRkwKRZrXg19fMwbfVoMrxZSD1QiQbTrwGk17kYGUCApGi3IJvWgcYO-leSX383cOdXgns87uHj6LW9u4CbOCmJHhAGthLmUvlBhq86U6~iiT9h6JHTGtc-q--OGb1aQwU70qkBhug4rZaDymaqN11qf54riT3hj8eyXY2odmwAoH8EjS~7kwIb-GlM5m0MnNLhINbeznLwJbVGBiT8Of1rT70zyuPNJJnImq8G2z02jhK95ECoYIOWzkzhGPEy0h4UcDKYxTzSFfKV6CtR5fAr58TJpvD0rGQ~VbwuOv4fRRuCkkK~F~uH2fx0e6pe2jiK9aI-vyqgRYmA__&Id=46082&download"",
""UploadedText"": null,
""UploadedFileContentType"": ""text/plain"",
""UploadedFileLength"": 7,
""UploadedFileName"": ""REST Attachment.txt"",
""ContentRepositoryFileShared"": ""false"",
""Title"": ""REST Attachment File"",
""Description"": ""File attachment"",
""ErrorStatusCode"": null,
""ErrorStatusMessage"": null,
""CreatedBy"": ""SSPUSER01"",
""CreationDate"": ""2021-06-09T07:04:45+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/lines/300100543831487/child/attachments/00020000000EACED00057708000110F09A4FDE660000000EACED00057708000110F09A4FDE65"",
""name"": ""attachments"",
""kind"": ""item""
},
{
""rel"": ""canonical"",
""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/lines/300100543831487/child/attachments/00020000000EACED00057708000110F09A4FDE660000000EACED00057708000110F09A4FDE65"",
""name"": ""attachments"",
""kind"": ""item""
},
{
""rel"": ""parent"",
""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/lines/300100543831487"",
""name"": ""lines"",
""kind"": ""item""
},
{
""rel"": ""enclosure"",
""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/lines/300100543831487/child/attachments/00020000000EACED00057708000110F09A4FDE660000000EACED00057708000110F09A4FDE65/enclosure/FileContents"",
""name"": ""FileContents"",
""kind"": ""other""
},
{
""rel"": ""enclosure"",
""href"": ""https://servername/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/300100543831486/child/lines/300100543831487/child/attachments/00020000000EACED00057708000110F09A4FDE660000000EACED00057708000110F09A4FDE65/enclosure/FileWebImage"",
""name"": ""FileWebImage"",
""kind"": ""other""
}
]
}"