collections.json

{"apiVersion":"5.0","swaggerVersion":"1.2","basePath":"http://localhost:11090/otmmapi","resourcePath":"/{version: v(5)}/collections","apis":[{"path":"/{version: v(5)}/collections","operations":[{"method":"GET","summary":"Get list of collections for current user","notes":"Get list of collections for current user","type":"collection_resource","nickname":"getUserCollections","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"sort","description":"Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"after","description":"Retrieve collection starting at the position after the specified value. If neither the <b>after</b> or <b>before</b> parameters are specified this is equivlent to <b>after=0</b> and will retrieve items starting at the beginning of the collection","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"before","description":"Retrieve collection starting at the position before the specfied value and going backwards","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"limit","description":"Maximum number of items to retrieve.","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"collection_filters","description":"JSON representation of ContainerFilters object to perform filtering on collections.","required":false,"type":"collection_filters_param","paramType":"query","allowMultiple":false},{"name":"level_of_detail","description":"Controls whether field definitions are suppressed in the metadata fields returned.","defaultValue":"full","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["slim"," full"]}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"POST","summary":"Create a Collection","notes":"Create a collection for the given user. In the CollectionRepresentation, specify the name, permissions and rating enabled or not.<p><b>Note:</b></br>1. The Swagger model schema shows the schema for a complex type without the type name. Therefore you must set the type name in the JSON representation enclosing the model schema representation when passing complex type as a parameter.</br>2. You should specify a 'type' discriminator for sub-types with the fully qualified name of the sub-types. Refer to the model representation for the fully qualified names of the sub-types.","type":"collection_resource","nickname":"createCollection","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"collection_resource","description":"JSON representation of CollectionParam object","required":true,"type":"collection_param","paramType":"form","allowMultiple":false},{"name":"selection_context","description":"Selection context for adding assets to Collection. This parameter will be required for 'ASSET' Source Type.","required":false,"type":"selection_context_param","paramType":"form","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"PUT","summary":"Delete a Collection","notes":"This collection will be delete from the system and it will no longer be accessible. This operation cannot be undone. All shared recipients will be removed from the collection and they will no longer be able to access it.<p><b>Note:</b></br>1. The Swagger model schema shows the schema for a complex type without the type name. Therefore you must set the type name in the JSON representation enclosing the model schema representation when passing complex type as a parameter.</br>2. You should specify a 'type' discriminator for sub-types with the fully qualified name of the sub-types. Refer to the model representation for the fully qualified names of the sub-types.","type":"collection_operation_result_representation","nickname":"deleteCollection","consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"action","description":"Actions to be performed on the collection. An 'delete' action expects 'collection_list_selection_context'","defaultValue":"delete","required":true,"type":"string","paramType":"form","allowMultiple":false,"enum":["delete"]},{"name":"collection_list_selection_context","description":"Selection context for performing action on single/list of Collections.","required":true,"type":"collection_list_selection_context_param","paramType":"form","allowMultiple":false}],"responseMessages":[{"code":204,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":403,"message":"Invalid request to delete collection with the specified id"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/assets","operations":[{"method":"GET","summary":"Retrieve assets based on the provided selection context.","notes":"Retrieve assets based on the provided selection context. The request needs the pagination parameters to be passed. The asset collection will also include summary about the collection. To load only collection summary pass limit as 0.<p>The fields populated in the returned object is based on the <b>load_type</b> parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the <b>load_type</b> parameter is set to <b>custom</b> then you must also provide a <b>data_load_request</b> parameter containing the JSON representation of a DataLoadRequest object. If the <b>load_type</b> parameter is set to <b>metadata</b> or <b>inherited_metadata</b> then you may optionally set the <b>metadata_to_return</b> and/or <b>preference_id</b> parameters to restrict what metadata fields are retrieved. The <b>preference_id</b> parameter is also honored when <b>load_type</b> is <b>custom</b> </p><p>For <b>load_type</b> options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter <b>level_of_detail</b>. The allowed values are <b>slim</b>, or <b>full</b>(default)</p><p>While using selection context to filter the assets based on permissions, pass permissions_filter paramater in selection context. The valid permission filters are {ASSETVIEW_PERM,SUMMARYVIEW_PERM,PREVIEWVIEW_PERM,EXPORT_PERM,SUBSCRIBE_PERM,METAEDIT_PERM,CONTENTEDIT_PERM,MEMBERSHIPEDIT_PERM, DELETEASSET_PERM,EDITPARENTS_PERM,CUSTOM01_PERM,CUSTOM02_PERM,CUSTOM03_PERM,CUSTOM04_PERM}<p><b>Note:</b></br>1. The Swagger model schema shows the schema for a complex type without the type name. Therefore you must set the type name in the JSON representation enclosing the model schema representation when passing complex type as a parameter.</br>2. You should specify a 'type' discriminator for sub-types with the fully qualified name of the sub-types. Refer to the model representation for the fully qualified names of the sub-types.","type":"assets_resource","nickname":"getAssets1","parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"load_type","description":"Data load type","defaultValue":"system","required":true,"type":"string","paramType":"query","allowMultiple":false,"enum":["full","system","metadata","inherited_metadata","custom"]},{"name":"metadata_to_return","description":"Comma separated list of metadata field ids. This parameter is ignored unless the <b>load_type</b> parameter is set to <b>metadata</b> or <b>inherited_metadata</b>","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"preference_id","description":"Preference Id","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"filter_fields_by_model","description":"Filter metadata fields relevant to asset model. This parameter is honored only when <b>metadata_to_return</b> and/or  <b>preference_id</b> are set in the request.","defaultValue":"true","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["true","false"]},{"name":"load_multilingual_values","description":"Load multilingual values. This parameter is honored only when the <b>load_type</b> parameter is set to <b>metadata</b> or <b>full</b>. For the <b>custom</b> load type multilingual values can be requested using the <b>load_multilingual_field_values</b> property of the <b>data_load_request</b> parameter.","defaultValue":"false","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["true","false"]},{"name":"data_load_request","description":"JSON representation of DataLoadRequest object. This parameter is ignored unless the <b>load_type</b> parameter is set to <b>custom</b>","required":false,"type":"data_load_request","paramType":"query","allowMultiple":false},{"name":"level_of_detail","description":"Controls whether field definitions are suppressed in the metadata fields returned.","defaultValue":"full","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["slim"," full"]},{"name":"selection_context","description":"The selection context for the assets.","required":true,"type":"selection_context_param","paramType":"query","allowMultiple":false},{"name":"asset_id_container_path_map","description":"Map of asset id and container path to expand. The given path will be expanded to have children of path elements.","required":false,"type":"asset_id_path_map_request_param","paramType":"query","allowMultiple":false},{"name":"after","description":"Retrieve collection starting at the position after the specified value. If neither the <b>after</b> or <b>before</b> parameters are specified this is equivlent to <b>after=0</b> and will retrieve items starting at the beginning of the collection","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"before","description":"Retrieve collection starting at the position before the specfied value and going backwards","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"limit","description":"Maximum number of items to retrieve.","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"group_by","description":"Attribute to group and count the assets in a asset collection","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["content_type","metadata_model","data_type"]}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"PUT","summary":"Add Assets to the selected collections","notes":"Select assets and add them into to a existing a collection. If selected assets into a collection that has a saved search of assets, the collection will no longer be dynamic and will be come a static list of assets.<p><b>Note:</b></br>1. The Swagger model schema shows the schema for a complex type without the type name. Therefore you must set the type name in the JSON representation enclosing the model schema representation when passing complex type as a parameter.</br>2. You should specify a 'type' discriminator for sub-types with the fully qualified name of the sub-types. Refer to the model representation for the fully qualified names of the sub-types.","type":"collection_operation_result_representation","nickname":"addOrRemoveAssetsToCollection","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"collection_list","description":"List of Collection Id's","required":true,"type":"array","items":{"type":"string"},"paramType":"form","allowMultiple":false},{"name":"selection_context","description":"Selection context for adding assets to Collection. This parameter will be required for 'ASSET' Source Type.","required":false,"type":"selection_context_param","paramType":"form","allowMultiple":false},{"name":"operation","description":"Operation to be performed on the collection assets. An 'add/remove' operation expects 'selection_context'","required":true,"type":"string","paramType":"form","allowMultiple":false,"enum":["add","remove"]}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/{id}","operations":[{"method":"GET","summary":"Get collection by collection id","notes":"Get collection by collection id","type":"collection_resource","nickname":"getUserCollectionById","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"level_of_detail","description":"Controls whether field definitions are suppressed in the metadata fields returned.","defaultValue":"slim","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["slim"," full"]}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"PUT","summary":"Update a collection","notes":"Update properties of a collection.<br>CollectionSource can't be modified using this endpoint.</br><p><b>Note:</b></br>1. The Swagger model schema shows the schema for a complex type without the type name. Therefore you must set the type name in the JSON representation enclosing the model schema representation when passing complex type as a parameter.</br>2. You should specify a 'type' discriminator for sub-types with the fully qualified name of the sub-types. Refer to the model representation for the fully qualified names of the sub-types.","type":"collection_resource","nickname":"updateCollection","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"body","description":"JSON representation of CollectionParam object","required":true,"type":"collection_param","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":400,"message":"A metadata field id / lookup domain id is invalid"},{"code":403,"message":"Permission denied to update given collection"},{"code":404,"message":"Collection not found with the specified id"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"PATCH","summary":"Update a collection","notes":"Update properties of a collection selectively.<br>name, description, collectionType, ratingEnabled, collectionShareAccessInfo can be modified using this endpoint.</br><p><b>Note:</b></br>1. The Swagger model schema shows the schema for a complex type without the type name. Therefore you must set the type name in the JSON representation enclosing the model schema representation when passing complex type as a parameter.</br>2. You should specify a 'type' discriminator for sub-types with the fully qualified name of the sub-types. Refer to the model representation for the fully qualified names of the sub-types.","type":"collection_resource","nickname":"updateCollectionProperties","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"body","description":"JSON representation of CollectionParam object","required":true,"type":"collection_param","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":400,"message":"A metadata field id / lookup domain id is invalid"},{"code":403,"message":"Permission denied to update given collection"},{"code":404,"message":"Collection not found with the specified id"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"DELETE","summary":"Delete a Collection","notes":"This collection will be delete from the system and it will no longer be accessible. This operation cannot be undone. All shared recipients will be removed from the collection and they will no longer be able to access it.","type":"void","nickname":"deleteCollection","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":204,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":403,"message":"Invalid request to delete collection with the specified id"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/{id}/subscriptions","operations":[{"method":"POST","summary":"subscribe a collection","notes":"subscribe a collection","type":"collection_operation_result_representation","nickname":"subscribeToCollection","parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"DELETE","summary":"un-subscribe a collection","notes":"un-subscribe a collection","type":"collection_operation_result_representation","nickname":"unsubscribeToCollection","parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/subscriptions","operations":[{"method":"POST","summary":"subscribe collections","notes":"subscribe collectionsSelection context for performing action on single/list of Collections.","type":"collection_operation_result_representation","nickname":"subscribeToCollections","consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"collection_list_selection_context","description":"Selection context for performing action on single/list of Collections.","required":true,"type":"collection_list_selection_context_param","paramType":"form","allowMultiple":false},{"name":"after","description":"Retrieve collection starting at the position after the specified value. If neither the <b>after</b> or <b>before</b> parameters are specified this is equivlent to <b>after=0</b> and will retrieve items starting at the beginning of the collection","required":false,"type":"string","paramType":"form","allowMultiple":false},{"name":"limit","description":"Maximum number of items to retrieve.","required":false,"type":"string","paramType":"form","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"DELETE","summary":"un-subscribe of assets","notes":"un-subscribe of assets<p>While using selection context to filter the assets based on permissions, pass permissions_filter paramater in selection context. The valid permission filters are {ASSETVIEW_PERM,SUMMARYVIEW_PERM,PREVIEWVIEW_PERM,EXPORT_PERM,SUBSCRIBE_PERM,METAEDIT_PERM,CONTENTEDIT_PERM,MEMBERSHIPEDIT_PERM, DELETEASSET_PERM,EDITPARENTS_PERM,CUSTOM01_PERM,CUSTOM02_PERM,CUSTOM03_PERM,CUSTOM04_PERM}","type":"collection_operation_result_representation","nickname":"unsubscribeToCollections","parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"selection_context","description":"The selection context for the assets.","required":true,"type":"collection_list_selection_context_param","paramType":"query","allowMultiple":false},{"name":"after","description":"Retrieve collection starting at the position after the specified value. If neither the <b>after</b> or <b>before</b> parameters are specified this is equivlent to <b>after=0</b> and will retrieve items starting at the beginning of the collection","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"limit","description":"Maximum number of items to retrieve.","required":false,"type":"string","paramType":"query","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/{id}/promotions","operations":[{"method":"POST","summary":"Promote or demote the collection.","notes":"Promote or demote the collection.All the selected user groups will be considered as promoted user groups. All the remaining user groups not selected will be consided as demoted.","type":"void","nickname":"promoteCollection","consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"user_group_ids","description":"List of user groups selected for promotion.","required":true,"type":"string","paramType":"form","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"GET","summary":"Retrieve promoted user groups in a collection.","notes":"Retrieve promoted user groups in a collection.","type":"user_groups_resource","nickname":"getUserGroupsPromotedforCollection","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"}]}]},{"path":"/{version: v(5)}/collections/{id}/assets","operations":[{"method":"GET","summary":"Retrieve all assets of a Collection","notes":"Retrieve all the assets for the specified Collection.","type":"assets_resource","nickname":"getCollectionAssets","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"sort","description":"Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"load_type","description":"Data load type","defaultValue":"system","required":true,"type":"string","paramType":"query","allowMultiple":false,"enum":["full","system","metadata","inherited_metadata","custom"]},{"name":"metadata_to_return","description":"Comma separated list of metadata field ids. This parameter is ignored unless the <b>load_type</b> parameter is set to <b>metadata</b> or <b>inherited_metadata</b>","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"preference_id","description":"Preference Id","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"filter_fields_by_model","description":"Filter metadata fields relevant to asset model. This parameter is honored only when <b>metadata_to_return</b> and/or  <b>preference_id</b> are set in the request.","defaultValue":"true","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["true","false"]},{"name":"load_multilingual_values","description":"Load multilingual values. This parameter is honored only when the <b>load_type</b> parameter is set to <b>metadata</b> or <b>full</b>. For the <b>custom</b> load type multilingual values can be requested using the <b>load_multilingual_field_values</b> property of the <b>data_load_request</b> parameter.","defaultValue":"false","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["true","false"]},{"name":"data_load_request","description":"JSON representation of DataLoadRequest object. This parameter is ignored unless the <b>load_type</b> parameter is set to <b>custom</b>","required":false,"type":"data_load_request","paramType":"query","allowMultiple":false},{"name":"after","description":"Retrieve collection starting at the position after the specified value. If neither the <b>after</b> or <b>before</b> parameters are specified this is equivlent to <b>after=0</b> and will retrieve items starting at the beginning of the collection","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"before","description":"Retrieve collection starting at the position before the specfied value and going backwards","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"limit","description":"Maximum number of items to retrieve.","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"level_of_detail","description":"Controls whether field definitions are suppressed in the metadata fields returned.","defaultValue":"full","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["slim"," full"]},{"name":"group_by","description":"Attribute to group and count the assets in a asset collection","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["content_type","metadata_model"]},{"name":"asset_filter_request","description":"JSON representation of AssetFilterRequest objcet to perform filtering on assets","required":false,"type":"asset_filter_request_param","paramType":"query","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":404,"message":"Collection not found with the specified id"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/{id}/rating","operations":[{"method":"POST","summary":"Rate the collection.","notes":"Rate the shared collection as the logged in user.","type":"void","nickname":"rateCollection","consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"rating","description":"Rating to be added for an collection.","required":true,"type":"integer","format":"int32","paramType":"form","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/me/promotions","operations":[{"method":"GET","summary":"Get list of collections promoted for current user","notes":"Get list of collections promoted for current user","type":"collection_resource","nickname":"getCollectionPromotionsofLoggedinUser","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"sort","description":"Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"after","description":"Retrieve collection starting at the position after the specified value. If neither the <b>after</b> or <b>before</b> parameters are specified this is equivlent to <b>after=0</b> and will retrieve items starting at the beginning of the collection","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"before","description":"Retrieve collection starting at the position before the specfied value and going backwards","required":false,"type":"string","paramType":"query","allowMultiple":false},{"name":"limit","description":"Maximum number of items to retrieve.","required":false,"type":"string","paramType":"query","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"}]}]},{"path":"/{version: v(5)}/collections/sortoptions","operations":[{"method":"GET","summary":"Retrieve all colelctions sort options","notes":"Retrieves all sort options to sorting the collections of the logged in user.","type":"collection_sort_options_resource","nickname":"getSortOptions","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"}]}]},{"path":"/{version: v(5)}/collections/sharedFilterTypes","operations":[{"method":"GET","summary":"Retrieve list of all collection filter types.","notes":"Retrieve list of all collection filter types.","type":"asset_sort_options_resource","nickname":"getCollectionSharedFilterTypes","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"}]}]},{"path":"/{version: v(5)}/collections/assets/sortoptions","operations":[{"method":"GET","summary":"Retrieve all recent assets sort options","notes":"Retrieves all sort options to sort recently accessed assets of the logged in user.","type":"asset_sort_options_resource","nickname":"getCollectionAssetsSortOptions","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"}]}]},{"path":"/{version: v(5)}/collections/filterTypes","operations":[{"method":"GET","summary":"Retrieve list of all collection filter types.","notes":"Retrieve list of all collection filter types.","type":"asset_sort_options_resource","nickname":"getCollectionFilterTypes","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"}]}]},{"path":"/{version: v(5)}/collections/accesstypes","operations":[{"method":"GET","summary":"Get all list of access types","notes":"Get all list of access types to share the collection","type":"access_type_resource","nickname":"getAccessPermissionsList","produces":["application/json"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]},{"path":"/{version: v(5)}/collections/{id}/thumbnail","operations":[{"method":"GET","summary":"Retrieve collection thumbnail","notes":"Retrieve the thumbnail for the specified collection.","type":"java.io.InputStream","nickname":"retrieveCollectionThumbnail","parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"disposition","description":"The disposition type","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["attachment"]},{"name":"enable_caching","description":"Is caching enabled for this request","defaultValue":"true","required":false,"type":"string","paramType":"query","allowMultiple":false,"enum":["true","false"]},{"name":"user-agent","description":"User-Agent HTTP header","required":false,"type":"string","paramType":"header","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":404,"message":"Rendition not found with the specified id"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"POST","summary":"Change the collection thumbnail","notes":"Change the collection thumbnail to the thumbnail of the specified asset id. Asset should be part of the collection","type":"collection_resource","nickname":"setCollectionThumbnail","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"asset_id","description":"The id of the asset to be used as the collection thumbnail, Asset should be part of the collection","required":true,"type":"string","paramType":"form","allowMultiple":false}],"responseMessages":[{"code":204,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]},{"method":"DELETE","summary":"Remove the collection thumbnail","notes":"Remove the collection thumbnail to the thumbnail of the specified asset id.","type":"void","nickname":"removeCollectionThumbnail","parameters":[{"name":"version","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"id","description":"Collection Id","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":"The request has been completed successfully"},{"code":400,"message":"A required parameter is not specified or has null or invalid value"},{"code":401,"message":"Unauthorized access to the resource"},{"code":404,"message":"Rendition not found with the specified id"},{"code":500,"message":"An internal server error occurred, refer to the response for more information"}]}]}],"models":{"ReviewJobAssetApprovalInfo":{"id":"ReviewJobAssetApprovalInfo","properties":{"approval_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"approval_state":{"$ref":"ReviewJobAssetApprovalState"},"approval_user":{"type":"string"},"asset_id":{"type":"string"},"comment":{"type":"string"},"final_approval":{"type":"boolean"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"review_job_id":{"type":"string"},"task_id":{"type":"string"}}},"collection_operation_result_representation":{"id":"collection_operation_result_representation","properties":{"collections_operation_result":{"$ref":"ListOperationResult"}}},"LightContainer":{"id":"LightContainer","properties":{"children":{"type":"array","items":{"$ref":"LightContainer"}},"container_state":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"original_uoi_id":{"type":"string"},"sequence_number":{"type":"integer","format":"int64"}}},"DateInterval":{"id":"DateInterval","properties":{"custom_range":{"type":"boolean"},"fixed_end_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"fixed_start_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"interval_label":{"type":"string"},"relative_end_date":{"$ref":"RelativeDateIntervalValue"},"relative_start_date":{"$ref":"RelativeDateIntervalValue"}}},"SearchSortField":{"id":"SearchSortField","properties":{"id":{"type":"integer","format":"int64"},"metadata_field_id":{"type":"string"},"sort_order":{"type":"string"}}},"MetadataElement":{"id":"MetadataElement","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"subTypes":["MetadataField","MetadataTableField"]},"SelectionContext":{"id":"SelectionContext","properties":{"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"}},"subTypes":["SearchSelectionContext","FolderSelectionContext","AssetIdsSelectionContext","AssetCollectionSelectionContext","RecentAccessSelectionContext","ReviewJobSelectionContext","ActivitySelectionContext","CollectionSelectionContext","CollectionListSelectionContext"]},"LinkCollection":{"id":"LinkCollection","properties":{"links":{"type":"array","items":{"$ref":"Link"}},"source_id":{"type":"string"}}},"CollectionAccessControlDescriptor":{"id":"CollectionAccessControlDescriptor","properties":{"permissions_map":{"$ref":"Map[string,CollectionAccessPermission]"}}},"SearchSelectionContext":{"id":"SearchSelectionContext","properties":{"apply_search_filter_user_prefs":{"type":"boolean"},"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"collection_filter_id":{"type":"string"},"default_operator":{"type":"string"},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"facet_config_id":{"type":"integer","format":"int64"},"facet_restriction_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">FacetFieldRestriction is base type for the below sub types.</br><b>Sub Types: </b></br>FacetSimpleFieldRestriction - com.artesia.search.facet.FacetSimpleFieldRestriction</br>FacetNumericRangeFieldRestriction - com.artesia.search.facet.FacetNumericRangeFieldRestriction</br>FacetNumericIntervalFieldRestriction - com.artesia.search.facet.FacetNumericIntervalFieldRestriction</br>FacetDateRangeFieldRestriction - com.artesia.search.facet.FacetDateRangeFieldRestriction</br>FacetDateIntervalFieldRestriction - com.artesia.search.facet.FacetDateIntervalFieldRestriction</br>FacetCascadingFieldRestriction - com.artesia.search.facet.FacetCascadingFieldRestriction</font>","items":{"$ref":"FacetFieldRestriction"}},"fixed_condition_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">SearchCondition is base type for the below sub types.</br><b>Sub Types: </b></br>SearchMetadataCondition - com.artesia.search.SearchMetadataCondition</br>SearchCustomCondition - com.artesia.search.SearchCustomCondition</br>SearchFulltextCondition - com.artesia.search.SearchFulltextCondition</br>SearchScalarCondition - com.artesia.search.SearchScalarCondition</br>SearchTabularCondition - com.artesia.search.SearchTabularCondition</br>SearchTabularFieldCondition - com.artesia.search.SearchTabularFieldCondition</font>","items":{"$ref":"SearchCondition"}},"folder_filter_id":{"type":"string"},"folder_filter_type":{"type":"string"},"ignore_collection_filter":{"type":"boolean"},"ignore_folder_filter":{"type":"boolean"},"ignore_keyword_query":{"type":"boolean"},"ignore_search_condition_list":{"type":"boolean"},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"keyword_filter_list":{"type":"array","items":{"type":"string"}},"keyword_filter_scope_id":{"type":"integer","format":"int32"},"keyword_query":{"type":"string"},"keyword_scope_id":{"type":"integer","format":"int32"},"merge_filters":{"type":"boolean"},"multilingual_language_code":{"type":"string"},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"},"saved_search_id":{"type":"integer","format":"int64"},"search_condition_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">SearchCondition is base type for the below sub types.</br><b>Sub Types: </b></br>SearchMetadataCondition - com.artesia.search.SearchMetadataCondition</br>SearchCustomCondition - com.artesia.search.SearchCustomCondition</br>SearchFulltextCondition - com.artesia.search.SearchFulltextCondition</br>SearchScalarCondition - com.artesia.search.SearchScalarCondition</br>SearchTabularCondition - com.artesia.search.SearchTabularCondition</br>SearchTabularFieldCondition - com.artesia.search.SearchTabularFieldCondition</font>","items":{"$ref":"SearchCondition"}},"search_config_id":{"type":"integer","format":"int64"},"search_plugin_id":{"type":"string"},"sort_criteria":{"type":"array","items":{"$ref":"SearchSortField"}}}},"HierarchicalFacetValuePath":{"id":"HierarchicalFacetValuePath","properties":{"component_list":{"type":"array","items":{"type":"string"}}}},"CollectionError":{"id":"CollectionError","properties":{"asset_id":{"type":"string"},"collection_id":{"type":"string"},"reasons":{"$ref":"List[ERROR]","enum":["DELETED_ASSET","ASSET_NOT_FOUND","ASSET_ALREADY_EXISTS","CONTAINER_NOT_ALLOWED","USER_NOT_ALLOWED","PROPERTY_TEMPLATE_NOT_ALLOWED","COLLECTION_NOT_FOUND","OPERATION_NOT_ALLOWED","DATABASE_ERROR","ERROR_WHILE_COLLECTION_SUBSCRIPTION","ERROR_WHILE_COLLECTION_ASSET_SUBSCRIPTION","COLLECTION_ALREADY_SUBSCRIBED","ERROR_WHILE_COLLECTION_UNSUBSCRIPTION","ERROR_WHILE_COLLECTION_ASSET_UNSUBSCRIPTION","ERROR_WHILE_COLLECTION_LINK_REMOVAL","ERROR_WHILE_COLLECTION_ASSET_LINK_REMOVAL","COLLECTION_NOT_SUBSCRIBED"]}}},"HashMap":{"id":"HashMap","properties":{"empty":{"type":"boolean"},"entry_set":{"$ref":"Set[java.util.Map$Entry<K, V>]"},"key_set":{"type":"array","uniqueItems":true,"items":{"$ref":"K"}},"size":{"type":"integer","format":"int32"},"values":{"$ref":"java.util.Collection<V>"}}},"NumericInterval":{"id":"NumericInterval","properties":{"custom_range":{"type":"boolean"},"end_inclusive":{"type":"boolean"},"end_value":{"type":"integer","format":"int64"},"interval_label":{"type":"string"},"start_inclusive":{"type":"boolean"},"start_value":{"type":"integer","format":"int64"}}},"RenditionContentInfo":{"id":"RenditionContentInfo","properties":{"keywords":{"type":"string"},"mac_resource_content":{"$ref":"ContentInfo"},"pdf_preview_content":{"$ref":"ContentInfo"},"preview3_d_content":{"$ref":"ContentInfo"},"preview_content":{"$ref":"ContentInfo"},"synopsis":{"type":"string"},"thumbnail_content":{"$ref":"ContentInfo"},"video_rollover_content":{"$ref":"ContentInfo"}}},"TreeDescriptor":{"id":"TreeDescriptor","properties":{"detached":{"type":"boolean"},"tree_id":{"type":"string"}}},"assets_resource":{"id":"assets_resource","properties":{"asset_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">Asset is base type for the below sub types.</br><b>Sub Types: </b></br>Container - com.artesia.container.Container</font>","items":{"$ref":"Asset"}},"collection_summary":{"$ref":"collection_summary"}}},"ReviewJobSelectionContext":{"id":"ReviewJobSelectionContext","properties":{"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"content_filter":{"$ref":"ReviewJobAssetContentFilter","enum":["NO_CONTENT","CONTENT_ONLY","ALL"]},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"},"review_job_id":{"type":"string"},"sort_ascending":{"type":"boolean"},"sort_field":{"type":"string"},"status_filter":{"$ref":"ReviewJobAssetStatusFilter","enum":["NONE","APPROVED","REQUESTED_CHANGES","ALL"]},"task_id":{"type":"string"}}},"ReviewAssetApprovalInfo":{"id":"ReviewAssetApprovalInfo","properties":{"approval_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"approval_user":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"SearchMetadataCondition":{"id":"SearchMetadataCondition","properties":{"display_value":{"type":"string"},"filter_condition":{"type":"boolean"},"left_paren":{"type":"string"},"metadata_field_id":{"type":"string"},"relational_operator":{"type":"string"},"relational_operator_id":{"type":"string"},"right_paren":{"type":"string"},"value":{"type":"string"}}},"MetadataValue":{"id":"MetadataValue","properties":{"cascading_domain_value":{"type":"boolean"},"domain_value":{"type":"boolean"},"is_locked":{"type":"boolean"},"locked":{"type":"boolean"},"multilingual_values":{"type":"array","items":{"$ref":"MultilingualMetadataValue"}},"value":{"$ref":"Object"}},"subTypes":["DomainValue","CascadingDomainValue"]},"CollectionAccessPermission":{"id":"CollectionAccessPermission","properties":{"granted":{"type":"boolean"},"permission_name":{"type":"string"}}},"collection_filters_param":{"id":"collection_filters_param","properties":{"filters":{"$ref":"CollectionFilters"}}},"CreativeReviewInfo":{"id":"CreativeReviewInfo","properties":{"review_id":{"type":"string"},"user_review_status":{"$ref":"Map[int,ReviewAssetApprovalInfo]"}}},"Collection":{"id":"Collection","properties":{"access_control_descriptor":{"$ref":"CollectionAccessControlDescriptor"},"average_rating":{"type":"number","format":"float"},"collection_share_access_info":{"type":"array","items":{"$ref":"CollectionShareAccessInfo"}},"collection_source":{"$ref":"CollectionSource","enum":["ASSET","SEARCH","NONE"]},"collection_type":{"$ref":"CollectionType","enum":["PRIVATE","PUBLIC","SHARED"]},"created_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"owner_name":{"type":"string"},"owner_user_id":{"type":"string"},"promoted":{"type":"boolean"},"rating_count":{"type":"integer","format":"int32"},"rating_enabled":{"type":"boolean"},"subscribed":{"type":"boolean"},"thumbnail_info":{"$ref":"ContentInfo"},"thumbnail_original_id":{"type":"string"},"update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"update_user_id":{"type":"string"},"user_rating":{"type":"integer","format":"int32"}}},"NumericRange":{"id":"NumericRange","properties":{"custom_range":{"type":"boolean"},"end_value":{"type":"integer","format":"int64"},"start_value":{"type":"integer","format":"int64"}}},"CollectionAssetsSortCriteria":{"id":"CollectionAssetsSortCriteria","properties":{"sort_order":{"$ref":"CollectionSortOrder","enum":["ASCENDING","DESCENDING"]},"sort_parameter":{"$ref":"CollectionAssetsSortField","enum":["NAME","CREATION_DATE","CONTENT_TYPE"]}}},"ReviewJobAssetApprovalSummary":{"id":"ReviewJobAssetApprovalSummary","properties":{"comment_count":{"type":"integer","format":"int32"},"review_approval_version_map":{"$ref":"Map[int,ReviewJobAssetApprovalInfo]"},"review_job_id":{"type":"string"}}},"CollectionFilters":{"id":"CollectionFilters","properties":{"filter_by_name":{"type":"string"},"filters_type":{"$ref":"List[CollectionFiltersType]","enum":["PRIVATE","SHARED_BY_CURRENT_USER","SHARED_WITH_CURRENT_USER"]},"shared_by_user_ids":{"type":"array","items":{"type":"string"}},"shared_filters_type":{"$ref":"List[CollectionSharedFiltersType]","enum":["PUBLIC_WEBSITE","PROMOTED"]},"shared_with_user_group_ids":{"type":"array","items":{"type":"integer","format":"int64"}},"shared_with_user_ids":{"type":"array","items":{"type":"string"}}}},"FacetDateRangeFieldRestriction":{"id":"FacetDateRangeFieldRestriction","properties":{"facet_generation_behavior":{"$ref":"FacetGenerationBehavior","enum":["DROP","INCLUDE","EXCLUDE","DRILLDOWN"]},"field_id":{"type":"string"},"value_list":{"type":"array","items":{"$ref":"DateRange"}}}},"ContentData":{"id":"ContentData","required":["data_source"],"properties":{"content_bytes":{"type":"array","items":{"type":"string","format":"byte"}},"data_source":{"$ref":"ContentDataSource","enum":["NO_CONTENT","BYTE_ARRAY","FILE","URL","INPUTSTREAM"]},"file":{"type":"string","description":"File"},"relative_url":{"type":"string"},"temp_file":{"type":"boolean"},"url":{"type":"string","description":"URL"}}},"SearchFulltextCondition":{"id":"SearchFulltextCondition","properties":{"filter_condition":{"type":"boolean"},"keyword":{"type":"string"},"left_paren":{"type":"string"},"original_keyword":{"type":"string"},"relational_operator":{"type":"string"},"right_paren":{"type":"string"},"scope_id":{"type":"string"}}},"ContentInfo":{"id":"ContentInfo","properties":{"content_bytes":{"type":"array","items":{"type":"string","format":"byte"}},"content_checksum":{"type":"string"},"content_data":{"$ref":"ContentData"},"content_file_name":{"type":"string"},"content_kind":{"type":"string"},"content_manager_id":{"type":"string"},"content_path":{"type":"string"},"content_size":{"type":"integer","format":"int64"},"encoding":{"type":"string"},"export_location":{"type":"string"},"file":{"type":"string","description":"File"},"height":{"type":"integer","format":"int32"},"id":{"type":"string"},"mime_type":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"storage_attributes_map":{"$ref":"Map[string,string]"},"text_content":{"type":"string"},"unit_of_size":{"type":"string"},"url":{"type":"string"},"width":{"type":"integer","format":"int32"}}},"collection_summary":{"id":"collection_summary","properties":{"actual_count_of_items":{"type":"integer","format":"int32"},"after_index":{"type":"integer","format":"int32"},"before_index":{"type":"integer","format":"int32"},"group_to_count_map":{"$ref":"Map[string,long]"},"limit":{"type":"integer","format":"int32"},"total_number_of_items":{"type":"integer","format":"int64"}}},"asset_id_path_map_request_param":{"id":"asset_id_path_map_request_param","properties":{"asset_ids_to_path_list_map":{"type":"array","items":{"$ref":"AssetIdPathList"}}}},"LinkIdentifier":{"id":"LinkIdentifier","properties":{"source_id":{"type":"string"},"destination_id":{"type":"string"},"link_type_id":{"type":"string"}}},"ContainerChildCounts":{"id":"ContainerChildCounts","properties":{"asset_count":{"type":"integer","format":"int64"},"container_count":{"type":"integer","format":"int64"},"total_child_count":{"type":"integer","format":"int64"}}},"collection_sort_options_resource":{"id":"collection_sort_options_resource","properties":{"sort_option_list":{"type":"array","items":{"$ref":"sort_option"}}}},"asset_sort_options_resource":{"id":"asset_sort_options_resource","properties":{"sort_option_list":{"type":"array","items":{"$ref":"sort_option"}}}},"FolderSelectionContext":{"id":"FolderSelectionContext","properties":{"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"folder_id":{"type":"string"},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"},"sort_criteria":{"type":"array","items":{"$ref":"ContainerChildSortCriteria"}}}},"SearchCustomCondition":{"id":"SearchCustomCondition","properties":{"custom_condition_map":{"$ref":"Map[string,string]"},"filter_condition":{"type":"boolean"},"left_paren":{"type":"string"},"relational_operator":{"type":"string"},"right_paren":{"type":"string"}}},"AccessType":{"id":"AccessType","properties":{"curate_permission":{"type":"boolean"},"description":{"type":"string"},"download_permission":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"manage_permission":{"type":"boolean"},"name":{"type":"string"},"view_permission":{"type":"boolean"}}},"MetadataField":{"id":"MetadataField","required":["id","name"],"properties":{"analytics":{"type":"boolean"},"cascading_group_id":{"type":"string"},"column_name":{"type":"string"},"data_length":{"type":"integer","format":"int32"},"data_type":{"type":"string"},"default_value":{"type":"string"},"description":{"type":"string"},"displayable":{"type":"boolean"},"domain_id":{"type":"string"},"domained":{"type":"boolean"},"edit_type":{"type":"string"},"editable":{"type":"boolean"},"enabled":{"type":"boolean"},"external_datasource_id":{"type":"string"},"facetable":{"type":"boolean"},"id":{"type":"string"},"instructions":{"type":"string"},"multilingual":{"type":"boolean"},"multilingual_table_name":{"type":"string"},"name":{"type":"string"},"options":{"type":"string"},"prompt":{"type":"string"},"required":{"type":"boolean"},"restriction_id":{"type":"integer","format":"int64"},"scale":{"type":"integer","format":"int32"},"searchable":{"type":"boolean"},"searchable_scope_id":{"type":"string"},"sortable":{"type":"boolean"},"table_name":{"type":"string"},"trigger_field":{"type":"boolean"},"validation_rule":{"type":"string"},"value":{"$ref":"MetadataValue","description":"</br>The metadata value object should contain the type of object it is holding in its value field</br>. Below examples show JSON representation of the value field for various data types</br>\"value\": {<b>\"type\": \"dateTime\"</b>,\"value\": \"2015-10-13T11:25:40.215+05:30\"}</br>\"value\": {<b>\"type\": \"string\"</b>,\"value\": \"Media Management\"}</br>\"value\": {<b>\"type\": \"int\"</b>,\"value\": \"2014\"}</br>\"value\": {<b>\"type\": \"decimal\"</b>,\"value\": \"7.3\"}</br>"}},"subTypes":["MetadataTableField"]},"MultilingualMetadataValue":{"id":"MultilingualMetadataValue","properties":{"locale_id":{"type":"string"},"value":{"type":"string"}}},"SearchScalarCondition":{"id":"SearchScalarCondition","properties":{"display_value":{"type":"string"},"filter_condition":{"type":"boolean"},"left_paren":{"type":"string"},"metadata_field_id":{"type":"string"},"relational_operator":{"type":"string"},"relational_operator_id":{"type":"string"},"right_paren":{"type":"string"},"value":{"type":"string"}}},"access_type_resource":{"id":"access_type_resource","properties":{"access_type_list":{"type":"array","items":{"$ref":"AccessType"}}}},"UserGroup":{"id":"UserGroup","properties":{"create_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"created_by":{"type":"string"},"description":{"type":"string"},"has_permission_on_sec_policy":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"last_updated_by":{"type":"string"},"name":{"type":"string"},"otds_group_mapping":{"type":"string"},"ownership_type":{"type":"string"},"parent":{"type":"boolean"},"parent_id":{"type":"integer","format":"int64"},"path":{"type":"string"},"preference_template_id":{"type":"integer","format":"int64"},"system_root_user_group":{"type":"boolean"}}},"ContainerChildSortCriteria":{"id":"ContainerChildSortCriteria","properties":{"sort_order":{"$ref":"ChildSortOrder","enum":["ASCENDING","DESCENDING"]},"sort_parameter":{"$ref":"ChildSortField","enum":["NAME","CREATION_DATE","SEQUENCE","CONTENT_TYPE"]}}},"RecentAccessSelectionContext":{"id":"RecentAccessSelectionContext","properties":{"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"},"type":{"$ref":"RecentAccessObjectType","enum":["ASSET","CONTAINER"]}}},"MetadataCategory":{"id":"MetadataCategory","required":["id","name"],"properties":{"id":{"type":"string"},"legacy_id":{"type":"integer","format":"int32"},"metadata_element_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">MetadataElement is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataField - com.artesia.metadata.MetadataField</br>MetadataTableField - com.artesia.metadata.MetadataTableField</font>","items":{"$ref":"MetadataElement"}},"name":{"type":"string"}}},"CascadingDomainValue":{"id":"CascadingDomainValue","properties":{"element_values":{"$ref":"Map[int,DomainValue]"},"field_value":{"$ref":"Object"}}},"Container":{"id":"Container","properties":{"access_control_descriptor":{"$ref":"AccessControlDescriptor"},"asset_content_info":{"$ref":"AssetContentInfo"},"asset_id":{"type":"string"},"asset_lock_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"asset_lock_state_user_id":{"type":"string"},"asset_state":{"type":"string"},"asset_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"asset_state_user_id":{"type":"string"},"business_unit_id":{"type":"string"},"checked_out":{"type":"boolean"},"collection_ids":{"type":"array","items":{"type":"string"}},"container_child_counts":{"$ref":"ContainerChildCounts"},"container_id":{"type":"string"},"container_type_id":{"type":"string"},"container_type_name":{"type":"string"},"content_editable":{"type":"boolean"},"content_lock_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"content_lock_state_user_id":{"type":"string"},"content_lock_state_user_name":{"type":"string"},"content_size":{"type":"integer","format":"int64"},"content_state":{"type":"string"},"content_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"content_state_user_id":{"type":"string"},"content_state_user_name":{"type":"string"},"content_sub_type":{"type":"string"},"content_type":{"type":"string"},"creator_id":{"type":"string"},"data_type":{"type":"string"},"date_imported":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"date_last_updated":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"default_property_template_id":{"type":"string"},"deleted":{"type":"boolean"},"deletion_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"deletion_state_user_id":{"type":"string"},"deletion_state_user_name":{"type":"string"},"delivery_service_url":{"type":"string"},"expired":{"type":"boolean"},"import_job_id":{"type":"integer","format":"int64"},"import_user_name":{"type":"string"},"in_review":{"type":"boolean"},"inherited_metadata_collections":{"type":"array","items":{"$ref":"InheritedMetadataCollection"}},"latest_version":{"type":"boolean"},"legacy_model_id":{"type":"integer","format":"int32"},"links":{"$ref":"LinkCollection"},"locked":{"type":"boolean"},"master_content_info":{"$ref":"ContentInfo"},"metadata":{"$ref":"MetadataCollection","description":"</br><font color=\"#0F6AB4\">MetadataCollection is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataModel - com.artesia.metadata.MetadataModel</br>MetadataTable - com.artesia.metadata.MetadataTable</br>MetadataCategory - com.artesia.metadata.MetadataCategory</font>"},"metadata_lock_state_user_name":{"type":"string"},"metadata_model_id":{"type":"string"},"metadata_state_user_name":{"type":"string"},"mime_type":{"type":"string"},"name":{"type":"string"},"original_asset_id":{"type":"string"},"originating_preview_asset_id":{"type":"string"},"originating_preview_url":{"type":"string"},"originating_thumbnail_asset_id":{"type":"string"},"originating_thumbnail_url":{"type":"string"},"path_list":{"type":"array","items":{"$ref":"ContainerPath"}},"progressive_download_url":{"type":"string"},"rendition_content":{"$ref":"RenditionContentInfo"},"review_asset_approval_summary_collection":{"type":"array","items":{"$ref":"ReviewJobAssetApprovalSummary"}},"review_info_collection":{"type":"array","items":{"$ref":"CreativeReviewInfo"}},"security_policy_list":{"type":"array","items":{"$ref":"SecurityPolicy"}},"streaming_url":{"type":"string"},"subscribed_to":{"type":"boolean"},"thumbnail_content_id":{"type":"string"},"version":{"type":"integer","format":"int32"},"version_count":{"type":"integer","format":"int64"}}},"InheritedMetadataFieldValueID":{"id":"InheritedMetadataFieldValueID","properties":{"id":{"type":"string"},"inherited_field_id":{"type":"string"},"originator_id":{"type":"string"},"teams_id":{"type":"string"},"uoi_id":{"type":"string"}}},"AssetFilterRequest":{"id":"AssetFilterRequest","properties":{"exclude_deleted_assets":{"type":"boolean"},"include_orphan_folder":{"type":"boolean"}}},"AssetContentInfo":{"id":"AssetContentInfo","properties":{"master_content":{"$ref":"ContentInfo"},"supporting_content":{"type":"array","items":{"$ref":"ContentInfo"}}}},"ParticipantData":{"id":"ParticipantData","properties":{"business_unit_id":{"type":"string"},"cost_center":{"type":"string"},"country_code":{"type":"string"},"department":{"type":"string"},"email_address":{"type":"string"},"email_enabled":{"type":"boolean"},"first_and_last_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"state_province":{"type":"string"},"teams_user_id":{"type":"string"},"uoi_id":{"type":"string"},"work_phone":{"type":"string"}}},"Asset":{"id":"Asset","properties":{"access_control_descriptor":{"$ref":"AccessControlDescriptor"},"asset_content_info":{"$ref":"AssetContentInfo"},"asset_id":{"type":"string"},"asset_lock_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"asset_lock_state_user_id":{"type":"string"},"asset_state":{"type":"string"},"asset_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"asset_state_user_id":{"type":"string"},"business_unit_id":{"type":"string"},"checked_out":{"type":"boolean"},"collection_ids":{"type":"array","items":{"type":"string"}},"content_editable":{"type":"boolean"},"content_lock_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"content_lock_state_user_id":{"type":"string"},"content_lock_state_user_name":{"type":"string"},"content_size":{"type":"integer","format":"int64"},"content_state":{"type":"string"},"content_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"content_state_user_id":{"type":"string"},"content_state_user_name":{"type":"string"},"content_sub_type":{"type":"string"},"content_type":{"type":"string"},"creator_id":{"type":"string"},"data_type":{"type":"string"},"date_imported":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"date_last_updated":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"deleted":{"type":"boolean"},"deletion_state_last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"deletion_state_user_id":{"type":"string"},"deletion_state_user_name":{"type":"string"},"delivery_service_url":{"type":"string"},"expired":{"type":"boolean"},"import_job_id":{"type":"integer","format":"int64"},"import_user_name":{"type":"string"},"inherited_metadata_collections":{"type":"array","items":{"$ref":"InheritedMetadataCollection"}},"latest_version":{"type":"boolean"},"legacy_model_id":{"type":"integer","format":"int32"},"links":{"$ref":"LinkCollection"},"locked":{"type":"boolean"},"master_content_info":{"$ref":"ContentInfo"},"metadata":{"$ref":"MetadataCollection","description":"</br><font color=\"#0F6AB4\">MetadataCollection is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataModel - com.artesia.metadata.MetadataModel</br>MetadataTable - com.artesia.metadata.MetadataTable</br>MetadataCategory - com.artesia.metadata.MetadataCategory</font>"},"metadata_lock_state_user_name":{"type":"string"},"metadata_model_id":{"type":"string"},"metadata_state_user_name":{"type":"string"},"mime_type":{"type":"string"},"name":{"type":"string"},"original_asset_id":{"type":"string"},"path_list":{"type":"array","items":{"$ref":"ContainerPath"}},"progressive_download_url":{"type":"string"},"rendition_content":{"$ref":"RenditionContentInfo"},"review_asset_approval_summary_collection":{"type":"array","items":{"$ref":"ReviewJobAssetApprovalSummary"}},"review_info_collection":{"type":"array","items":{"$ref":"CreativeReviewInfo"}},"security_policy_list":{"type":"array","items":{"$ref":"SecurityPolicy"}},"streaming_url":{"type":"string"},"subscribed_to":{"type":"boolean"},"thumbnail_content_id":{"type":"string"},"version":{"type":"integer","format":"int32"},"version_count":{"type":"integer","format":"int64"}},"subTypes":["Container"]},"SelectionContextPropertyFilters":{"id":"SelectionContextPropertyFilters","properties":{"content_type_filters":{"type":"array","items":{"type":"string"}}}},"user_groups_resource":{"id":"user_groups_resource","properties":{"user_groups":{"type":"array","items":{"$ref":"UserGroup"}},"user_group_list":{"type":"array","items":{"$ref":"UserGroup"}}}},"MetadataTable":{"id":"MetadataTable","required":["id","name"],"properties":{"id":{"type":"string"},"legacy_id":{"type":"integer","format":"int32"},"metadata_element_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">MetadataElement is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataField - com.artesia.metadata.MetadataField</br>MetadataTableField - com.artesia.metadata.MetadataTableField</font>","items":{"$ref":"MetadataElement"}},"name":{"type":"string"},"row_count":{"type":"integer","format":"int32"},"table_column_map":{"$ref":"HashMap"}}},"FacetNumericIntervalFieldRestriction":{"id":"FacetNumericIntervalFieldRestriction","properties":{"facet_generation_behavior":{"$ref":"FacetGenerationBehavior","enum":["DROP","INCLUDE","EXCLUDE","DRILLDOWN"]},"field_id":{"type":"string"},"value_list":{"type":"array","items":{"$ref":"NumericInterval"}}}},"ContainerPath":{"id":"ContainerPath","properties":{"complete":{"type":"boolean"},"parents":{"type":"array","items":{"$ref":"LightContainer"}},"sequence_number":{"type":"integer","format":"int64"},"tree_descriptor":{"$ref":"TreeDescriptor"}}},"collection_resource":{"id":"collection_resource","properties":{"collection":{"type":"array","items":{"$ref":"Collection"}},"collection_summary":{"$ref":"collection_summary"}}},"FacetCascadingFieldRestriction":{"id":"FacetCascadingFieldRestriction","properties":{"facet_generation_behavior":{"$ref":"FacetGenerationBehavior","enum":["DROP","INCLUDE","EXCLUDE","DRILLDOWN"]},"field_id":{"type":"string"},"value_list":{"type":"array","items":{"$ref":"HierarchicalFacetValuePath"}}}},"DateRange":{"id":"DateRange","properties":{"custom_range":{"type":"boolean"},"end_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"start_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"}}},"ListOperationResult":{"id":"ListOperationResult","properties":{"collection_error_list":{"type":"array","items":{"$ref":"CollectionError"}},"errors":{"$ref":"Map[TeamsIdentifier,CollectionError]"},"result":{"$ref":"STATUS","enum":["PASSED","ERROR","PARTIAL"]},"valid_asset_id_list":{"type":"array","items":{"type":"string"}},"valid_collection_list":{"type":"array","items":{"type":"string"}}}},"FacetNumericRangeFieldRestriction":{"id":"FacetNumericRangeFieldRestriction","properties":{"facet_generation_behavior":{"$ref":"FacetGenerationBehavior","enum":["DROP","INCLUDE","EXCLUDE","DRILLDOWN"]},"field_id":{"type":"string"},"value_list":{"type":"array","items":{"$ref":"NumericRange"}}}},"MetadataModel":{"id":"MetadataModel","required":["id","name"],"properties":{"has_multilingual_fields":{"type":"boolean"},"id":{"type":"string"},"legacy_id":{"type":"integer","format":"int32"},"metadata_element_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">MetadataElement is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataField - com.artesia.metadata.MetadataField</br>MetadataTableField - com.artesia.metadata.MetadataTableField</font>","items":{"$ref":"MetadataElement"}},"name":{"type":"string"},"object_type":{"type":"string"}}},"SearchTabularCondition":{"id":"SearchTabularCondition","properties":{"filter_condition":{"type":"boolean"},"left_paren":{"type":"string"},"metadata_table_id":{"type":"string"},"relational_operator":{"type":"string"},"right_paren":{"type":"string"},"tabular_field_list":{"type":"array","items":{"$ref":"SearchTabularFieldCondition"}}}},"CollectionSelectionContext":{"id":"CollectionSelectionContext","properties":{"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"collection_id":{"type":"string"},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"},"sort_criteria":{"type":"array","items":{"$ref":"CollectionAssetsSortCriteria"}}}},"FacetDateIntervalFieldRestriction":{"id":"FacetDateIntervalFieldRestriction","properties":{"facet_generation_behavior":{"$ref":"FacetGenerationBehavior","enum":["DROP","INCLUDE","EXCLUDE","DRILLDOWN"]},"field_id":{"type":"string"},"value_list":{"type":"array","items":{"$ref":"DateInterval"}}}},"FacetFieldRestriction":{"id":"FacetFieldRestriction","properties":{"facet_generation_behavior":{"$ref":"FacetGenerationBehavior","enum":["DROP","INCLUDE","EXCLUDE","DRILLDOWN"]},"field_id":{"type":"string"}},"subTypes":["FacetSimpleFieldRestriction","FacetNumericRangeFieldRestriction","FacetNumericIntervalFieldRestriction","FacetDateRangeFieldRestriction","FacetDateIntervalFieldRestriction","FacetCascadingFieldRestriction"]},"data_load_request":{"id":"data_load_request","properties":{"child_count_load_type":{"type":"string","description":"Folder child count load type","enum":["assets","folders","both","none"]},"link_type_ids":{"type":"array","items":{"type":"string"}},"load_3d_preview_info":{"type":"boolean"},"load_asset_content_info":{"type":"boolean"},"load_asset_content_with_text":{"type":"boolean"},"load_collections":{"type":"boolean"},"load_container_originating_urls":{"type":"boolean"},"load_destination_links":{"type":"boolean"},"load_inherited_metadata":{"type":"boolean"},"load_metadata":{"type":"boolean"},"load_multilingual_field_values":{"type":"boolean"},"load_path":{"type":"boolean"},"load_path_with_children":{"type":"boolean"},"load_pdf_preview_info":{"type":"boolean"},"load_preview_info":{"type":"boolean"},"load_review_info":{"type":"boolean"},"load_security_policies":{"type":"boolean"},"load_subscribed_to":{"type":"boolean"},"load_thumbnail_info":{"type":"boolean"},"load_video_rollover_info":{"type":"boolean"},"metadata_fields_to_return":{"type":"array","items":{"type":"string"}}}},"TeamsUser":{"id":"TeamsUser","properties":{"business_unit_id":{"type":"string"},"cost_center":{"type":"string"},"country_code":{"type":"string"},"create_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"department":{"type":"string"},"description":{"type":"string"},"disabled":{"type":"boolean"},"domain_name":{"type":"string"},"email_address":{"type":"string"},"email_enabled":{"type":"boolean"},"first_name":{"type":"string"},"group_id":{"type":"integer","format":"int64"},"last_name":{"type":"string"},"license_type":{"$ref":"LicenseType","enum":["Standard","Read Only"]},"login_name":{"type":"string"},"name":{"type":"string"},"otds_user_id":{"type":"string"},"participant":{"$ref":"ParticipantData"},"role_id":{"type":"integer","format":"int64"},"s_user_id":{"type":"string"},"state_province":{"type":"string"},"user_id":{"type":"string"},"user_pref_template_id":{"type":"integer","format":"int64"},"work_phone":{"type":"string"}}},"ActivitySelectionContext":{"id":"ActivitySelectionContext","properties":{"activity_id":{"type":"integer","format":"int64"},"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"}}},"AssetCollectionSelectionContext":{"id":"AssetCollectionSelectionContext","properties":{"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"collection_id":{"type":"string"},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"}}},"collection_param":{"id":"collection_param","properties":{"asset_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">Asset is base type for the below sub types.</br><b>Sub Types: </b></br>Container - com.artesia.container.Container</font>","items":{"$ref":"Asset"}},"collection":{"$ref":"Collection"}}},"asset_filter_request_param":{"id":"asset_filter_request_param","properties":{"asset_filter_request":{"$ref":"AssetFilterRequest"}}},"collection_list_selection_context_param":{"id":"collection_list_selection_context_param","properties":{"collection_list_selection_context":{"$ref":"CollectionListSelectionContext"}}},"MetadataTableField":{"id":"MetadataTableField","required":["id","name"],"properties":{"analytics":{"type":"boolean"},"cascading_group_id":{"type":"string"},"column_name":{"type":"string"},"data_length":{"type":"integer","format":"int32"},"data_type":{"type":"string"},"default_value":{"type":"string"},"description":{"type":"string"},"displayable":{"type":"boolean"},"domain_id":{"type":"string"},"domained":{"type":"boolean"},"edit_type":{"type":"string"},"editable":{"type":"boolean"},"enabled":{"type":"boolean"},"external_datasource_id":{"type":"string"},"facetable":{"type":"boolean"},"id":{"type":"string"},"instructions":{"type":"string"},"meta_table_seq":{"type":"integer","format":"int32"},"multilingual":{"type":"boolean"},"multilingual_table_name":{"type":"string"},"name":{"type":"string"},"options":{"type":"string"},"parent_table_id":{"type":"string"},"parent_table_name":{"type":"string"},"prompt":{"type":"string"},"required":{"type":"boolean"},"restriction_id":{"type":"integer","format":"int64"},"saved_values_behavior_mode":{"type":"integer","format":"int32"},"scale":{"type":"integer","format":"int32"},"searchable":{"type":"boolean"},"searchable_scope_id":{"type":"string"},"sortable":{"type":"boolean"},"table_name":{"type":"string"},"tabular":{"type":"boolean"},"trigger_field":{"type":"boolean"},"validation_rule":{"type":"string"},"value":{"$ref":"MetadataValue","description":"</br>The metadata value object should contain the type of object it is holding in its value field</br>. Below examples show JSON representation of the value field for various data types</br>\"value\": {<b>\"type\": \"dateTime\"</b>,\"value\": \"2015-10-13T11:25:40.215+05:30\"}</br>\"value\": {<b>\"type\": \"string\"</b>,\"value\": \"Media Management\"}</br>\"value\": {<b>\"type\": \"int\"</b>,\"value\": \"2014\"}</br>\"value\": {<b>\"type\": \"decimal\"</b>,\"value\": \"7.3\"}</br>"},"values":{"type":"array","description":"</br>The metadata value object should contain the type of object it is holding in its value field</br>. Below examples show JSON representation of the value field for various data types</br>\"value\": {<b>\"type\": \"dateTime\"</b>,\"value\": \"2015-10-13T11:25:40.215+05:30\"}</br>\"value\": {<b>\"type\": \"string\"</b>,\"value\": \"Media Management\"}</br>\"value\": {<b>\"type\": \"int\"</b>,\"value\": \"2014\"}</br>\"value\": {<b>\"type\": \"decimal\"</b>,\"value\": \"7.3\"}</br>","items":{"$ref":"MetadataValue"}}}},"AssetIdPathList":{"id":"AssetIdPathList","properties":{"asset_id":{"type":"string"},"paths":{"type":"array","items":{"$ref":"ContainerPath"}}}},"sort_option":{"id":"sort_option","properties":{"message_id":{"type":"string"},"name":{"type":"string"},"prompt":{"type":"string"}}},"RelativeDateIntervalValue":{"id":"RelativeDateIntervalValue","properties":{"adjustment_offset":{"type":"integer","format":"int32"},"adjustment_units":{"type":"string"},"base_time_unit":{"type":"string"}}},"SearchTabularFieldCondition":{"id":"SearchTabularFieldCondition","properties":{"display_value":{"type":"string"},"filter_condition":{"type":"boolean"},"left_paren":{"type":"string"},"metadata_field_id":{"type":"string"},"relational_operator":{"type":"string"},"relational_operator_id":{"type":"string"},"right_paren":{"type":"string"},"value":{"type":"string"}}},"AssetIdsSelectionContext":{"id":"AssetIdsSelectionContext","properties":{"asset_ids":{"type":"array","items":{"type":"string"}},"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"}}},"SearchCondition":{"id":"SearchCondition","properties":{"filter_condition":{"type":"boolean"},"left_paren":{"type":"string"},"relational_operator":{"type":"string"},"right_paren":{"type":"string"}},"subTypes":["SearchMetadataCondition","SearchCustomCondition","SearchFulltextCondition","SearchScalarCondition","SearchTabularCondition","SearchTabularFieldCondition"]},"InheritedMetadataFieldValue":{"id":"InheritedMetadataFieldValue","required":["name"],"properties":{"id":{"type":"string"},"metadata_element":{"$ref":"MetadataElement","description":"</br><font color=\"#0F6AB4\">MetadataElement is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataField - com.artesia.metadata.MetadataField</br>MetadataTableField - com.artesia.metadata.MetadataTableField</font>"},"metadata_field":{"$ref":"MetadataField","description":"</br><font color=\"#0F6AB4\">MetadataField is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataTableField - com.artesia.metadata.MetadataTableField</font>"},"metadata_table":{"$ref":"MetadataTable"},"name":{"type":"string"},"tabular":{"type":"boolean"},"value_id":{"$ref":"InheritedMetadataFieldValueID"}}},"CollectionSortCriteria":{"id":"CollectionSortCriteria","properties":{"sort_order":{"$ref":"CollectionSortOrder","enum":["ASCENDING","DESCENDING"]},"sort_parameter":{"$ref":"CollectionSortField","enum":["NAME","CREATED_DATE","UPDATED_DATE","AVERAGE_RATING","USER_RATING"]}}},"selection_context_param":{"id":"selection_context_param","properties":{"selection_context":{"$ref":"SelectionContext","description":"</br><font color=\"#0F6AB4\">SelectionContext is base type for the below sub types.</br><b>Sub Types: </b></br>SearchSelectionContext - com.artesia.asset.selection.SearchSelectionContext</br>FolderSelectionContext - com.artesia.asset.selection.FolderSelectionContext</br>AssetIdsSelectionContext - com.artesia.asset.selection.AssetIdsSelectionContext</br>AssetCollectionSelectionContext - com.artesia.asset.selection.AssetCollectionSelectionContext</br>RecentAccessSelectionContext - com.artesia.asset.selection.RecentAccessSelectionContext</br>ReviewJobSelectionContext - com.artesia.asset.selection.ReviewJobSelectionContext</br>ActivitySelectionContext - com.artesia.asset.selection.ActivitySelectionContext</br>CollectionSelectionContext - com.artesia.asset.selection.CollectionSelectionContext</br>CollectionListSelectionContext - com.artesia.asset.selection.CollectionListSelectionContext</font>"}}},"InheritedMetadataCollection":{"id":"InheritedMetadataCollection","properties":{"container_id":{"type":"string"},"container_name":{"type":"string"},"container_type_id":{"type":"string"},"container_type_name":{"type":"string"},"inherited_metadata_values":{"type":"array","items":{"$ref":"InheritedMetadataFieldValue"}}}},"CollectionListSelectionContext":{"id":"CollectionListSelectionContext","properties":{"attested_context":{"$ref":"AttestedContext"},"child_type":{"$ref":"ChildType","enum":["ASSETS","CONTAINERS","ASSETS_AND_CONTAINERS"]},"collection_ids":{"type":"array","items":{"type":"string"}},"exclusion_asset_id_list":{"type":"array","items":{"type":"string"}},"exclusion_collection_id_list":{"type":"array","items":{"type":"string"}},"include_deleted_assets":{"type":"boolean"},"include_descendants":{"$ref":"Descendants","enum":["ALL","IMMEDIATE","NONE"]},"page_index":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"permissions_filter":{"$ref":"List[SecurityPermissionsEnum]","enum":["ASSETVIEW_PERM","SUMMARYVIEW_PERM","PREVIEWVIEW_PERM","EXPORT_PERM","SUBSCRIBE_PERM","METAEDIT_PERM","CONTENTEDIT_PERM","MEMBERSHIPEDIT_PERM","DELETEASSET_PERM","EDITPARENTS_PERM","CUSTOM01_PERM","CUSTOM02_PERM","CUSTOM03_PERM","CUSTOM04_PERM"]},"property_filters":{"$ref":"SelectionContextPropertyFilters"},"sort_criteria":{"$ref":"CollectionSortCriteria"}}},"MetadataCollection":{"id":"MetadataCollection","required":["id","name"],"properties":{"id":{"type":"string"},"metadata_element_list":{"type":"array","description":"</br><font color=\"#0F6AB4\">MetadataElement is base type for the below sub types.</br><b>Sub Types: </b></br>MetadataField - com.artesia.metadata.MetadataField</br>MetadataTableField - com.artesia.metadata.MetadataTableField</font>","items":{"$ref":"MetadataElement"}},"name":{"type":"string"}},"subTypes":["MetadataModel","MetadataTable","MetadataCategory"]},"AccessControlDescriptor":{"id":"AccessControlDescriptor","properties":{"permissions_map":{"$ref":"Map[string,boolean]"}}},"AttestedContext":{"id":"AttestedContext","properties":{"attested_identifier":{"type":"string"},"context_type":{"$ref":"CONTEXT_TYPE","enum":["COLLECTION"]}}},"SecurityPolicy":{"id":"SecurityPolicy","properties":{"administrators":{"type":"array","items":{"$ref":"TeamsUser"}},"create_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"created_by":{"type":"string"},"description":{"type":"string"},"id":{"type":"integer","format":"int64"},"last_update_date":{"type":"string","format":"date-time","description":"</br>The convention for representing date objects is <b>ISO 8601</b> format i.e <b>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</b>"},"last_updated_by":{"type":"string"},"name":{"type":"string"},"ownership_type":{"type":"string"},"status":{"type":"string"}}},"FacetSimpleFieldRestriction":{"id":"FacetSimpleFieldRestriction","properties":{"facet_generation_behavior":{"$ref":"FacetGenerationBehavior","enum":["DROP","INCLUDE","EXCLUDE","DRILLDOWN"]},"field_id":{"type":"string"},"value_list":{"type":"array","items":{"type":"string"}}}},"Link":{"id":"Link","required":["link_id"],"properties":{"follow_latest_version_of_destination":{"type":"boolean"},"link_id":{"$ref":"LinkIdentifier"},"sequence":{"type":"integer","format":"int32"}}},"DomainValue":{"id":"DomainValue","properties":{"active_from":{"type":"string"},"active_to":{"type":"string"},"description":{"type":"string"},"display_value":{"type":"string"},"expired_value":{"type":"boolean"},"field_value":{"$ref":"Object"}}},"ReviewJobAssetApprovalState":{"id":"ReviewJobAssetApprovalState","properties":{"id":{"type":"integer","format":"int32"},"lifecycle_approved":{"type":"boolean"},"name":{"type":"string"}}},"CollectionShareAccessInfo":{"id":"CollectionShareAccessInfo","properties":{"access_id":{"type":"integer","format":"int64"},"access_level":{"$ref":"CollectionAccessLevel","enum":["USER","USERGROUP"]},"collection_id":{"type":"string"},"id":{"type":"integer","format":"int64"},"shared_by":{"type":"string"},"user_group_id":{"type":"integer","format":"int64"},"user_group_name":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}}}}