添付の作成
post
/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/attachments
リクエスト
パス・パラメータ
- workConfirmationsUniqID(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
ファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付ドキュメントの一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示す値。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付の作成元であるドキュメントID。 -
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
ファイルのURI。 -
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
webページ・タイプの添付のURL。
レスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : workConfirmations-attachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
ファイルのアップロードを支援するために添付UIコンポーネントによって排他的に使用される属性。 -
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
添付の作成元であるドキュメントID。 -
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
ファイルのURI。 -
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。 -
Url: string
タイトル:
Url
最大長:4000
webページ・タイプの添付の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.
例
次の例は、添付の作成方法を示しています。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。
curl -u username: password -X POST -H "Content-Type: application/json" -d "https://servername/fscmRestApi/resources/version/workConfirmations/WorkConfirmationId/child/attachments"
たとえば:
curl -u username: password -X POST -H "Content-Type: application/json" -d "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments"
リクエスト本文の例
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。
"{ "DatatypeCode": "TEXT", "CategoryName": "FROM_SUPPLIER", "FileName": "This is a sample text attachment", "UploadedText": "text", "Url": null, "Title": "REST Attachment Text", "Description": "Text Attachment" }"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "AttachedDocumentId": 300100552062232, "LastUpdateDate": "2022-02-02T13:33:28.236+00:00", "LastUpdatedBy": "CVBUYER01", "DatatypeCode": "TEXT", "FileName": "text", "DmFolderPath": null, "DmDocumentId": "UCMFA00123009", "DmVersionNumber": "123209", "Url": null, "CategoryName": "FROM_SUPPLIER", "UserName": null, "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:123209?download&XFND_SCHEME_ID=1&XFND_CERT_FP=050B97D1B0F57AC305F88E205CE029181C4A07C8&XFND_RANDOM=4437122959824225596&XFND_EXPIRES=1643809408461&XFND_SIGNATURE=Uj0IABIppQeEboBCbrKHBZ1MWmeo9YlvTFfW0KDsxJWUhKJduWo0sngXe3nTM4Hg8ScdHl78SC9RBBMNBtgydyf1g8~1gy7~2sT8s0nlqS8l8bKHc6oRGr3STBtl-KpXx4l7xnmKpDedyaZIEacWyX8chmGPVHo8lY5KO-gAK~8X0iiZi59EMzhlTZBtR~wwUiFEny72nKtnF2MQhqIlOy0CalSTbCDhfyJIo~vkiPPLCIb0C8OYolXl~5M-jjAEZ9JIbxI7Hob~XrXPsm3xFYU6XfUJ0ZtoC-pohocfgg-3qxxHcxtDFZsy90CPgI9DP-QV4OAbGFOCy5lWBLjcwg__&Id=123209", "UploadedText": null, "UploadedFileContentType": "text/plain", "UploadedFileLength": 7, "UploadedFileName": "REST Attachment Text-9722cf56-004a-4304-980b-c3ea89949b1d.txt", "ContentRepositoryFileShared": "false", "Title": "REST Attachment Text", "Description": "Text Attachment", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "CVBUYER01", "CreationDate": "2022-02-02T13:33:26+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Clare Jones", "CreatedByUserName": "Clare Jones", "AsyncTrackerId": null, "DownloadInfo": "{\"XFND_EXPIRES\":\"1643809408464\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"050B97D1B0F57AC305F88E205CE029181C4A07C8\",\"XFND_SIGNATURE\":\"cY3tuYzPIBE6Nby68NSUfJdrobXc3LGzrYEyvfZEZDDhjG5UjIy~-V-aU4KhRjgV5jL246Viaau8i8KcYx9MXEPeBiFLhHa5WCWjzuZaAHxy65AJYtCZFCzg97bbXr6qpoSHXDkcVrp4rdyeKqMC5ZufS78HGbKRvVE67IR-6tHX5RJIBrshf7Tm9DOhTbX1EC-K10Ym32oIVtX3hUGHtXKyegpl6VWWd5DkH6lj5b1cHQDhYrzU2p-6vOVoIO5pw3GjMoQPo-qgNmkBtfkpyJn00GjXDdpOo7vwryi3i2MifDlg5IXo34Qzw4GVQP3lFXaUEoUJy9~WSgXA6FcVfA__\",\"XFND_RANDOM\":\"8436617921277681430\"}", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317", "name": "workConfirmations", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517/enclosure/FileContents", "name": "FileContents", "kind": "other" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments/00020000000EACED00057708000110F09ACD75180000000EACED00057708000110F09ACD7517/enclosure/FileWebImage", "name": "FileWebImage", "kind": "other" } ] }