action gettyimages_get_v3_images_id_same_series {
  label: "Retrieve creative images from the same series"
  description: "This endpoint will provide the list of images, if any exist, from the same series as the specified creative asset id. These images are typically from the same photo shoot. This functionality will not work for editorial assets.\n\nYou'll need an API key and access token to use this resource.\n\n## Working with Fields Sets\n\nFields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:\n\n#### Summary Fields Set\n\nThe **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build\nsearch response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.\n\n```\n{\n    \"images\":\n    [\n        \"asset_family\",\n        \"caption\",\n        \"collection_code\",\n        \"collection_id\",\n        \"collection_name\",\n        \"display_sizes\": \n        [\n            {\n                \"name\": \"thumb\"\n            }\n        ]\n        \"license_model\",\n        \"max_dimensions\",\n        \"title\"\n    ]\n}\n```\n\n#### Detail Fields Set\n\nThe **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a \ndetailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.\n\n```\n{\n    \"images\":\n    [\n        \"allowed_use\",\n        \"artist\",\n        \"asset_family\",\n        \"call_for_image\",\n        \"caption\",\n        \"collection_code\",\n        \"collection_id\",\n        \"collection_name\",\n        \"copyright\",\n        \"date_created\",\n        \"display_sizes\": \n        [\n            {\n                \"name\": \"comp\"\n            },\n            {\n                \"name\": \"preview\"\n            },\n            {\n                \"name\": \"thumb\"\n            }\n        ],\n        \"editorial_segments\",\n        \"event_ids\",\n        \"graphical_style\",\n        \"license_model\",\n        \"max_dimensions\",\n        \"orientation\",\n        \"product_types\",\n        \"quality_rank\",\n        \"referral_destinations\",\n        \"title\"\n    ]\n}\n```\n\n#### Display Fields Set\n\nThe **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files \nthat are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result\nset when you include **display_set** in your request.\n\nThe URI provided is subject to change at any time and must be used as-is with no modification.\n\n```\n{\n    \"images\":\n    [\n        \"display_sizes\": \n        [\n            {\n                \"is_watermarked\": <boolean>,\n                \"name\": \"comp\",\n                \"uri\": \"<link>\"\n            },\n            {\n                \"is_watermarked\": <boolean>,\n                \"name\": \"preview\",\n                \"uri\": \"<link>\"\n            },\n            {\n                \"is_watermarked\": <boolean>,\n                \"name\": \"thumb\",\n                \"uri\": \"<link>\"\n            }\n        ]\n    ]\n}\n```\n"
  provider: gettyimages
  method: GET
  path: "/v3/images/{id}/same-series"
  encoding: json
  input: {
    type: "object"
    properties: {
      "Accept-Language": {
        type: "string"
        description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
      }
      fields: {
        type: "array"
        description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
        items: {
          type: "string"
          enum: ["accessrestriction", "allowed_use", "alternative_ids", "artist", "asset_family", "call_for_image", "caption", "collection_code", "collection_id", "collection_name", "color_type", "comp", "copyright", "date_camera_shot", "date_created", "date_submitted", "detail_set", "display_set", "download_product", "download_sizes", "editorial_segments", "editorial_source", "entity_details", "event_ids", "graphical_style", "id", "istock_collection", "keywords", "largest_downloads", "license_model", "max_dimensions", "orientation", "people", "preview", "product_types", "quality_rank", "referral_destinations", "summary_set", "thumb", "title", "uri_oembed"]
        }
      }
      id: {
        type: "string"
        description: "Identifies an existing image"
      }
      page: {
        type: "integer"
        format: "int32"
        description: "Identifies page to return. Default is 1."
      }
      page_size: {
        type: "integer"
        format: "int32"
        description: "Specifies page size. Default is 30, maximum page_size is 100."
      }
    }
    required: ["id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      images: {
        type: "array"
        items: {
          type: "object"
          properties: {
            allowed_use: {
              type: "object"
              properties: {
                how_can_i_use_it: {
                  type: "string"
                  description: "Indicates how the asset can be used"
                }
                release_info: {
                  type: "string"
                  description: "Indicates release status"
                }
                usage_restrictions: {
                  type: "array"
                  description: "Indicates asset usage restriction, if any"
                  items: {
                    type: "string"
                  }
                }
              }
              additionalProperties: false
            }
            alternative_ids: {
              type: "object"
            }
            artist: {
              type: "string"
            }
            asset_family: {
              type: "string"
            }
            call_for_image: {
              type: "boolean"
            }
            caption: {
              type: "string"
            }
            collection_code: {
              type: "string"
            }
            collection_id: {
              type: "integer"
              format: "int32"
            }
            collection_name: {
              type: "string"
            }
            color_type: {
              type: "string"
            }
            copyright: {
              type: "string"
            }
            date_camera_shot: {
              type: "string"
              format: "date-time"
            }
            date_created: {
              type: "string"
              format: "date-time"
            }
            display_sizes: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  is_watermarked: {
                    type: "boolean"
                  }
                  name: {
                    type: "string"
                  }
                  uri: {
                    type: "string"
                  }
                }
                additionalProperties: false
              }
            }
            download_product: {
              type: "string"
            }
            editorial_segments: {
              type: "array"
              items: {
                type: "string"
              }
            }
            event_ids: {
              type: "array"
              items: {
                type: "integer"
                format: "int32"
              }
            }
            graphical_style: {
              type: "string"
            }
            id: {
              type: "string"
            }
            istock_licenses: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  credits: {
                    type: "integer"
                    format: "int32"
                  }
                  license_type: {
                    type: "string"
                    enum: ["Standard", "Multiseat", "Unlimited", "Resale", "Indemnification"]
                  }
                }
                additionalProperties: false
              }
            }
            keywords: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  entity_types: {
                    type: "array"
                    items: {
                      type: "string"
                    }
                  }
                  entity_uris: {
                    type: "array"
                    items: {
                      type: "string"
                    }
                  }
                  keyword_id: {
                    type: "string"
                  }
                  relevance: {
                    type: "integer"
                    format: "int32"
                  }
                  text: {
                    type: "string"
                  }
                  type: {
                    type: "string"
                  }
                }
                additionalProperties: false
              }
            }
            largest_downloads: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  agreement_name: {
                    type: "string"
                  }
                  product_id: {
                    type: "string"
                  }
                  product_type: {
                    type: "string"
                  }
                  uri: {
                    type: "string"
                  }
                }
                additionalProperties: false
              }
            }
            license_model: {
              type: "string"
            }
            max_dimensions: {
              type: "object"
              properties: {
                height: {
                  type: "integer"
                  format: "int32"
                }
                width: {
                  type: "integer"
                  format: "int32"
                }
              }
              additionalProperties: false
            }
            orientation: {
              type: "string"
            }
            people: {
              type: "array"
              items: {
                type: "string"
              }
            }
            product_types: {
              type: "array"
              items: {
                type: "string"
              }
            }
            quality_rank: {
              type: "integer"
              format: "int32"
            }
            referral_destinations: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  site_name: {
                    type: "string"
                  }
                  uri: {
                    type: "string"
                  }
                }
                additionalProperties: false
              }
            }
            title: {
              type: "string"
            }
            uri_oembed: {
              type: "string"
            }
          }
          additionalProperties: false
        }
      }
      related_searches: {
        type: "array"
        items: {
          type: "object"
          properties: {
            phrase: {
              type: "string"
            }
            url: {
              type: "string"
            }
          }
          additionalProperties: false
        }
      }
      result_count: {
        type: "integer"
        format: "int32"
      }
    }
    additionalProperties: false
  }
}