sams_client.endpoints.assets – Asset Endpoint

class SamsAssetEndpoint(client)

Helper class for the Assets resource

This class automatically sets _read_url to /consume/assets and the _write_url to /produce/assets

get_by_ids(item_ids: List[bson.objectid.ObjectId], headers: Optional[Dict[str, Any]] = None, callback: Optional[Callable[[requests.models.Response], requests.models.Response]] = None) → requests.models.Response

Helper method to get Assets by ids

Parameters

  • item_ids (list<bson.objectid.ObjectId>) – The Asset IDs

  • headers (dict) – Dictionary of headers to apply

  • callback – A callback function to manipulate the response

Return type

requests.Response

Returns

The Assets, if found

get_binary_by_id(item_id: bson.objectid.ObjectId, headers: Optional[Dict[str, Any]] = None, callback: Optional[Callable[[requests.models.Response], requests.models.Response]] = None) → requests.models.Response

Helper method to get an asset binary by its id

Parameters

  • item_id (bson.objectid.ObjectId) – The ID of the asset

  • headers (dict) – Dictionary of headers to apply

  • callback – A callback function to manipulate the response

Return type

requests.Response

Returns

The binary, if found

get_binary_zip_by_id(item_ids: Optional[List[Union[bson.objectid.ObjectId, str]]] = None, headers: Optional[Dict[str, Any]] = None, callback: Optional[Callable[[requests.models.Response], requests.models.Response]] = None) → requests.models.Response

Helper method to get assets’ compressed binaries by its ids

Parameters

  • item_ids (bson.objectid.ObjectId) – The IDs’ Array of the asset

  • headers (dict) – Dictionary of headers to apply

  • callback – A callback function to manipulate the response

Return type

requests.Response

Returns

The compressed binaries zip, if found

get_assets_count(set_ids: [<class 'bson.objectid.ObjectId'>] = None, headers: Dict[str, Any] = None, callback: Callable[[requests.models.Response], requests.models.Response] = None) → Tuple[Dict[str, int], int]

Helper method to get asset count distribution for given set ids will get asset count distribution over all sets if set_ids is None

Parameters

  • bson.objectid.ObjectId set_ids (array) – Id of sets

  • headers (dict) – Dictionary of headers to apply

  • callback – A callback function to manipulate the response

Return type

dict<str, int>, int

get_tag_codes(query: Optional[Dict[str, Any]] = None, size: Optional[int] = 100, headers: Optional[Dict[str, Any]] = None, callback: Optional[Callable[[requests.models.Response], requests.models.Response]] = None) → Tuple[Dict[str, List[str]], int]

Helper method to get the list of tag codes used in Asset metadata

Parameters

  • query (dict) – Optional elasticsearch query to apply

  • size (int) – The maximum number of tag codes to return (defaults to 100)

  • headers (dict) – Dictionary of headers to apply

  • callback – A callback function to manipulate the response

Returns

A tuple containing the list of tag codes and status_code

Return type

dict<str, int>, int

lock_asset(docs: Dict[str, Any], item_id: bson.objectid.ObjectId, headers: Optional[Dict[str, Any]] = None, external_user_id: Optional[str] = None, external_session_id: Optional[str] = None, callback: Optional[Callable[[requests.models.Response], requests.models.Response]] = None) → requests.models.Response

Helper method to lock Assets by ids

Parameters

  • docs (dict) – The documents to update

  • item_id (bson.objectid.ObjectId) – The Asset IDs

  • headers (dict) – Dictionary of headers to apply

  • external_user_id (str) – External user id

  • external_session_id (str) – External session id

  • callback – A callback function to manipulate the response

Return type

requests.Response

Returns

The updates in asset, if found

unlock_asset(docs: Dict[str, Any], item_id: bson.objectid.ObjectId, headers: Optional[Dict[str, Any]] = None, external_user_id: Optional[str] = None, external_session_id: Optional[str] = None, callback: Optional[Callable[[requests.models.Response], requests.models.Response]] = None) → requests.models.Response

Helper method to unlock asset by ids

Parameters

  • docs (dict) – The documents to update

  • item_ids (bson.objectid.ObjectId) – The Asset IDs

  • headers (dict) – Dictionary of headers to apply

  • external_user_id (str) – External user id

  • external_session_id (str) – External session id

  • callback – A callback function to manipulate the response

Return type

requests.Response

Returns

The changes in asset, if found

unlock_assets_by_user(headers: Optional[Dict[str, Any]] = None, external_user_id: Optional[str] = None, external_session_id: Optional[str] = None, callback: Optional[Callable[[requests.models.Response], requests.models.Response]] = None) → requests.models.Response

Helper method to unlock assets by user Id

Parameters

  • headers (dict) – Dictionary of headers to apply

  • external_user_id (str) – External user id

  • external_session_id (str) – External session id

  • callback – A callback function to manipulate the response

Return type

requests.Response

Returns

200 status code if all assets unlocked