使用API在網頁上列出表格

AEM Forms提供以REST為基礎的搜尋API,讓網頁開發人員可用來查詢和擷取符合搜尋准則的一組表單。 您可以使用API根據各種篩選條件來搜尋表單。 回應物件包含表單屬性、屬性和轉譯表單端點。

若要使用REST API搜尋表單,請使用下列說明的查詢參數,傳送GET要求至https://'[server]:[port]'/libs/fd/fm/content/manage.json伺服器。

查詢參數

屬性名稱
說明
func

指定要調用的函式。 要搜索表單,請將func 屬性的值設定為searchForms

例如, URLParameterBuilder entityBuilder=new URLParameterBuilder (); entityBuilder.add("func", "searchForms");

注意: 此參數為必填參數。

appPath

指定用於搜索表單的應用程式路徑。 依預設,appPath屬性會搜尋根節點層級上所有可用的應用程式。

您可以在單一搜尋查詢中指定多個應用程式路徑。 使用垂直號(|)字元分隔多個路徑。

cutPoints

指定要隨資產擷取的屬性。 您可以使用星號(*)一次擷取所有屬性。 使用垂直號(|)運算子指定多個屬性。

例如, cutPoints=propertyName1|propertyName2|propertyName3

注意:

  • 一律會擷取ID、路徑和名稱等屬性。
  • 每個資產都有不同的屬性集。 屬性(例如formUrl、pdfUrl和guideUrl)並不取決於切割點屬性。 這些屬性取決於資產類型,並據以提取。
relation
指定要讀取的相關資產以及搜尋結果。 您可以選擇下列其中一個選項來擷取相關資產:
  • NO_RELATION:請勿擷取相關資產。
  • 立即:擷取與搜尋結果直接相關的資產。
  • 全部:直接及間接相關資產。
maxSize 指定要讀取的表單數上限。
偏移 指定要從開始跳過的表單數。
returnCount 指定是否返回與給定條件匹配的搜索結果。
語句

指定語句清單。 查詢會在JSON格式中指定的語句清單上執行。

例如,

JSONArray statementArray=new JSONArray(); JSONObject statement=new JSONObject(); statement.put("name", "title"); statement.put("value", "SimpleSurveyAF"); statement.put("operator", "EQ"); statementArray.put(statement);

在上述範例中,

  • 名稱:指定要搜索的屬性的名稱。
  • :指定要搜索的屬性的值。
  • 運算元:指定在搜索時應用的運算子。支援下列運算子:
    • EQ —— 等於
    • NEQ —— 不等於
    • GT —— 大於
    • LT —— 小於
    • GTEQ —— 大於或等於
    • LTEQ —— 小於或等於
    • CONTAINS - A包含B(如果B是A的一部分)
    • FULLTEXT —— 全文搜尋
    • STARTSWITH —— 如果B是A的開頭部分,則A以B開頭
    • ENDSWITH —— 如果B是A的結尾部分,則A以B結尾
    • LIKE —— 實作LIKE運算子
    • AND —— 合併多個陳述式

    注意: GT、LT、GTEQ和LTEQ運算子適用於線性類型的屬性,例如LONG、DOUBLE和DATE。

排序

指定搜尋結果的順序標準。 標準以JSON格式定義。 您可以對多個欄位的搜尋結果排序。 結果按欄位在查詢中顯示的順序排序。

例如,

要檢索按標題屬性按升序排序的查詢結果,請添加以下參數:

JSONArray orderingsArray=new JSONArray(); JSONObject orderings=new JSONObject(); orderings.put("name", "title"); orderings.put("criteria", "ASC"); orderingsArray.put(orderings); entityBuilder.add("orderings", orderingsArray.toString());

  • 名稱:指定用於排序搜索結果的屬性的名稱。
  • 准則:指定結果的順序。order屬性接受以下值:
    • ASC —— 使用ASC以升序排列結果。
    • DES —— 使用DES以降序排列結果。
includeXdp 指定是否檢索二進位內容。 includeXdp屬性適用於FORMPDFFORMPRINTFORM類型的資產。
assetType 指定要從所有已發佈資產擷取的資產類型。 使用垂直號(|)運算子指定多個資產類型。 有效的資產類型包括FORM、PDFFORM、PRINTFORM、RESOURCE和GUIDE。

請求範例

func : searchForms
appPath : /content/dam/formsanddocuments/MyApplication23
cutPoints : title|description|author|status|creationDate|lastModifiedDate|activationDate|expiryDate|tags|allowedRenderFormat|formmodel
relation : NO_RELATION
includeXdp : false
maxSize : 10
offset : 0
returnCount : true
statements: [{"name":"name","value":"*Claim.xdp","operator":"CONTAINS"},
                {"name":"","value":"Expense","operator":"FULLTEXT"},
                {"name":"description","value":"ABCD*","operator":"CONTAINS"},
                {"name":"status","value":"false","operator":"EQ"},
                {"name":"lastModifiedDate","value":"01/09/2013","operator":"GTEQ"},
                {"name":"lastModifiedDate","value":"01/18/2013","operator":"LTEQ"}]
orderings:[{"name" :“lastModifiedDate“:”order”:”ASC”}]

響應示例

[
{"resultCount":2},
    {"assetType":"FORM","name":"ExpenseClaim.xdp","id":"509fa2d5-e3c9-407b-b8dc-fa0ba08eb0ce",
       "path":"/content/dam/formsanddocuments/MyApplication23/1.0/ExpenseClaim.xdp",
       "title":"Expense Report","description":"ABCDEFGIJK","author":"Frank Bowman",
       "tags":[],"formUrl":"/content/dam/formsanddocuments/MyApplication23/1.0/ExpenseClaim.xdp/jcr:content",
       "pdfUrl":"/content/dam/formsanddocuments/MyApplication23/1.0/ExpenseClaim.xdp/jcr:content?type=pdf",
       "references":[],"images":[{"assetType":"resource","name":"Image.gif","id":"5477a127-8bbf-4cec-8f81-2689e5cb4a15",
       "path":"/content/dam/formsanddocuments/MyApplication23/1.0/Image.gif","resourceSize":0}],
       "status":false,"creationDate":1358429845623,"lastModifiedDate":1358429846771},
{"assetType":"FORM","name":"ExpenseClaim.xdp","id":"4312239b-b666-4d36-95bc-641b3a39ddd4",
       "path":"/content/dam/formsanddocuments/MyApplication23/ExpenseClaim.xdp",
       "title":"Expense Report","description":"ABCDefghijklm","author":"Frank Bowman",
       "tags":[],"formUrl":"/content/dam/formsanddocuments/MyApplication23/ExpenseClaim.xdp/jcr:content",
       "pdfUrl":"/content/dam/formsanddocuments/MyApplication23/ExpenseClaim.xdp/jcr:content?type=pdf",
       "references":[],"images":[{"assetType":"resource","name":"Image.gif","id":"118a2e3f-7097-4d8c-85d1-651306de284a",
       "path":"/content/dam/formsanddocuments/MyApplication23/Image.gif","resourceSize":0}],"status":false,
       "creationDate":1358429856690,"lastModifiedDate":1358430109023}
]

相關文章

本頁內容

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now