機械翻訳について
  1. Oracle Fusion Cloud ProcurementのREST API
  2. タスク
  3. 作業確認
  4. 添付

すべての添付の取得

get

/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/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; データ型を示す値。
    • DmDocumentId; string; 添付が作成されるドキュメントID。
    • DmFolderPath; string; 添付の作成元であるフォルダ・パス。
    • DmVersionNumber; string; 添付が作成されるドキュメント・バージョン番号。
    • ExpirationDate; string; 添付内のコンテンツの有効期限日。
    • FileName; string; 添付のファイル名。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • LastUpdatedByUserName; string; レコードを最後に更新したユーザー名。
    • Uri; string; Topology Managerタイプの添付のURI。
    • Url; string; webページ・タイプの添付のURL。
    • 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のデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : workConfirmations-attachments
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : workConfirmations-attachments-item-response
タイプ: object
ソースを表示
トップに戻る

例

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

cURLコマンドの例

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

curl -u username:password "https://servername/fscmRestApi/resources/version/workConfirmations/WorkConfirmationId/child/attachments"

たとえば:

curl -u username:password "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます: 
{
	"items": [
	{
    "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"
        }
    ]
}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/workConfirmations/558749/child/attachments",
		"name": "attachments",
		"kind": "collection"
	}
	]
}
「トップに戻る」