添付の作成
post
/fscmRestApi/resources/11.13.18.05/questionnaireResponses/{QuestionnaireRespHeaderId}/child/questionnaireResponseSections/{QuestionnaireRespSectionId}/child/questionnaireResponseDetails/{QuestionnaireResponseId}/child/questionnaireResponseValues/{QuestionnaireRespValueId}/child/responseAttachments
リクエスト
パス・パラメータ
- QuestionnaireRespHeaderId(required): integer(int64)
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
- QuestionnaireRespSectionId(required): integer(int64)
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
- QuestionnaireRespValueId(required): integer(int64)
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
- QuestionnaireResponseId(required): integer(int64)
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
ヘッダー・パラメータ
- 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最大長:4000webページ・タイプの添付のURL。
レスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : questionnaireResponses-questionnaireResponseSections-questionnaireResponseDetails-questionnaireResponseValues-responseAttachments-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最大長:4000webページ・タイプの添付の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.
例
この例では、1つのレスポンス添付を作成する方法について説明します。
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/questionnaireResponses/QuestionnaireRespHeaderId/child/questionnaireResponseSections/QuestionnaireRespSectionId/child/questionnaireResponseDetails/QuestionnaireResponseId/child/questionnaireResponseValues/QuestionnaireRespValueId/child/responseAttachments"
リクエスト本文の例
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが更新するレコードで使用される属性値を指定します。
{
"DatatypeCode": "TEXT",
"CategoryName": "MISC",
"FileName": "Response instructions",
"UploadedText": "Response instructions",
"Title": "Instructions"
}
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{
"AttachedDocumentId": 300100585648472,
"LastUpdateDate": "2023-11-04T00:09:49.729+00:00",
"LastUpdatedBy": "CVBUYER01",
"DatatypeCode": "TEXT",
"FileName": "Response instructions",
"DmFolderPath": null,
"DmDocumentId": "UCMFA00081086",
"DmVersionNumber": "81091",
"Url": null,
"CategoryName": "MISC",
"UserName": "Miscellaneous",
"Uri": null,
"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:81091?download&XFND_SCHEME_ID=1&XFND_CERT_FP=47F378914F20E18ADDBAE8F0D63744B918A89F04&XFND_RANDOM=7973819444987621346&XFND_EXPIRES=1699057190109&XFND_SIGNATURE=KjEKb1aNolnX-I6x5NPInZWoetsizybUCY-L82prRY7OkK1kHPWMzo5Ihrzv1d28fAaNrBSe~BEJ17q9FIfHvCxRd3ny0ThB966uKB5RmqkN9PXSTsGBl8Y91eTN9DFB0ELpHofQJaYOk9I~eyEwJxQtkcr7qeCD0ZpgS7yQLIBhyFkLGjDFPinPkqorU6YNMnpKIxx-y3E3KmEPkTFk4SYZgVjoIyVKFxuwgRHIMjPv30uOpe2LfHzXFCBHdNN9jdt14GywSQr70~hPFNsshsoroAsBsGNEyKvnUREuKL~~HncePe3yAyFYN-0RK-AOPlaONJWbQ-bzKSQBd03kUQ__&Id=81091",
"UploadedText": null,
"UploadedFileContentType": "text/plain",
"UploadedFileLength": 24,
"UploadedFileName": "Instructions-b1319d44-98b4-4137-87cd-8c938ead53ee.txt",
"ContentRepositoryFileShared": "false",
"Title": "Instructions",
"Description": "",
"ErrorStatusCode": null,
"ErrorStatusMessage": null,
"CreatedBy": "CVBUYER01",
"CreationDate": "2023-11-04T00:09:47+00:00",
"ExpirationDate": null,
"LastUpdatedByUserName": "Clare Furey",
"CreatedByUserName": "Clare Furey",
"AsyncTrackerId": null,
"DownloadInfo": "{\"XFND_EXPIRES\":\"1699057190113\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"47F378914F20E18ADDBAE8F0D63744B918A89F04\",\"XFND_SIGNATURE\":\"gQFArCQc771c~rxYPHY6wjlW9CKQj-qA14tsQKyQkhQ1HQx7Ph4PDzPz2AnV0w8b9teuGTD5xQVlqSG5NKHvA-Qi9kUVaq5Z-w8DyQpIITUB5BGz6JjAhwehe7LsRV0vcsj4OQv6US0xVaUOEJ0ymve1598rcxdVKkpMkC5P53eBomO8pa7UMRJ0c6XEDYBloOHh8FyZMsEuQ9-72qJYiBapsj7Dh498I4i9rr32aBM2pS0dX8jead7nDS0B3p5ucM76OEhEpR4NY6Q326yQ9kZkHUVQZNVhLcjVB0-PHdI4f1MDqx3dqr8cscul90Pozg0CtzQp-Yw7V4MKid6ooA__\",\"XFND_RANDOM\":\"-4409078453837585010\"}",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129/child/questionnaireResponseDetails/300100584909130/child/questionnaireResponseValues/300100584909131/child/responseAttachments/00020000000EACED00057708000110F09CCDF1580000000EACED00057708000110F09CCDF157",
"name": "responseAttachments",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129/child/questionnaireResponseDetails/300100584909130/child/questionnaireResponseValues/300100584909131/child/responseAttachments/00020000000EACED00057708000110F09CCDF1580000000EACED00057708000110F09CCDF157",
"name": "responseAttachments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129/child/questionnaireResponseDetails/300100584909130/child/questionnaireResponseValues/300100584909131",
"name": "questionnaireResponseValues",
"kind": "item"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129/child/questionnaireResponseDetails/300100584909130/child/questionnaireResponseValues/300100584909131/child/responseAttachments/00020000000EACED00057708000110F09CCDF1580000000EACED00057708000110F09CCDF157/enclosure/FileContents",
"name": "FileContents",
"kind": "other"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/questionnaireResponses/300100584891833/child/questionnaireResponseSections/300100584909129/child/questionnaireResponseDetails/300100584909130/child/questionnaireResponseValues/300100584909131/child/responseAttachments/00020000000EACED00057708000110F09CCDF1580000000EACED00057708000110F09CCDF157/enclosure/FileWebImage",
"name": "FileWebImage",
"kind": "other"
}
]
}