API를 사용하여 웹 페이지에 양식 나열

AEM Forms은 웹 개발자가 검색 조건에 맞는 양식 세트를 쿼리하고 검색하는 데 사용할 수 있는 REST 기반 검색 API를 제공합니다. API를 사용하여 다양한 필터를 기반으로 양식을 검색할 수 있습니다. 응답 객체에는 양식 특성, 속성 및 양식의 끝점 렌더링이 포함됩니다.

REST API를 사용하여 양식을 검색하려면 아래에 설명된 쿼리 매개 변수와 함께 https://[server]:[port]/libs/fd/fm/content/manage.json의 서버에 GET 요청을 보내십시오.

쿼리 매개 변수

속성 이름
설명
func

호출할 함수를 지정합니다. 양식을 검색하려면 func 속성 값을 searchForms로 설정합니다.

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

참고: 이 매개 변수는 필수입니다.

appPath

양식을 검색할 응용 프로그램 경로를 지정합니다. 기본적으로 appPath 속성은 루트 노드 수준에서 사용할 수 있는 모든 응용 프로그램을 검색합니다.

단일 검색 쿼리에서 여러 응용 프로그램 경로를 지정할 수 있습니다. 파이프(|) 문자로 여러 패스를 구분합니다.

cutPoints

에셋으로 가져올 속성을 지정합니다. 별표(*)를 사용하여 모든 속성을 한 번에 가져올 수 있습니다. 파이프(|) 연산자를 사용하여 여러 속성을 지정합니다.

예, cutPoints=propertyName1|propertyName2|propertyName3

메모:

  • id, 경로 및 이름과 같은 속성은 항상 가져오는 것이 좋습니다.
  • 모든 에셋에는 다른 속성 세트가 있습니다. formUrl, pdfUrl 및 guideUrl과 같은 속성은 cutpoints 속성에 따라 다릅니다. 이러한 속성은 자산 유형에 따라 다르며 그에 따라 가져옵니다.
relation
검색 결과와 함께 가져올 관련 자산을 지정합니다. 다음 옵션 중 하나를 선택하여 관련 자산을 가져올 수 있습니다.
  • NO_RELATION:관련 자산을 가져오지 마십시오.
  • 즉시:검색 결과와 직접 관련된 자산을 가져옵니다.
  • 모두:직간접적으로 관련 자산을 가져옵니다.
maxSize 가져올 최대 양식 수를 지정합니다.
오프셋 처음부터 건너뛸 양식 수를 지정합니다.
returnCount 지정된 기준과 일치하는 검색 결과를 반환할지 여부를 지정합니다.
statements

문 목록을 지정합니다. 쿼리는 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 - 작거나 같음
    • 포함 - B가 A의 일부인 경우 A는 B를 포함합니다.
    • 전체 텍스트 - 전체 텍스트 검색
    • STARTSWITH - A가 A의 시작 부분인 경우 B로 시작
    • ENDSWITH - B가 A의 끝 부분인 경우 A는 B로 끝납니다.
    • LIKE - LIKE 연산자를 구현합니다.
    • AND - 여러 문 결합

    참고: GT, LT, GTEQ 및 LTEQ 연산자는 LONG, DOUBLE 및 DATE와 같은 선형 유형의 속성에 적용할 수 있습니다.

ordering

검색 결과에 대한 주문 기준을 지정합니다. 기준은 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 속성은 FORM, PDFFORMPRINTFORM 유형의 자산에 적용할 수 있습니다.
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