機械翻訳について
  1. Oracle Fusion Cloud ProcurementのREST API
  2. タスク
  3. サプライヤ・ネゴシエーション
  4. 添付

すべての添付の取得

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/attachments

リクエスト

パス・パラメータ
  • これは、サプライヤ・ネゴシエーション・リソースの複合キーを構成し、サプライヤ・ネゴシエーションのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにサプライヤ・ネゴシエーションの特定のインスタンスにナビゲートするために、サプライヤ・ネゴシエーション収集リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 主キーに従って添付を検索します。
      ファインダ変数:
      • AttachedDocumentId; integer; 添付を一意に識別する値。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AttachedDocumentId; integer; 添付を一意に識別する値。 これは、ユーザーがドキュメントを添付するときにアプリケーションが作成する主キーです。
    • CategoryName; string; 添付のカテゴリ。
    • CreatedBy; string; 添付ファイルを作成したユーザー。
    • CreatedByUserName; string; ユーザーがネゴシエーションの添付を作成するときに使用したログインします。
    • CreationDate; string; ユーザーが添付レコードを作成した日付。
    • DatatypeCode; string; データ型を識別する略称。 値には、FILE、FOLDER、TEXTまたはWEB_PAGEがあります。
    • 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=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : supplierNegotiations-attachments
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : supplierNegotiations-attachments-item-response
タイプ: object
ソースを表示
  • タイトル: Asynchronous Upload Tracker Id
    アップロードされたファイルのトラッキングに使用される識別子。
  • タイトル: Attached Document Id
    添付を一意に識別する値です。 これは、ユーザーがドキュメントを添付するときにアプリケーションが作成する主キーです。
  • タイトル: Category
    最大長: 30
    添付のカテゴリ。
  • タイトル: Shared
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、添付は共有されます。 falseの場合、添付は共有されません。 デフォルト値はfalseです。
  • タイトル: Created By
    読取り専用: true
    最大長: 255
    添付を作成したユーザー。
  • タイトル: Created By User Name
    読取り専用: true
    ネゴシエーションの添付の作成時に使用したユーザーにログインします。
  • タイトル: Creation Date
    読取り専用: true
    ユーザーが添付レコードを作成した日付。
  • タイトル: Type
    最大長: 30
    デフォルト値: FILE
    データ型を識別する略語。 値には、FILE、FOLDER、TEXTまたはWEB_PAGEがあります。
  • タイトル: Description
    最大長: 255
    添付の説明。
  • 最大長: 255
    添付されたドキュメントを一意に識別する値。
  • タイトル: Dm Folder Path
    最大長: 1000
    添付のフォルダ・パス。
  • 最大長: 255
    添付文書のバージョンを識別する番号です。
  • タイトル: DownloadInfo
    添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
  • タイトル: Error Status Code
    添付のエラー(ある場合)を識別する略称です。
  • タイトル: Error Status Message
    添付のエラー・メッセージのテキスト(存在する場合)。
  • タイトル: Expiration Date
    添付のコンテンツが失効する日付。
  • タイトル: File Contents
    添付ファイルの内容。
  • タイトル: File Name
    最大長: 2048
    添付のファイル名。
  • タイトル: File Url
    添付ファイルのURL(Uniform Resource Locator)。
  • タイトル: File Web Image
    読取り専用: true
    ソースが変換可能なイメージの場合に、.png形式で表示されるファイルのBase64でエンコードされたイメージ。
  • タイトル: Last Update Date
    読取り専用: true
    ユーザーが添付を最後に更新した日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 255
    添付を最後に更新したユーザー。
  • タイトル: Last Updated By User
    読取り専用: true
    ネゴシエーションの添付の更新時にユーザーが使用したログインします。
  • Links
  • タイトル: Title
    添付のタイトル。
  • タイトル: Uploaded File Content Type
    添付のコンテンツ・タイプ。
  • タイトル: File Size
    添付ファイルの長さ。
  • タイトル: Uploaded File Name
    添付ファイルの名前。
  • タイトル: Uploaded Text
    添付のテキスト。
  • タイトル: Uri
    最大長: 4000
    添付ファイルを識別するURI (Uniform Resource Identifier)。
  • タイトル: Url
    最大長: 4000
    添付ファイルを識別するURI (Uniform Resource Identifier)。
  • タイトル: User Name
    読取り専用: true
    最大長: 255
    添付の追加または変更時にユーザーが使用したサインイン詳細。
トップに戻る

例

この例では、すべての添付を取得する方法について説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/attachments"

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
    "items": [
        {
            "AttachedDocumentId": 300100152357506,
            "LastUpdateDate": "2018-06-28T10:55:04.373+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "DatatypeCode": "WEB_PAGE",
            "FileName": null,
            "DmFolderPath": null,
            "Url": "https://www.google.com/",
            "CategoryName": "TO_SUPPLIER",
            "UserName": "To Supplier",
            "Uri": null,
            "FileUrl": null,
            "UploadedText": null,
            "UploadedFileContentType": null,
            "UploadedFileLength": null,
            "UploadedFileName": null,
            "ContentRepositoryFileShared": "false",
            "Title": "Google Homepage",
            "Description": "Google URL",
            "ErrorStatusCode": null,
            "ErrorStatusMessage": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T10:54:10.473+00:00",
            "ExpirationDate": null,
            "LastUpdatedByUserName": "Clare Smith",
            "CreatedByUserName": "Clare Smith",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/attachments/00020000000EACED00057708000110F082FA72820000000EACED00057708000110F082FA7281",
                    "name": "attachments",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/attachments/00020000000EACED00057708000110F082FA72820000000EACED00057708000110F082FA7281",
                    "name": "attachments",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495",
                    "name": "supplierNegotiations",
                    "kind": "item"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/attachments/00020000000EACED00057708000110F082FA72820000000EACED00057708000110F082FA7281/enclosure/FileContents",
                    "name": "FileContents",
                    "kind": "other"
                }
            ]
        },
        {
            "AttachedDocumentId": 300100152357504,
            "LastUpdateDate": "2018-06-28T10:55:04.109+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "DatatypeCode": "FILE",
            "FileName": "testdoc.xlsx",
            "DmFolderPath": null,
            "Url": null,
            "CategoryName": "TO_BUYER",
            "UserName": "To Buyer",
            "Uri": null,
            "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a4174?XFND_SCHEME_ID=1&XFND_CERT_FP=EFD2679E50385787E0FB564A153B7DA7328BA782&XFND_RANDOM=-6756057589832949095&XFND_EXPIRES=1530187405209&XFND_SIGNATURE=MUYLXj93tgwfdhbIvy8fh017Vvsq4nSd6gh64Nj00BKH9HjFEQeZDNcpbqcQfY3wReK2H7wtX3yn15XSfUhNKAHm2ZpZLo7hSCu4qsD0oZb7XX8XdiTyU2wHrsU30rOq5vVCk-r74p2Abjwqm5QLTd5UTjwIMaVcvIdnejwntvQlwHgf7MkbC-XalHbRM~98n5vyPFDw-UwGBCKdUzGRd6nd7R0JupfGya-Mt6ktcHYq5td9iEG8y3v1H0gOoZhi1N4eB-frUoB7OYH95kmBx8JU~gRPZlhFOQKnQMo3ywQZkjo44NRCFg0iCCIo87xQueLCnYDWubfvKyATwemZKQ__&Id=4174&download",
            "UploadedText": null,
            "UploadedFileContentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
            "UploadedFileLength": 8323,
            "UploadedFileName": null,
            "ContentRepositoryFileShared": "false",
            "Title": "testdoc.xlsx",
            "Description": "Testing File attachment",
            "ErrorStatusCode": null,
            "ErrorStatusMessage": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-06-28T10:53:38.847+00:00",
            "ExpirationDate": null,
            "LastUpdatedByUserName": "Clare Smith",
            "CreatedByUserName": "Clare Smith",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/attachments/00020000000EACED00057708000110F082FA72800000000EACED00057708000110F082FA727F",
                    "name": "attachments",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/attachments/00020000000EACED00057708000110F082FA72800000000EACED00057708000110F082FA727F",
                    "name": "attachments",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495",
                    "name": "supplierNegotiations",
                    "kind": "item"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/attachments/00020000000EACED00057708000110F082FA72800000000EACED00057708000110F082FA727F/enclosure/FileContents",
                    "name": "FileContents",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 10,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/attachments",
            "name": "attachments",
            "kind": "collection"
        }
    ]
}
「トップに戻る」