flowground für Geschäftskunden

Technische Spezifikationen

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

Artists_GetImagesByArtist

OnInit
./lib/actions/Artists_GetImagesByArtist.js
OnStartup
-
OnClose
-

Attributes

-

Artists_GetVideosByArtist

OnInit
./lib/actions/Artists_GetVideosByArtist.js
OnStartup
-
OnClose
-

Attributes

-

AssetChanges_PutAssetChanges

# Asset Changes Get notifications about new, updated or deleted assets. ## Quickstart You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. Partner channels that have not been checked within the last 120 days will be removed and that partner will no longer be able to get change notifications from that channel. Partners who would like to start using the Asset Changes API again after a period of dormancy should contact their sales representative to be set up again.

OnInit
./lib/actions/AssetChanges_PutAssetChanges.js
OnStartup
-
OnClose
-

Attributes

-

AssetChanges_DeleteAssetChanges

# Delete Asset Changes Confirm asset changes acknowledges receipt of asset changes (from the PUT asset changes endpoint). ## Quickstart You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/AssetChanges_DeleteAssetChanges.js
OnStartup
-
OnClose
-

Attributes

-

AssetChanges_GetPartnerChannel

# Get Partner Channels Retrieves the channel data for the partner. This data can be used to populate the channel_id parameter in the Put Asset Changes query. ## Quickstart You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. Only channels that have been queried in the last 120 days will be included in the list of channels. Partners who have a channel that has been removed should contact their sales representative to be set up again.

OnInit
./lib/actions/AssetChanges_GetPartnerChannel.js
OnStartup
-
OnClose
-

Attributes

-

AssetLicensing_AcquireAssetLicenseWithCredits

OnInit
./lib/actions/AssetLicensing_AcquireAssetLicenseWithCredits.js
OnStartup
-
OnClose
-

Attributes

-

Boards_GetAllBoards

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve all Boards available for a user. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_GetAllBoards.js
OnStartup
-
OnClose
-

Attributes

-

Boards_CreateBoard

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to create a Board by a specific id. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. **NOTE:** *The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.*

OnInit
./lib/actions/Boards_CreateBoard.js
OnStartup
-
OnClose
-

Attributes

-

Boards_DeleteBoard

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to delete a Board by a specific id. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_DeleteBoard.js
OnStartup
-
OnClose
-

Attributes

-

Boards_GetBoard

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve a Board by a specific id. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_GetBoard.js
OnStartup
-
OnClose
-

Attributes

-

Boards_UpdateBoard

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to update a Board by a specific id. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. **NOTE:** *The input to this endpoint is not sanitized in any way, so it is the responsibility of the client to ensure that it is properly formatted and guards against malicious data (for example cross-site scripting attacks or HTML injection) when accessing the data.*

OnInit
./lib/actions/Boards_UpdateBoard.js
OnStartup
-
OnClose
-

Attributes

-

Boards_RemoveAssets

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to remove a set of assets from a board. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_RemoveAssets.js
OnStartup
-
OnClose
-

Attributes

-

Boards_AddAssets

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to add a set of assets to a board. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_AddAssets.js
OnStartup
-
OnClose
-

Attributes

-

Boards_RemoveAsset

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to remove an asset from a board. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_RemoveAsset.js
OnStartup
-
OnClose
-

Attributes

-

Boards_AddAsset

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to add an asset to a board. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_AddAsset.js
OnStartup
-
OnClose
-

Attributes

-

Boards_GetComments

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to retrieve all comments for a specific board. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_GetComments.js
OnStartup
-
OnClose
-

Attributes

-

Boards_AddComment

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to add a comment to a board. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_AddComment.js
OnStartup
-
OnClose
-

Attributes

-

Boards_DeleteComment

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the [Boards FAQ](http://www.gettyimages.com/boards/faq). Use this endpoint to delete a comment from a board. You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Boards_DeleteComment.js
OnStartup
-
OnClose
-

Attributes

-

Collections_GetCollections

Use this endpoint to retrieve collections associated with your Getty Images account. To browse available collections see our [Image collections page]( http://www.gettyimages.com/creative-images/collections). You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Collections_GetCollections.js
OnStartup
-
OnClose
-

Attributes

-

Countries_GetCountries

Returns a list of country objects that contains country name, two letter ISO abbreviation and three letter ISO abbreviation. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Countries_GetCountries.js
OnStartup
-
OnClose
-

Attributes

-

Customers_GetCustomerInfo

Returns the first, middle and last name of the authenticated user. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.

OnInit
./lib/actions/Customers_GetCustomerInfo.js
OnStartup
-
OnClose
-

Attributes

-

Downloads_GetDownloads

Returns information about a customer's previously downloaded assets. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. This endpoint requires being a Getty Images customer to limit your results to only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.

OnInit
./lib/actions/Downloads_GetDownloads.js
OnStartup
-
OnClose
-

Attributes

-

Downloads_PostDownloads

Use this endpoint to generate download URLs and related data for images you are authorized to download. Most product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period. The download limit for a given download period is covered in your product agreement established with Getty Images. You'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. ## Auto Downloads The `auto_download` request query parameter specifies whether to automatically download the image. If the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*. Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4). Client Request: ``` https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=true ``` Server Response: ``` HTTP/1.1 303 See Other Location: https://delivery.gettyimages.com/... ``` If the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the image. Client Request: ``` https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=false ``` Server Response: ``` HTTP/1.1 200 OK { "uri": "https://delivery.gettyimages.com/..." } ```

OnInit
./lib/actions/Downloads_PostDownloads.js
OnStartup
-
OnClose
-

Attributes

-

Downloads_PostVideoDownloads

Use this endpoint to generate download URLs and related data for videos you are authorized to download. Most product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period. The download limit for a given download period is covered in your product agreement established with Getty Images. You'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. ## Auto Downloads The `auto_download` request query parameter specifies whether to automatically download the video. If the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*. Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4). Client Request: ``` https://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=true ``` Server Response: ``` HTTP/1.1 303 See Other Location: https://delivery.gettyimages.com/... ``` If the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the video. Client Request: ``` https://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=false ``` Server Response: ``` HTTP/1.1 200 OK { "uri": "https://delivery.gettyimages.com/..." } ```

OnInit
./lib/actions/Downloads_PostVideoDownloads.js
OnStartup
-
OnClose
-

Attributes

-

Events_GetBatch

This endpoint returns the detailed event metadata for all specified events. Getty Images news, sports and entertainment photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week". You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Events_GetBatch.js
OnStartup
-
OnClose
-

Attributes

-

Events_Get

This endpoint returns the detailed event metadata for a specified event. Getty Images news, sports and entertainment photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week". You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Events_Get.js
OnStartup
-
OnClose
-

Attributes

-

Images_GetBatch

This endpoint returns the detailed image metadata for all specified images. Due to a wide variety of available image resolutions, the images are grouped into a handful of size categories for simplicity. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request. ``` { "images": [ "artist", "asset_family", "caption", "collection_code", "collection_id", "collection_name", "license_model", "max_dimensions", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request. ``` { "images": [ "allowed_use", "artist", "artist_title", "asset_family", "call_for_image", "caption", "city", "collection_code", "collection_id", "collection_name", "color_type", "copyright", "country", "credit_line", "date_created", "date_submitted", "download_sizes", "editorial_segments", "event_ids", "graphical_style", "license_model", "max_dimensions", "orientation", "product_types", "quality_rank", "referral_destinations", "state_province", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set** in your request. ``` { "images": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Images_GetBatch.js
OnStartup
-
OnClose
-

Attributes

-

Images_Get

This endpoint returns the detailed image metadata for a specified image. Due to a wide variety of available image resolutions, the images are grouped into a handful of size categories for simplicity. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request. ``` { "images": [ "artist", "asset_family", "caption", "collection_code", "collection_id", "collection_name", "license_model", "max_dimensions", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request. ``` { "images": [ "allowed_use", "artist", "artist_title", "asset_family", "call_for_image", "caption", "city", "collection_code", "collection_id", "collection_name", "color_type", "copyright", "country", "credit_line", "date_created", "date_submitted", "download_sizes", "editorial_segments", "event_ids", "graphical_style", "license_model", "max_dimensions", "orientation", "product_types", "quality_rank", "referral_destinations", "state_province", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set** in your request. ``` { "images": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Images_Get.js
OnStartup
-
OnClose
-

Attributes

-

Images_GetSimilarImages

This endpoint will search our asset database for images similar to the specified asset id. Due to a wide variety of available image resolutions, the images are grouped into a handful of size categories for simplicity. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request. ``` { "images": [ "asset_family", "caption", "collection_code", "collection_id", "collection_name", "display_sizes": [ { "name": "thumb" } ] "license_model", "max_dimensions", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request. ``` { "images": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "collection_code", "collection_id", "collection_name", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "editorial_segments", "event_ids", "graphical_style", "license_model", "max_dimensions", "orientation", "product_types", "quality_rank", "referral_destinations", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set** in your request. ``` { "images": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ```

OnInit
./lib/actions/Images_GetSimilarImages.js
OnStartup
-
OnClose
-

Attributes

-

Orders_GetOrder

This endpoint returns detailed order metadata for a specified order. Use of this endpoint requires configuration changes to your API key. Please contact [developersupport@gettyimages.com](mailto:developersupport@gettyimages.com) to learn more. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Orders_GetOrder.js
OnStartup
-
OnClose
-

Attributes

-

Products_GetProducts

This endpoint returns all products available to the username used during authentication. As such, this endpoint requires the use of a fully authorized access_token. The product data can then be used as search filters, restricting results to images from a specific product. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Products_GetProducts.js
OnStartup
-
OnClose
-

Attributes

-

Purchases_GetPreviousAssetPurchases

This endpoint returns a list of all assets purchased on gettyimages.com by the username used for authentication. Use of this endpoint requires configuration changes to your API key. Please contact [developersupport@gettyimages.com](mailto:developersupport@gettyimages.com) to learn more. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Purchases_GetPreviousAssetPurchases.js
OnStartup
-
OnClose
-

Attributes

-

Purchases_GetPreviousPurchases

This endpoint returns a list of all images purchased on gettyimages.com by the username used for authentication. Use of this endpoint requires configuration changes to your API key. Please contact [developersupport@gettyimages.com](mailto:developersupport@gettyimages.com) to learn more. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key.

OnInit
./lib/actions/Purchases_GetPreviousPurchases.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetEvents

Use this endpoint to search Getty Images news, sports and entertainment events. Getty Images photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in Search Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week". You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.

OnInit
./lib/actions/Search_GetEvents.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetImagesByPhrase

Use this endpoint to search over a blend of our contemporary stock photos, illustrations, archival images, editorial photos, illustrations and archival images. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token. To include your API token in the search request, add it to the headers as a Bearer token (example in curl): -H "Authorization: Bearer " ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request. ``` { "images": [ "asset_family", "caption", "collection_code", "collection_id", "collection_name", "display_sizes": [ { "name": "thumb" } ], "license_model", "max_dimensions", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request. ``` { "images": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "collection_code", "collection_id", "collection_name", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "editorial_segments", "event_ids", "graphical_style", "license_model", "max_dimensions", "orientation", "product_types", "quality_rank", "referral_destinations", "title" ] ] ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set** in your request. ``` { "images": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Search_GetImagesByPhrase.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetCreativeImagesByPhrase

Use this endpoint to search our contemporary stock photos, illustrations and archival images. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request. ``` { "images": [ "asset_family", "caption", "collection_code", "collection_id", "collection_name", "display_sizes": [ { "name": "thumb" } ], "license_model", "max_dimensions", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request. ``` { "images": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "collection_code", "collection_id", "collection_name", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "editorial_segments", "event_ids", "graphical_style", "license_model", "max_dimensions", "orientation", "product_types", "quality_rank", "referral_destinations", "title" ] ] ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set** in your request. ```Go { "images": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ```

OnInit
./lib/actions/Search_GetCreativeImagesByPhrase.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetCreativeImagesByUrl

Allows searching for similar creative images by passing the URL to an existing image. Before calling the search by image endpoint, an image must be uploaded to a specific AWS S3 bucket. The bucket name is `search-by-image.s3.amazonaws.com`. For example, using cURL: ```sh curl -i -X PUT https://search-by-image.s3.amazonaws.com/my-test-image.jpg -H "Content-Type: image/jpeg" --data-binary "@testimage.jpg" ``` Uploads can be overwritten if the names are the same, so using a prefix like the API Key, application name or company name would help keep that from happening. Once the image has been uploaded, use the full URL in the `image_url` parameter, e.g. `image_url=https://search-by-image.s3.amazonaws.com/my-test-image.jpg`. Subsequent searches for the same image can be executed using the `image_fingerprint` that is returned by the inital search.

OnInit
./lib/actions/Search_GetCreativeImagesByUrl.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetEditorialImagesByPhrase

Use this endpoint to search our editorial stock photos, illustrations and archival images. Editorial images represent newsworthy events or illustrate matters of general interest, such as news, sport and entertainment and are generally intended for editorial use. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token. To include your API token in the search request, add it to the headers as a Bearer token (example in curl): -H "Authorization: Bearer " ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request. ``` { "images": [ "asset_family", "caption", "collection_code", "collection_id", "collection_name", "display_sizes": [ { "name": "thumb" } ], "license_model", "max_dimensions", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request. ``` { "images": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "collection_code", "collection_id", "collection_name", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "editorial_segments", "event_ids", "graphical_style", "license_model", "max_dimensions", "orientation", "product_types", "quality_rank", "referral_destinations", "title" ] ] ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set** in your request. ``` { "images": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Search_GetEditorialImagesByPhrase.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetVideosByPhrase

Use this endpoint to search over a blend of our premium stock, contemporary 4K and HD footage, celebrities, news, newsmakers, entertainment, events and archival videos. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request. ``` { "videos": [ "asset_family", "caption", "collection_code", "collection_name", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "license_model", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request. ``` { "videos": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "clip_length", "collection_code", "collection_id", "collection_name", "color_type", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "era", "license_model", "mastered_to", "originally_shot_on", "product_types", "shot_speed", "source", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request. ``` { "videos": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Search_GetVideosByPhrase.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetCreativeVideosByPhrase

Use this endpoint to search premium stock video, from archival film to contemporary 4K and HD footage. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request. ``` { "videos": [ "asset_family", "caption", "collection_code", "collection_name", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "license_model", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request. ``` { "videos": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "clip_length", "collection_code", "collection_id", "collection_name", "color_type", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "era", "license_model", "mastered_to", "originally_shot_on", "product_types", "shot_speed", "source", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request. ``` { "videos": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ```

OnInit
./lib/actions/Search_GetCreativeVideosByPhrase.js
OnStartup
-
OnClose
-

Attributes

-

Search_GetEditorialVideosByPhrase

Use this endpoint to search current and archival video clips of celebrities, newsmakers, and events. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request. ``` { "videos": [ "asset_family", "caption", "collection_code", "collection_name", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "license_model", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request. ``` { "videos": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "clip_length", "collection_code", "collection_id", "collection_name", "color_type", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "era", "license_model", "mastered_to", "originally_shot_on", "product_types", "shot_speed", "source", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request. ``` { "videos": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Search_GetEditorialVideosByPhrase.js
OnStartup
-
OnClose
-

Attributes

-

PutAsync

# Report Usage Use this endpoint to report the usages of a set of assets. The count of assets submitted in a single batch to this endpoint is limited to 1000. Note that all asset Ids specified must be valid or the operation will fail causing no usages to be recorded. In this case, you will need to remove the invalid asset Ids from the query request and re-submit the query. ## Quickstart You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. _Note_: Date of use can be in any unambiguous date format.

OnInit
./lib/actions/PutAsync.js
OnStartup
-
OnClose
-

Attributes

-

Videos_GetBatch

Use this endpoint to return detailed video metadata for all the specified video ids. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request. ``` { "videos": [ "asset_family", "caption", "collection_code", "collection_name", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "license_model", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request. ``` { "videos": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "clip_length", "collection_code", "collection_id", "collection_name", "color_type", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "download_sizes", "era", "license_model", "mastered_to", "originally_shot_on", "product_types", "shot_speed", "source", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request. ``` { "videos": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Videos_GetBatch.js
OnStartup
-
OnClose
-

Attributes

-

Videos_Get

Use this endpoint to return detailed video metadata for the specified video id. You'll need an API key and access token to use this resource. Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token. ## Working with Fields Sets Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available: #### Summary Fields Set The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request. ``` { "videos": [ "asset_family", "caption", "collection_code", "collection_name", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "license_model", "title" ] } ``` #### Detail Fields Set The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request. ``` { "videos": [ "allowed_use", "artist", "asset_family", "call_for_image", "caption", "clip_length", "collection_code", "collection_id", "collection_name", "color_type", "copyright", "date_created", "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ], "download_sizes", "era", "license_model", "mastered_to", "originally_shot_on", "product_types", "shot_speed", "source", "title" ] } ``` #### Display Fields Set The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request. ``` { "videos": [ "display_sizes": [ { "name": "comp" }, { "name": "preview" }, { "name": "thumb" } ] ] } ``` ## Request Usage Considerations - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

OnInit
./lib/actions/Videos_Get.js
OnStartup
-
OnClose
-

Attributes

-

Videos_GetSimilarVideos

OnInit
./lib/actions/Videos_GetSimilarVideos.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

Keine Daten für environment vorhanden