개요

Frame.io API는 웹 애플리케이션의 기능과 동일하게, 전체 계정 내 에셋에 대한 심층적이고 다각적인 검색을 지원합니다. 가장 유용하게 사용되는 필터는 Team, Project, Status이지만, 필터와 정렬 기능을 다양하게 조합하여 API 기반의 매우 구체적인 데이터 세트를 생성할 수 있습니다. 일반적으로 account_id, q(쿼리), sort를 제외한 모든 필터는 동일한 구조를 따르며, 아래에 모두 설명되어 있습니다.

기본값

검색을 트리거하는 API 요청은 항상 동일합니다.

항상 동일한 요청입니다.

POST to https://api.frame.io/v2/search/library

명시적으로 제공되지 않은 경우, 검색 조정을 위한 기본값은 다음과 같습니다.

이 가이드에 대하여

이 가이드에서는 다음 조건과 일치하는 검색 쿼리를 작성하는 과정을 안내합니다.

• 계정 내에 있는 에셋
• "moon" 쿼리와 일치
• 특정 프로젝트에 존재함
• 2020년 4월 1일에서 30일 사이에 업로드됨
• “승인됨”로 표시됨

검색을 위한 본문은 최종적으로 다음과 같은 형태가 됩니다.

1
{
2
    "account_id": "<account_id>",
3
    "q": "moon",
4
    "sort": "name",
5
    "filter": {
6
        "inserted_at": [
7
            {
8
                "op": "gte",
9
                "value": "2020-04-01T04:00:00.000Z"
10
            },
11
            {
12
                "op": "lte",
13
                "value": "2020-04-30T03:59:59.999Z"
14
            }
15
        ],
16
        "project_id": {
17
            "op": "eq",
18
            "value": "<project_id>"
19
        },
20
        "label": {
21
            "op": "eq",
22
            "value": "approved"
23
        }
24
    },
25
    "page_size": 10,
26
    "page": 1
27
}

계정, 쿼리, 정렬

Account(account_id), query (q), sort은 검색 쿼리의 filter 속성 외부에 존재하는 가장 기본적인 세 가지 구성 요소입니다.

계정 컨텍스트

기술적으로 검색을 수행하는 데 필요한 유일한 속성은 account_id입니다. 이것만으로도 기본 페이지 매김 값(1페이지부터 시작하여 페이지당 10개의 에셋)을 적용해 계정 내의 모든 에셋(폴더 포함)을 가져올 수 있습니다.

1
{
2
    "account_id": "<account_id>"
3
}

검색 쿼리

그 다음으로 가장 일반적으로 포함되는(그리고 유용한) 속성은 쿼리 자체입니다. 참고: Frame.io API 검색은 null 쿼리를 허용하므로 와일드카드(*) 쿼리가 필요하지 않습니다. 무언가를 검색하거나 계정 내 모든 에셋의 정렬된 목록(필터링될 수도 있음)을 요청하는 것입니다.

이 가이드의 예시에서는 “moon”이라는 용어를 검색합니다.

1
{
2
    "account_id": "<account_id>",
3
    "q": "moon"
4
}

정렬

Frame.io는 여러 가지 정렬 옵션을 지원합니다. 정렬 순서 구문은 모든 옵션에서 유사합니다.

• 기본 정렬 방향이 존재합니다.
• 정렬 기준을 반대로 바꾸려면 정렬 값 앞에 음수 기호(-)를 추가합니다.

예를 들어 역알파벳순(Z부터 A)으로 정렬하려면 "sort": "-name"으로 선언합니다. 기본 정렬 방식은 “관련성”입니다. 따라서 별도로 선언할 필요가 없으며, sort 속성이 제공되지 않은 경우 이 방식이 적용된 것으로 간주됩니다.

1
{
2
    "account_id": "<account_id>",
3
    "q": "moon",
4
    "sort": "name"
5
}

필터 및 페이지 매김

필터는 Frame.io 에셋 검색에서 가장 다루기 까다로우면서도 가장 강력한 기능입니다. 필터는 단일 filter 오브젝트 내에 작성되며, 모두 작업(op)과 값(value)이라는 동일한 패턴을 따릅니다. 필터는 다음과 같은 일반적인 약어를 사용하며, “equals” 이외의 비교 옵션은 날짜 및 크기 쿼리에만 사용할 수 있습니다.

• eq — 같음
• lt — 보다 작음
• gt — 보다 큼
• lte — 작거나 같음
• gte — 크거나 같음
• match — 정확히 일치, 업로더 및 파일 유형 필터에만 사용

예를 들어 이미 알고 있는 project_id와 일치시키는 filter는 다음과 같이 구성됩니다.

1
{
2
    "filter": {
3
        "project_id": {
4
            "op": "eq",
5
            "value": "<project_id>"
6
        }
7
    }
8
}

옵션 및 작업

다음 표는 각 필터 유형과 관련된 옵션 및 작업을 설명합니다.

계속해서 쿼리를 구축하기 위해 이제 다음 조건의 에셋에 대한 필터를 추가할 수 있습니다.

• 특정 프로젝트에 존재함
• 2020년 4월 1일에서 30일 사이에 업로드됨
• “승인됨”으로 표시됨

1
{
2
    "account_id": "<account_id>",
3
    "q": "moon",
4
    "sort": "name",
5
    "filter": {
6
        "inserted_at": [
7
            {
8
                "op": "gte",
9
                "value": "2020-04-01T04:00:00.000Z"
10
            },
11
            {
12
                "op": "lte",
13
                "value": "2020-04-28T03:59:59.999Z"
14
            }
15
        ],
16
        "project_id": {
17
            "op": "eq",
18
            "value": "<project_id>"
19
        },
20
        "label": {
21
            "op": "eq",
22
            "value": "approved"
23
        }
24
    }
25
}