searchAssets

지정된 기준에 따라 자산을 검색합니다.

구문

searchAssets: 정보

searchAssets 는 IPS 자산을 검색하는 기본 방법입니다. 이 방법은 폴더 계층 구조를 찾아보거나 이름별로 특정 자산을 찾는 등의 여러 용도로 사용됩니다.

응답 크기

searchAssets 한 번의 호출로 최대 1000개의 자산을 반환합니다. 호출당 최대 10,000개의 자산을 반환하려면 응답 데이터를 totalRows, name, handle, type 및 subType 필드의 하위 집합으로 제한하십시오. 더 큰 세트를 반환하려면 resultPage 매개 변수를 사용하여 페이징을 설정하십시오.

responseFieldArray 또는 excludeFieldArray로 결과 파일 크기 제한

responseFieldArray 또는 excludFieldArray 매개 변수로 데이터 세트의 크기를 제한합니다. 이러한 매개 변수는 메모리 사용 및 대역폭을 줄이고 서버 응답 시간을 개선하는 데 도움이 됩니다.

인증된 사용자 유형

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
노트

자산을 반환하려면 사용자에게 읽기 권한이 있어야 합니다.

매개 변수

입력(searchAssetsParam)

이름 유형 필수? 설명
companyHandle xsd:string 예 검색할 자산이 있는 회사의 핸들입니다.
accessUserHandle xsd:string 아니요 관리자가 다른 사용자로 작업할 수 있도록 해줍니다.
accessGroupHandle xsd:string 아니요 관리자가 다른 그룹의 일부로 작업할 수 있습니다.
폴더 xsd:string 아니요 자산 검색을 위한 루트 경로. 생략하면 회사 루트 폴더가 사용됩니다.
include하위 폴더 xsd:부울 아니요 하위 폴더를 검색하려면 true로 설정하십시오.
publishState xsd:string 아니요 게시 상태 선택.
trashState xsd:string 아니요 삭제 상태 선택. 기본값은 NotInTrash입니다.
conditionMatchMode xsd:string 아니요

keywordArray 결과를 결합하기 위한 검색 일치 모드 선택

conditionMatchMode

systemFieldConditionArray 및 metadataConditionArray. 기본값은 MatchAll입니다.

keywordArray 유형:StringArray 아니요

참고: 사용되지 않는 매개 변수입니다. 사용하지 않는 것이 좋습니다.

일치하는 키워드의 문자열 배열입니다.

systemFieldMatchMode xsd:string 아니요

systemFieldCondition 일치 항목을 조합하기 위한 검색 일치 모드 선택 기본값은 MatchAll입니다.

.

systemFieldConditionArray

유형:SystemFieldConditionArray

아니요 시스템 필드 조건의 배열입니다.
tagMatchMode xsd:string 아니요 검색 일치 모드 문자열 상수. 기본값은 MatchAll입니다.
tagConditionArray 유형:TagConditionArray 아니요

태그 필드 검색 조건자의 배열입니다.

조건자는 tagMatchMode 설정에 따라 결합된 다음 keywordArray, systemFieldConditionArray 및 metadataConditionArray에 있는 모든 용어와 conditionMatchMode 설정에 따라 결합됩니다.

metadataMatchMode xsd:string 아니요 metadataCondition 일치 항목을 조합하기 위한 검색 일치 모드 기본값은 MatchAll입니다.
metadataConditionArray

유형:MetadataConditionArray

아니요 메타데이터 필드 검색 조건 배열입니다.
assetTypeArray 유형:StringArray 아니요 검색에 포함할 자산 유형의 배열입니다.
excludeAssetTypeArray 유형:StringArray 아니요 검색에서 제외할 자산 유형의 배열입니다.
assetSubTypeArray 유형:StringArray 아니요 필터링할 하위 유형 이름 목록입니다.
strictSubTypeCheck xsd:부울 아니요 true 및 assetSubTypeArray가 비어 있지 않으면 하위 유형이 assetSubTypeArray에 있는 자산만 반환됩니다. false(기본값)이면 정의된 하위 유형이 없는 자산이 반환됩니다.
excludeByproducts xsd:부울 아니요 true일 경우, 리디렉션이 적용된 PDF 페이지 이미지와 같은 기본 자산을 수집하는 동안 생성된 부산물 자산은 검색 결과에서 제외됩니다. 기본값은 false입니다.
excludBuzzleArray

유형:ExcludeBuzondsArray

아니요 검색 결과에서 제외할 부산물 자산 생성 조건의 배열입니다. 이 매개 변수가 있으면 이 매개 변수는 excludeByproducts 설정을 무시합니다.
projectHandle xsd:문자열 아니요 검색할 자산이 포함된 프로젝트의 처리합니다.
recordsPerPage xsd:int 아니요 반환할 최대 결과 수입니다.
resultsPage xsd:int 아니요 recordsPerPage 페이지 크기를 기준으로 반환할 결과 페이지를 지정합니다.
sortBy xsd:string 아니요 자산 정렬 필드 선택.
sortDirection xsd:string 아니요 정렬 방향 선택.
responseFieldArray 유형:StringArray 아니요 응답에 포함할 필드 및 하위 필드 목록을 포함합니다.
excludeFieldArray 유형:StringArray 아니요 응답에서 제외하기 위한 필드 및 하위 필드 목록을 포함합니다.

출력(searchAssetsReturn)

이름 유형 필수 설명
*totalRows* xsd:int 아니요 페이지당 레코드가 제한되지 않을 때 검색에서 반환하는 행 수입니다.
*assetArray* types:AssetArray 아니요 검색이 반환하는 자산입니다.

예제

이 코드 샘플은 특정 회사에 속하는 이미지 자산을 검색합니다. 간결성을 위해 응답이 잘립니다.

요청

<ns1:searchAssetsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:includeSubfolders>true</ns1:includeSubfolders>
   <ns1:assetTypeArray>
      <ns1:items>Image</ns1:items>
   </ns1:assetTypeArray>
</ns1:searchAssetsParam>

응답

<searchAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <totalRows>210</totalRows>
   <assetArray>
      <items>
         <assetHandle>24265|1|17061</assetHandle>
         <type>Image</type>
         <name>Autumn Leaves</name>
         ...
      </items>
    </assetArray>
</searchAssetsReturn>

이 페이지에서는