API応答フィルター

既定のAPIフィルター

[ 既定] チェックボックスをオンにすると、そのリソースを取得するためのすべてのAPI呼び出しにフィルタが適用されます。各リソースには、デフォルトAPIフィルターを1つだけ含めることができます。

[既定] チェックボックスがオフの場合、そのリソースのGET呼び出しに?filter='[API Filter Name]'クエリ文字列param：を追加することで、そのAPIフィルターを使用できます。

フィルター

APIフィルターは肯定的です。リストされた属性が応答に表示されることを意味します。これらのリソース属性を追加または削除して、テストの前にフィルターがリソースオブジェクトの属性をサードパーティのシステムに渡し、 保存 するようにします。 

フィルター構文では、複数のドキュメントタイプを使用することもできます。既定では、新しいフィルターには、フィルター作成の最初のステップで選択したリソースに対応する属性が含まれますが、他のドキュメントタイプに適用するフィルターテキストを追加できます。コールアウトまたはWebフックが別のドキュメントのAPI応答フィルターを使用する場合、他のドキュメントのフィルター仕様は無視されます。

以下は、2つのドキュメントタイプが強調表示されたフィルター構文のスクリーンショット例です。図の下でクリックすると、選択可能なテキストを含む同じフィルターを展開できます。

►クリックして、選択可能なテキストを含む請求品目および注文品目変更のフィルター構文の例を示します。

[
  "id",
  "created_at",
  "updated_at",
  "need_by_date",
  "status",
  "submitted_at",
  "ship_to_attention",
  "line_count",
  "exported",
  "total",
  {
    "custom_fields": [
      "migrated_po_number",
      "last_integrated_successfully"
    ]
  },
  {
    "currency": [
      "code",
      "decimals"
    ]
  },
  {
    "requested_by": [
      "id",
      "login",
      "fullname",
      "email",
      "work_level"
    ]
  },
  {
    "ship_to_address": [
      "name",
      "location_code",
      "street1",
      "street2",
      "city",
      "state",
      "postal_code",
      "vat_number",
      "local_tax_number",
      "company_code"
    ]
  },
  {
    "requisition_lines": [
      "id",
      "description",
      "line_num",
      "need_by_date",
      "order_line_id",
      "quantity",
      "receipt_required",
      "source_part_num",
      "unspsc_code",
      "status",
      "total",
      "line_type",
      "unit_price",
      {
        "dci_category": [
          "name",
          {
            "lookup": [
              "name"
            ]
          }
        ]
      },
      {
        "account": [
          "name",
          "code",
          "segment_1",
          "segment_2",
          "segment_3",
          {
            "account_type": [
              "name"
            ]
          }
        ]
      },
      {
        "ul_contract": [
          "name",
          "description",
          "external_ref_num"
        ]
      },
      {
        "custom_fields": [
          "ext_line_num",
          "material_type",
        ]
      },
      {
        "commodity": [
          "name",
          "category",
          "subcategory"
        ]
      },
      {
        "account_allocations": [
          "amount",
          "pct",
          {
            "account": [
              "name",
              "code",
              "segment_1",
              "segment_2",
              "segment_3",
              {
                "account_type": [
                  "name"
                ]
              }
            ]
          }
        ]
      },
      {
        "attachments": [
          "id",
          "created_at",
          "updated_at",
          "type",
          "intent",
          "file",
          "file_file_name",
          "file_file_size"
        ]
      },
      {
        "currency": [
          "code"
        ]
      },
      {
        "supplier": [
          "name",
          "display_name",
          "number",
          "pcard_account",
          {
            "custom_fields": [
              "payment_term_list"
            ]
          }
        ]
      },
      {
        "uom": [
          "code"
        ]
      }
    ]
  },
  {
    "order_line_changes": [
      "id",
      "created_at",
      "updated_at",
      "line_num",
      "description",
      "need_by_date",
      "order_header_change_id",
      "order_line_id",
      "price",
      "quantity",
      "total",
      "paid_amount",
      {
        "custom_fields": {}
      }
    ]
  },
  {
    "current_approval": [
      "id",
      "approvable_type",
      "approvable_id",
      "delegate_id"
    ]
  },
  {
    "created_by": [
      "id",
      "login",
      "fullname",
      "email",
      "work_level"
    ]
  },
  {
    "updated_by": [
      "id",
      "login",
      "fullname",
      "email",
      "work_level"
    ]
  },
  {
    "preparer": [
      "id",
      "login",
      "fullname",
      "email",
      "work_level"
    ]
  }
]

リセット

フィルターを元のリストに戻したい場合は、最初にシードされた値にフィルターを リセットするか、参照のために変更の履歴を拡張することができます。

テスト

フィルターの出力応答を確認するには、最初に [フィルター のテスト]フィールドに既知のID値を入力し、[テスト]をクリックします。すべての標準的な役割のセキュリティは、テストで確認できるものに適用されますが、保存したAPIフィルターは、パラメーターフィールドの指定されたサブセットを読みやすいJSON形式で応答します。

オペレーターとして

fieldsクエリ演算子を使用すると、レスポンスの本文に必要なフィールドを渡すことができます。フィールド値の形式はJSONです。以下の例を参照してください：

?fields=["id","invoice_number",{"invoice_lines":["id","line_num"]}]