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)

이름 유형 필수? 설명
company핸들 xsd:string 검색할 자산이 있는 회사에 대한 핸들입니다.
accessUser핸들 xsd:string 아니요 관리자가 다른 사용자로 작업할 수 있습니다.
액세스 그룹 핸들 xsd:string 아니요 관리자가 다른 그룹의 일부로 작업할 수 있습니다.
폴더 xsd:string 아니요 에셋 검색을 위한 루트 경로입니다. 생략하면 회사 루트 폴더가 사용됩니다.
includeSubfolder xsd:부울 아니요 다음으로 설정 true 하위 폴더를 검색합니다.
publishState xsd:string 아니요 게시 상태 선택.
trashState xsd:string 아니요 휴지통 상태 선택. 기본값은 입니다 NotInTrash.
조건 일치 모드 xsd:string 아니요

검색 일치 모드 선택 - 결과 결합 keywordArray,

조건 일치 모드

systemFieldConditionArray, 및 metadataConditionArray. 기본값은 입니다 모두 일치.

keywordArray types:StringArray 아니요

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

일치시킬 키워드의 문자열 배열입니다.

시스템 필드 일치 모드 xsd:string 아니요

결합을 위한 검색 일치 모드 선택 systemFieldCondition 와 일치합니다. 기본값은 입니다 모두 일치

.

systemFieldConditionArray

유형:SystemFieldConditionArray

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

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

술어는 다음에 따라 결합됩니다. 태그 일치 모드 를 설정한 다음 의 모든 용어와 결합 keywordArray, systemFieldConditionArray, 및 metadataConditionArray 에 따라 조건 일치 모드 설정.

metadataMatchmode xsd:string 아니요 결합을 위한 일치 모드 검색 metadataCondition 와 일치합니다. 기본값은 입니다 모두 일치.
metadataConditionArray

유형:MetadataConditionArray

아니요 메타데이터 필드 검색 조건의 배열입니다.
assetTypeArray types:StringArray 아니요 검색에 포함할 에셋 유형의 배열입니다.
excludeAssetTypeArray types:StringArray 아니요 검색에서 제외할 자산 유형 배열.
assetSubTypeArray types:StringArray 아니요 필터링할 하위 유형 이름 목록입니다.
strictSubTypeCheck xsd:부울 아니요 If true assetSubTypeArray 은(는) 비어 있지 않습니다. 하위 유형이 포함된 자산만 assetSubTypeArray 반환됩니다. If false (기본값), 정의된 하위 유형이 없는 자산이 반환됩니다.
excludeByproducts xsd:부울 아니요 true인 경우 리핑된 PDF 페이지 이미지와 같은 기본 에셋 수집 중에 생성된 부산물 에셋은 검색 결과에서 제외됩니다. 기본값은 false입니다.
excludVaspactArray

유형:ExcludeVaspectArray

아니요 검색 결과에서 제외할 부산물 자산 생성 조건의 배열입니다. 존재하는 경우 이 매개 변수는 excludeByproducts 설정을 무시합니다.
projectHandle xsd:sting 아니요 검색할 자산이 포함된 프로젝트 핸들입니다.
recordsPerPage xsd:int 아니요 반환할 최대 결과 수.
resultsPage xsd:int 아니요 다음을 기준으로 반환할 결과 페이지 지정 recordsPerPage 페이지 크기.
정렬 기준 xsd:string 아니요 에셋 정렬 필드 선택.
sortDirection xsd:string 아니요 정렬 방향 선택.
responseFieldArray types:StringArray 아니요 응답에 포함할 필드 및 하위 필드 목록을 포함합니다.
exclude필드 배열 types:StringArray 아니요 응답에서 제외할 필드 및 하위 필드 목록을 포함합니다.

출력(searchAssetsReturn)

이름 유형 필수 설명
합계 행 수 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>

이 페이지에서는