{"components":{"schemas":{"AutomationSearchCriteriaSchema":{"properties":{"automation_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"execution_time":{"format":"date-time","type":"string"},"filter":{"$ref":"#/components/schemas/CriteriaFilter"}},"required":["automation_ids"],"type":"object"},"BaseQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"BulkAddToFavoritesSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["object_ids"],"type":"object"},"BulkDeleteFromFavoritesSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["object_ids"],"type":"object"},"BulkSavedSearchActionSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchFaceExtractionSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchFilesDeleteSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"storage_id":{"format":"uuid","type":"string"}},"required":["job_id","search_ids","storage_id"],"type":"object"},"BulkSavedSearchMetadataUpdateSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsACLUpdateSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsAnalyzeSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsDeleteSchema":{"properties":{"content_only":{"default":true,"type":"boolean","writeOnly":true},"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsSetApprovalSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsTranscodeSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsTranscribeSchema":{"properties":{"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"BulkSavedSearchObjectsTransferSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["include_assets","include_collections","job_id","search_ids"],"type":"object"},"BulkSavedSearchReindexSchema":{"properties":{"include_assets":{"type":"boolean"},"include_collections":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"search_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["job_id","search_ids"],"type":"object"},"CriteriaFilter":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/CriteriaFilter"},"type":"array"},"operator":{"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/CriteriaTerm"},"type":"array"}},"required":["operator"],"type":"object"},"CriteriaFilterSchema":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"type":"array"},"operator":{"type":"string"},"terms":{"items":{"$ref":"#/components/schemas/CriteriaTerm"},"type":"array"}},"required":["operator"],"type":"object"},"CriteriaRangeFilter":{"properties":{"max":{"type":"string"},"min":{"type":"string"},"timezone":{"description":"Format: +02:00. Results returned in UTC by default","type":"string"}},"type":"object"},"CriteriaRangeFilterSchema":{"properties":{"max":{"type":"string"},"min":{"type":"string"},"timezone":{"description":"Format: +02:00. Results returned in UTC by default","type":"string"}},"type":"object"},"CriteriaSortSchema":{"properties":{"name":{"type":"string"},"order":{"type":"string"}},"required":["name"],"type":"object"},"CriteriaTerm":{"properties":{"exists":{"type":"boolean"},"missing":{"type":"boolean"},"name":{"type":"string"},"range":{"$ref":"#/components/schemas/CriteriaRangeFilter"},"value":{"type":"string"},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"CriteriaTermSchema":{"properties":{"exists":{"type":"boolean"},"missing":{"type":"boolean"},"name":{"type":"string"},"range":{"$ref":"#/components/schemas/CriteriaRangeFilterSchema"},"value":{"type":"string"},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"DiscoveryEntitiesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/DiscoveryEntity"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"DiscoveryEntity":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"object"},"object_id":{"format":"uuid","type":"string"},"object_type":{"enum":["COLLECTION","SAVED_SEARCH"],"type":"string"},"title":{"type":"string"},"user_id":{"type":"string"}},"required":["object_id","object_type","title","user_id"],"type":"object"},"DiscoveryEntitySchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"object"},"object_id":{"format":"uuid","type":"string"},"object_type":{"enum":["COLLECTION","SAVED_SEARCH"],"type":"string"},"title":{"type":"string"},"user_id":{"type":"string"}},"required":["object_id","object_type","title","user_id"],"type":"object"},"DiscoveryViewSettingsSchema":{"properties":{"entity_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"}},"required":["entity_ids"],"type":"object"},"FacetFilterSchema":{"properties":{"name":{"type":"string"},"value_in":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"ReindexSavedSearchGroupSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexSavedSearchSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"SavedSearch":{"properties":{"criteria":{"$ref":"#/components/schemas/SearchCriteriaSaved"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"favoured":{"readOnly":true,"type":"boolean"},"group_id":{"format":"uuid","nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"required":["criteria","name"],"type":"object"},"SavedSearchConvertCollectionSchema":{"properties":{"collection_id":{"format":"uuid","type":"string"}},"required":["collection_id"],"type":"object"},"SavedSearchCopyFromTemplateSchema":{"properties":{"from_domain":{"format":"uuid","type":"string"},"metadata_view_map":{"additionalProperties":{"format":"uuid","type":"string"},"type":"object"},"to_domain":{"format":"uuid","type":"string"}},"required":["from_domain","metadata_view_map","to_domain"],"type":"object"},"SavedSearchElasticSchema":{"properties":{"criteria":{"type":"string"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"favoured":{"readOnly":true,"type":"boolean"},"group_id":{"format":"uuid","nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"SavedSearchGroupQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"SavedSearchGroupSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"saved_searches_count":{"type":"integer"},"system_domain_id":{"format":"uuid","type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["name"],"type":"object"},"SavedSearchGroupsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SavedSearchGroupSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SavedSearchQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"scroll":{"type":"boolean"},"scroll_id":{"format":"uuid","type":"string"},"search_after":{"description":"This parameter is used for infinite scroll pagination instead of deprecatedscroll API. It accepts a list of sort keys that will be used for getting a next page and it can be obtained from `_sort` key of the last object of the previous response","items":{},"nullable":true,"type":"array"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"SavedSearchResultsSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"},"last_url":{"readOnly":true,"type":"string"},"name":{"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SearchDocument"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"search_criteria_document":{"$ref":"#/components/schemas/SavedSearch"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SavedSearchSchema":{"properties":{"criteria":{"$ref":"#/components/schemas/SearchCriteriaSaved"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"favoured":{"readOnly":true,"type":"boolean"},"group_id":{"format":"uuid","nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"permissions":{"items":{"type":"string"},"type":"array"}},"required":["criteria","name"],"type":"object"},"SavedSearchesSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SavedSearchElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SearchContentInfoInternalSchema":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"collections_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"media_formats":{"items":{"readOnly":true,"type":"object"},"type":"array"},"media_types":{"items":{"readOnly":true,"type":"object"},"type":"array"},"storage_info":{"items":{"$ref":"#/components/schemas/StorageContentInfo"},"readOnly":true,"type":"array"},"title":{"readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"SearchContentInfoSchema":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"collections_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"storage_info":{"items":{"$ref":"#/components/schemas/StorageContentInfo"},"readOnly":true,"type":"array"},"title":{"readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"SearchCriteriaBaseSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchCriteriaSaved":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchCriteriaSavedSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchCriteriaSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"exclude_fields":{"items":{"type":"string"},"type":"array"},"facets":{"items":{"type":"string"},"type":"array"},"facets_filters":{"items":{"$ref":"#/components/schemas/FacetFilterSchema"},"type":"array"},"filter":{"$ref":"#/components/schemas/CriteriaFilterSchema"},"include_fields":{"items":{"type":"string"},"type":"array"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"},"search_after":{"description":"This parameter is used for infinite scroll pagination instead of deprecatedscroll API. It accepts a list of sort keys that will be used for getting a next page and it can be obtained from `_sort` key of the last object of the previous response","items":{},"type":"array"},"search_fields":{"items":{"type":"string"},"type":"array"},"sort":{"items":{"$ref":"#/components/schemas/CriteriaSortSchema"},"type":"array"}},"type":"object"},"SearchDocument":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"object"},"object_type":{"type":"string"},"title":{"type":"string"}},"required":["object_type","title"],"type":"object"},"SearchDocumentInputSchema":{"properties":{"fields":{"items":{"type":"object"},"type":"array"}},"required":["fields"],"type":"object"},"SearchDocumentSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"type":"object"},"object_type":{"type":"string"},"title":{"type":"string"}},"required":["object_type","title"],"type":"object"},"SearchDocumentsSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SearchDocumentSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SearchHistory":{"properties":{"criteria":{"type":"object"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"}},"required":["criteria","id"],"type":"object"},"SearchHistoryListSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SearchHistory"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"}},"type":"object"},"SearchHistorySchema":{"properties":{"criteria":{"type":"object"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"}},"required":["criteria","id"],"type":"object"},"SearchQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"scroll":{"type":"boolean"},"scroll_id":{"format":"uuid","type":"string"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"SearchSuggestResponseSchema":{"properties":{"value":{"type":"string"}},"type":"object"},"SearchSuggestSchema":{"properties":{"doc_types":{"items":{"enum":["assets","collections","segments","saved_searches","saved_search_groups"],"type":"string"},"type":"array"},"field_name":{"type":"string"},"metadata_view_id":{"format":"uuid","type":"string"},"query":{"type":"string"}},"required":["field_name","query"],"type":"object"},"SearchSuggestsResponseSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/SearchSuggestResponseSchema"},"readOnly":true,"type":"array"}},"type":"object"},"SearchViewFieldTypeSchema":{"properties":{"facetable":{"type":"boolean"},"label":{"type":"string"},"name":{"type":"string"},"origin_field_name":{"type":"string"},"sortable":{"type":"boolean"},"type":{"type":"string"},"width":{"$ref":"#/components/schemas/SearchViewFieldTypeWidth"}},"type":"object"},"SearchViewFieldTypeWidth":{"properties":{"auto_resize":{"type":"boolean"},"current":{"type":"integer"},"fixed":{"type":"integer"},"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object"},"SearchViewFieldTypeWidthSchema":{"properties":{"auto_resize":{"type":"boolean"},"current":{"type":"integer"},"fixed":{"type":"integer"},"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object"},"SearchViewSchema":{"properties":{"auto_resize_title_column":{"type":"boolean"},"date_created":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"view_fields":{"items":{"$ref":"#/components/schemas/SearchViewFieldTypeSchema"},"type":"array"}},"type":"object"},"SearchViewsIDSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["object_ids"],"type":"object"},"SearchViewsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/SearchViewSchema"},"readOnly":true,"type":"array"}},"type":"object"},"StorageContentInfo":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"file_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"storage_id":{"format":"uuid","readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"StorageContentInfoSchema":{"properties":{"assets_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"file_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"storage_id":{"format":"uuid","readOnly":true,"type":"string"},"total_duration_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"total_size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"}}},"info":{"title":"Iconik Search","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/discovery/default/":{"put":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryViewSettingsSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryViewSettingsSchema"}}},"description":"Returns updated default discovery view"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update default discovery view"}},"/v1/discovery/default/entities/":{"get":{"deprecated":true,"description":"\nRequired roles:\n - can_read_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitiesSchema"}}},"description":"Returns the configured discovery entities"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns the discovery entities that are used to build the discovery view."},"post":{"deprecated":true,"description":"<br/>This creates an entry for the discovery view to show collections and saved searches.<br/>Object Type should be one of COLLECTION, SAVED_SEARCH, ASSET, RECOMMENDATION or TRENDING<br/>Object ID is only needed in the case of COLLECTION, SAVED_SEARCH or ASSET<br/>metadata is for user defined extra data.<br/><br/>This creates an entry for the discovery view to show collections and saved searches.<br/>Object Type should be one of COLLECTION, SAVED_SEARCH, ASSET, RECOMMENDATION or TRENDING<br/>Object ID is only needed in the case of COLLECTION, SAVED_SEARCH or ASSET<br/>metadata is for user defined extra data.<br/>\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"Returns the configured discovery entities"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Adds a new discovery entity."}},"/v1/discovery/default/entities/admin/":{"get":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitiesSchema"}}},"description":"Returns the configured discovery entities"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns the discovery entities that are used to build the discovery view."}},"/v1/discovery/default/entities/{entity_id}/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - can_delete_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Search History does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a discovery entity by id"},"get":{"deprecated":true,"description":"\nRequired roles:\n - can_read_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"Returns Discovery entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns discovery entity"},"patch":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns new entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Search History does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by id"},"put":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"entity_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns new entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Search History does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by id"}},"/v1/discovery/entities/{object_type}/{object_id}/":{"patch":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns updated entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by object's type and id"},"put":{"deprecated":true,"description":"\nRequired roles:\n - can_write_discovery_entities\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveryEntitySchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns updated entity"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Discovery entity does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a discovery entity by object's type and id"}},"/v1/favorites/":{"delete":{"description":"\nRequired roles:\n - can_delete_favorites\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteFromFavoritesSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteFromFavoritesSchema"}}},"description":"Returns a list of saved search IDs that were removed from favorites"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Deletes multiple saved searches from a list of favorites"},"post":{"description":"\nRequired roles:\n - can_write_favorites\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAddToFavoritesSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAddToFavoritesSchema"}}},"description":"Returns a list of saved search IDs that were added to favorites"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Adds multiple saved searches to a list of favorites"}},"/v1/search/":{"post":{"description":"\nRequired roles:\n - can_search\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of documents for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"deprecated":true,"description":"If true passed then uses scroll pagination instead of default one (Deprecated, user search_after body parameter instead)","in":"query","name":"scroll","schema":{"type":"boolean"},"style":"form"},{"deprecated":true,"description":"In order to get next batch of results using scroll pagination the scroll_id is required","in":"query","name":"scroll_id","schema":{"type":"string"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to true if you also want the file download URLs generated","in":"query","name":"generate_signed_download_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed download urls","in":"query","name":"generate_signed_proxy_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to false if you don't want to save the search to the history","in":"query","name":"save_search_history","schema":{"default":true,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCriteriaSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDocumentsSchema"}}},"description":"Returns the result of search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search"}},"/v1/search/history/":{"get":{"description":"\nRequired roles:\n - can_read_search_history\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchHistoryListSchema"}}},"description":"Returns list of last 25 searches"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns the current search history"}},"/v1/search/history/{search_history_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_search_history\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_history_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Search History does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a search from history by its id"},"get":{"description":"\nRequired roles:\n - can_read_search_history\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_history_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to true if you want to generate signed download urls","in":"query","name":"generate_signed_download_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed download urls","in":"query","name":"generate_signed_proxy_url","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDocumentsSchema"}}},"description":"Returns results of search history"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns results of search history"}},"/v1/search/saved/":{"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"If true passed then uses scroll pagination instead of default one","in":"query","name":"scroll","schema":{"type":"boolean"},"style":"form"},{"description":"In order to get next batch of results using scroll pagination the scroll_id is required","in":"query","name":"scroll_id","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - name,asc;group_id,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Group ID","in":"query","name":"group_id","schema":{"type":"string"},"style":"form"},{"description":"Filter list of id:s (comma separated)","in":"query","name":"ids","schema":{"type":"string"},"style":"form"},{"description":"Search using query","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"If true, only returns favorite saved searches","in":"query","name":"favorites","schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchesSchema"}}},"description":"Returns results of saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns list of saved searches"},"post":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"Returns the result of search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search, save and return result of this search"}},"/v1/search/saved/copy/":{},"/v1/search/saved/group/":{"post":{"description":"\nRequired roles:\n - can_write_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns the result of creation of search group instance"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create and return saved search group data"}},"/v1/search/saved/group/{group_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a saved search group by it's id"},"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns saved search group info"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns saved search group data"},"patch":{"description":"\nRequired roles:\n - can_write_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns the result of updating group"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update and return saved search group data"},"put":{"description":"\nRequired roles:\n - can_write_saved_search_groups\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupSchema"}}},"description":"Returns the result of updating group"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update and return saved search group data"}},"/v1/search/saved/group/{group_id}/search/{search_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete saved search from search group"},"post":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Adds saved search to group"}},"/v1/search/saved/groups/":{"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"A comma separated list of IDs. for example - 3c2db7d8-1f39-46e3-8c77-992101e5e616,683a2c63-63a0-42b0-aed8-5b62dedba840","in":"query","name":"ids","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchGroupsSchema"}}},"description":"Returns a list of groups info"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Page number does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns paginated list of search groups"}},"/v1/search/saved/groups/{group_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"group_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Returns a job info"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Group does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Reindex a particular saved search group by id"}},"/v1/search/saved/{search_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a saved search by its id"},"get":{"description":"\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"Set to false if you only want the search definition","in":"query","name":"include_results","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed download urls","in":"query","name":"generate_signed_download_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to true if you want to generate signed download urls","in":"query","name":"generate_signed_proxy_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"If true passed then uses scroll pagination instead of default one","in":"query","name":"scroll","required":false,"schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"In order to get next batch of results using scroll pagination the scroll_id is required","in":"query","name":"scroll_id","required":false,"schema":{"default":null,"nullable":true,"type":"string"},"style":"form"},{"description":"A serialised list of values from _sort field of a last returned record (encoded). For example - [1729527028527, \"fd273ce8-8fc6-11ef-a762-cac08d6e9f12\"]","in":"query","name":"search_after","required":false,"schema":{"default":null,"nullable":true,"type":"object"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchResultsSchema"}}},"description":"Returns results of saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns results of saved search"},"patch":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDocumentsSchema"}}},"description":"Returns the result of search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search and save this search"},"put":{"description":"\nRequired roles:\n - can_write_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchDocumentsSchema"}}},"description":"Returns the result of search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Search and save this search"}},"/v1/search/saved/{search_id}/content/info/":{"get":{"description":"<br/>The returned information includes count of assets and collections,<br/>total size of all assets (in bytes) and total duration of video and audio<br/>assets (in milliseconds).<br/>The returned information includes count of assets and collections,<br/>total size of all assets (in bytes) and total duration of video and audio<br/>assets (in milliseconds).\nRequired roles:\n - can_read_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Compute total size only for files with the specified format name (default - ORIGINAL)","in":"query","name":"format_name","schema":{"default":"ORIGINAL","type":"string"},"style":"form"},{"description":"Group results by storage_id / storage_method","in":"query","name":"by_storage_id","schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchContentInfoSchema"}}},"description":"Returns results of saved search"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Saved search does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get aggregated information about saved search results"}},"/v1/search/saved/{search_id}/convert_to_collection/":{"post":{"description":"\nRequired roles:\n - can_read_saved_searches\n- can_create_collections\n- can_write_collections\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchConvertCollectionSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Schedules all the objects of the saved search to be added to a collection"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Access denied"},"404":{"description":"Saved search / Collection does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Converts the saved search to a collection"}},"/v1/search/saved/{search_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_saved_searches\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"search_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReindexSavedSearchSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns a job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"User does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Reindex a particular saved search by id"}},"/v1/search/suggest/":{"post":{"description":"\nRequired roles:\n - can_search\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuggestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuggestsResponseSchema"}}},"description":"Returns search suggestions for a particular query."},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns search suggestions for a particular query."}},"/v1/views/":{"delete":{"description":"\nRequired roles:\n - can_delete_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewsIDSchema"}}},"description":"body","required":false},"responses":{"200":{"description":"Delete was successful"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"All Views missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete Views for the system domain."},"get":{"description":"\nRequired roles:\n - can_read_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewsSchema"}}},"description":"Returns all Views"},"204":{"description":"No Views found"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all Views for the system domain."},"post":{"description":"\nRequired roles:\n - can_write_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"Returns a View"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Insert a View for the system domain."}},"/v1/views/{view_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The ID of the View to delete.","in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"View is missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a View for the system domain."},"get":{"description":"\nRequired roles:\n - can_read_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The ID of the view to retrieve.","in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"Returns a View"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"View is missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a View for the system domain."},"put":{"description":"\nRequired roles:\n - can_write_search_views\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The ID of the view to replace.","in":"path","name":"view_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchViewSchema"}}},"description":"Returns a View"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"View is missing or not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Replace a View for the system domain."}}},"servers":[{"url":"/API/search/"}]}