API応答フィルター

[既定]チェックボックスがオフになっている場合、そのAPIフィルターは、そのリソースのGET呼び出しにクエリ文字列param:? filter ='[ 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 ",
" street 1 ",
      "street 2
      "," 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
        "
line ",
"
          unit
_
price ",
          {
"dci_category ": [
name "," lookup "[ name "]]},
      {
"account ":
" name ", "name
" 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 "、"number
          "、" pcard_account
          "、
{custom_fields
            ": [" payment_term "}]]}、
{" uom ": [" code
           
          }]]、
       
{"
      order_
line_changes ":
         
    "、"
updated
      "、
   
"、"
  updated
      "、"、
"file_file_size
      "}}_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 "]}]

可用性

この機能は、すべてのCoupaのお客様に利用可能です。