ファイルのリスト

このAPIを使用して、ファイルのリストをフェッチします。

API

/cemli/v1/customers/{supportIdentifier}/services/{serviceType}/products/files

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客のCSIおよび使用可能なserviceTypeに関するこの情報にアクセスできます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLIファイルAPIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

  • このAPIは、顧客およびサービスに関連するUMPからのファイルのリストを公開します。
  • {supportIdentifier}および{serviceType}は、前述の依存関係から取得できます。
  • 説明が必要なレスポンス・フィールド:
    • fileIdは、ファイル詳細のフェッチに使用されるファイルの一意の識別子です。
    • fileTypeは、SQL、Java、XMLパブリッシャXLFファイルなどのファイルのタイプです。
    • parametersは、ファイル処理に適用可能な追加の入力パラメータです。
    • archivedは、ファイルがアーカイブ済かアクティブかを識別するために使用されます。
    ノート

    ページ区切りがサポートされています。詳細は、ページ区切りの項を参照してください。

動詞

GET

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
includeArchived 問合せパラメータ アーカイブされたファイルをリストに含めるかどうか(デフォルト値 = N) いいえ
excludeOafzip 問合せパラメータ OAF zipファイルをリストから除外するかどうか(デフォルト値 = Y) いいえ
filename 問合せパラメータ ファイル名 いいえ
description 問合せパラメータ ファイルの説明 いいえ
product 問合せパラメータ 製品名(xbolなど) いいえ
objectType 問合せパラメータ ファイル・タイプ(xdf、sql、javaなど) いいえ
parameters 問合せパラメータ ファイル処理に使用する入力パラメータのリスト いいえ
version 問合せパラメータ 現在のファイル いいえ
language 問合せパラメータ NLS言語(US、FRなど) いいえ
uploadedBy 問合せパラメータ ファイルをアップロードしたユーザー、つまりユーザーの電子メールID。 いいえ
uploadedOn 問合せパラメータ アップロード日 いいえ
fileLocation 問合せパラメータ アップロードされたファイルの場所 いいえ

サンプル・レスポンス

[
  {
    "fileId": 10882,
    "fileName": "XxExpenseReportLineEO.xml",
    "description": "CEMLI XML XLF Patch File",
    "version": "121.000001",
    "language": "US",
    "product": {
      "name": "xbol"
    },
    "fileType": {
      "code": "xmlp_xlf",
      "description": "XML Publisher XLF file"
    },
    "archived": false,
    "parameters": [
      {
        "name": "APPS_SHORT_NAME",
        "value": "xbol",
        "type": "TEXT"
      },
      {
        "name": "TEMPLATE_CODE",
        "value": "APXCCPUT",
        "type": "TEXT"
      }
    ],
    "uploadedBy": "<user e-mail>",
    "uploadedOn": "2020-08-26T10:53:51-07:00"
  },
  {
    "fileId": 10886,
    "fileName": "XMLP_PUB_XLF_TILE.xmlp_xlf",
    "description": "CEMLI XML XLF Patch File Upload",
    "version": "121.000001",
    "language": "US",
    "product": {
      "name": "xbol"
    },
    "fileType": {
      "code": "xmlp_xlf",
      "description": "XML Publisher XLF file"
    },
    "archived": false,
    "parameters": [
      {
        "name": "APPS_SHORT_NAME",
        "value": "xbol",
        "type": "TEXT"
      },
      {
        "name": "TEMPLATE_CODE",
        "value": "APXCCPUT",
        "type": "TEXT"
      }
    ],
    "uploadedBy": "<user's e-mail>",
    "uploadedOn": "2020-08-26T10:53:51-07:00"
  },
  {
    "fileId": 10980,
    "fileName": "APXCCPUT_XML.xlf",
    "description": "CEMLI XML XLF",
    "version": "121.000001",
    "language": "US",
    "product": {
      "name": "xxeis"
    },
    "fileType": {
      "code": "xmlp_xlf",
      "description": "XML Publisher XLF file"
    },
    "archived": false,
    "parameters": [
      {
        "name": "APPS_SHORT_NAME",
        "value": "xxeis",
        "type": "TEXT"
      },
      {
        "name": "TEMPLATE_CODE",
        "value": "template",
        "type": "TEXT"
      }
    ],
    "uploadedBy": "<user e-mail>",
    "uploadedOn": "2020-08-26T10:53:51-07:00"
  }
]