Skip to main content
Skip table of contents

Image Metadata

Image metadata is information about origin images provided by an operator directly.

An operator may use this API to provide IHS with the locations of origin images, and to subsequently update or delete this information.

IHS will look for these records in the first instance when considering where to find origin images to resize.

Put Request

To update an image metadata in IHS , send a PUT request to:

http://<host>:<port>/ihs/v1/metadata

Headers

  • Content-Type: application/json

Mandatory arguments

  • None

Body

Click here to expand...
[
{
"status":"active",
"imageId":"p183996_i_h6_ab",
"resourceId":"GLOBAL_EP000174760081",
"resourceType":"programs",
"externalSource":"GN-GVD",
"externalResourceId":"EP000174760081",
"height":270,
"width":480,
"uri":"http://10.176.226.230/assets/p183996_i_h13_aa.jpg",
"aspect":"16x9",
"category":"Iconic",
"text":false,
"primary":true,
"orientation":"orientation",
"captions":[
{
"title":"stelle Getty, Beatrice Arthur, Rue McClanahan and Betty White (from left)",
"locale":"en_GB"
},
{
"title":"stelle Getty, Beatrice Arthur, Rue McClanahan and Betty White (from left)",
"locale":"en_US"
}
]
}
]


Get Request

To get an image metadata from IHS , send a GET request to:

http://<host>:<port>/ihs/v1/metadata

Headers

  • Content-Type: application/json

Arguments

  • limit   
  • page
  • filter          - a json filter
  • sort           - sort order
  • projection - the fields to return

Example 

/ihs/v/metadata?filter={"resourceType":"programs"}&sort={"height":1}&limit=6&page=2&{"status":0,"imageId":0}

Response

Body

Click here to expand...
{
"totalRecords": 1,
"imagesMetadata":
[
{
"status":"active",
"imageId":"p183996_i_h6_ab",
"resourceId":"GLOBAL_EP000174760081",
"resourceType":"programs",
"externalSource":"GN-GVD",
"externalResourceId":"EP000174760081",
"height":270,
"width":480,
"uri":"http://10.176.226.230/assets/p183996_i_h13_aa.jpg",
"aspect":"16x9",
"category":"Iconic",
"text":false,
"primary":true,
"orientation":"orientation",
"captions":[
{
"title":"stelle Getty, Beatrice Arthur, Rue McClanahan and Betty White (from left)",
"locale":"en_GB"
},
{
"title":"stelle Getty, Beatrice Arthur, Rue McClanahan and Betty White (from left)",
"locale":"en_US"
}
]
}
]
}

See also

For full details of this API, see Image Handler Service (IHS) API documentation.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.