すべての添付の取得
get
/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/lines/{POLineId}/child/attachments
リクエスト
パス・パラメータ
- POLineId(required): integer(int64)
購買オーダー明細を一意に識別する値。
- draftPurchaseOrdersUniqID(required): string
これは、下書き購買オーダー・リソースの複合キーを構成し、下書き購買オーダーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ドラフト購買オーダーの特定のインスタンスに移動してハッシュ・キーを取得するために、ドラフト購買オーダー・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 主キーに従って、下書き購買オーダー添付を検索します。
ファインダ変数:- AttachedDocumentId; integer; 購買オーダーに添付された文書を一意に識別する値。
- PrimaryKey : 主キーに従って、下書き購買オーダー添付を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AttachedDocumentId; integer; 購買オーダーに添付された文書を一意に識別する値。 これは、ユーザーが購買オーダーに文書を添付するときにアプリケーションが作成する主キーです。
- CategoryName; string; 添付されたドキュメントのカテゴリ。
- CreatedBy; string; 添付ドキュメントを作成したユーザー。
- CreatedByUserName; string; 購買オーダーに添付された文書を作成するときに使用したユーザーにログインします。
- CreationDate; string; ユーザーが添付文書を作成した日付。
- DatatypeCode; string; データ型を識別する略称。
- DmDocumentId; string; 添付されたドキュメントを一意に識別する値。
- DmFolderPath; string; 添付されたドキュメントのフォルダ・パス。
- DmVersionNumber; string; 添付されたドキュメントのバージョンを識別する番号。
- ExpirationDate; string; 添付されたドキュメントのコンテンツが期限切れになる日付。
- FileName; string; 添付されたドキュメントのファイル名。
- LastUpdateDate; string; ユーザーが購買オーダーに添付された文書を最後に更新した日時。
- LastUpdatedBy; string; 購買オーダーに添付された文書を最後に更新したユーザー。
- LastUpdatedByUserName; string; 購買オーダーに添付された文書を更新するときに使用したユーザーにログインします。
- Uri; string; 添付されたドキュメントを識別するURI (Uniform Resource Identifier)。
- Url; string; 添付されたドキュメントを識別するURI (Uniform Resource Identifier)。
- UserName; string; 添付されたドキュメントの追加または変更時にユーザーが使用したログインします。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : draftPurchaseOrders-lines-attachments
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内の品目。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : draftPurchaseOrders-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
添付ドキュメントの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 -u username:password "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/draftPurchaseOrdersUniqID/child/lines/POLineId/child/attachments"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items": [ { "AttachedDocumentId": 300100198186746, "LastUpdateDate": "2020-10-19T08:06:04.730+00:00", "LastUpdatedBy": "CVBUYER01", "DatatypeCode": "FILE", "FileName": "REST Attachment.txt", "DmFolderPath": null, "DmDocumentId": "UCMFA00024862", "DmVersionNumber": "24865", "Url": null, "CategoryName": "TO_SUPPLIER", "UserName": "To Supplier", "Uri": null, "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a24865?XFND_SCHEME_ID=1&XFND_CERT_FP;=0A3C9E5F872EB24E37333CB5F528CEEFA1491781&XFND_RANDOM;=3991500390647731847&XFND_EXPIRES;=1603095658764&XFND_SIGNATURE;=AjXypkkmhrd2DH0G7qltCgDtD672FBiK~tjLesGPyx6yCiXpqQgLB77oyVMdr29rbxz4hfXzlZ3ztAw0rCe2Ne2Z937ItVzXp9Msi9TZVUyN8WIh4CHVyoTuJeSql46zj2UWp8hUynkHQokv7VLr-xYrTTebxrhQImxFzyaLc5Kzi7DzdyxJQHBro-xxcCJngjCulrlbfXcSD7rEjd51d-vQXppPMhdt2X2sICysURqzyuikWXjQRaJ-efNQW4fq~KIRkjCYQjtlM0r2R6T7JI~QPooUL8DvSqas1BQq80neD~1SqybouLdHs3VSwqXAep4VgE8xle3~GWolmbVHtg__&Id;=24865&download;", "UploadedText": null, "UploadedFileContentType": "text/plain", "UploadedFileLength": 7, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "REST Attachment.txt", "Description": "Updated attachment description", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "CVBUYER01", "CreationDate": "2020-10-19T08:06:03+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Clare Jones", "CreatedByUserName": "Clare Jones", "AsyncTrackerId": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504/child/attachments/00020000000EACED00057708000110F085B5BEFA0000000EACED00057708000110F085B5BEF9", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504/child/attachments/00020000000EACED00057708000110F085B5BEFA0000000EACED00057708000110F085B5BEF9", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504", "name": "lines", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504/child/attachments/00020000000EACED00057708000110F085B5BEFA0000000EACED00057708000110F085B5BEF9/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/558749/child/lines/702504/child/attachments", "name": "attachments", "kind": "collection" } ] }