添付ファイルを1つ取得
get
/fscmRestApi/resources/11.13.18.05/supplierQualificationAreas/{QualAreaId}/child/attachments/{attachmentsUniqID}
リクエスト
パス・パラメータ
- QualAreaId(required): integer(int64)
エリアを一意に識別する値。
- attachmentsUniqID(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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : supplierQualificationAreas-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 (ユニ・フォーム・リソース・保管棚)。 -
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
添付されたwebページのURL (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 "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/QualAreaId/child/attachments/AttachedDocumentId"
たとえば、次のコマンドは1つの添付ファイルを取得します:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100047524569/child/attachments/00020000000EACED00057708000110F0857EE4F00000000EACED00057708000110F0857EE4EF"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "AttachedDocumentId": 300100194591984, "LastUpdateDate": "2020-05-12T12:02:45.780+00:00", "LastUpdatedBy": "BUYER19", "DatatypeCode": "WEB_PAGE", "FileName": null, "DmFolderPath": null, "DmDocumentId": null, "DmVersionNumber": null, "Url": "https://www.example.com", "CategoryName": "POQ_INTERNAL", "UserName": "Internal to Supplier Qualification", "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "Company link", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "BUYER19", "CreationDate": "2020-05-12T12:02:10.858+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Allan Brown", "CreatedByUserName": "Allan Brown", "AsyncTrackerId": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100047524569/child/attachments/00020000000EACED00057708000110F0857EE4F00000000EACED00057708000110F0857EE4EF", "name": "attachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100047524569/child/attachments/00020000000EACED00057708000110F0857EE4F00000000EACED00057708000110F0857EE4EF", "name": "attachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100047524569", "name": "supplierQualificationAreas", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100047524569/child/attachments/00020000000EACED00057708000110F0857EE4F00000000EACED00057708000110F0857EE4EF/enclosure/FileContents", "name": "FileContents", "kind": "other" } ] }