v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Items

List slot sections

Returns list of Slot Sections (a.k.a. frames) for given Slot. In case sections are needed from certain index, please provide that index as from cursor in paging object.

get/api/v2/teams/{team_slug}/items/{item_id}/slots/{slot_name}/sections

Path parameters

team_slugstring required

Team's sluggified name

item_idstring uuid required
Example:e23ff3f3-8f77-4e78-9e81-fdb25abfb781
slot_namestring required

'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1.

Example:0

'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1.

Query parameters

page[offset]integer

Defines how many items matching filters need to be skipped before returning result. Default value is 0.

Example:123
page[size]integer

Defines max number of items to return on single page. Default value is 500.

Example:500
page[to]string nullable

Page cursor on which to end the page. Page cursor consist of list of values that ends with UUID or integer

Example:2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE
page[from]string nullable

Page cursor from which to start the page. Page cursor consist of list of values that ends with UUID or integer

Example:2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE

Response

DatasetsV2.ItemManagement.ListSlotSectionsResponse

Example response

{
  "page": {
    "count": 500,
    "next": "2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE",
    "previous": "2020-01-13 00:00:00,EB03745E-6A66-4BA0-802D-DE8785ABFFFE"
  },
  "slot_sections": [
    {
      "height": 1080,
      "hq_url": "https://darwin-production-data.s3.eu-west-1.amazonaws.com/some-file.jpg?X-Amz-Signature=f0aa21e3d89ba4e7a7108eaf9873566ee5e0e3823bc5862fd3b0b9f1f44d15ac&X-Amz-Algorithm=AWS4-HMAC-SHA256",
      "lq_url": "https://darwin-production-data.s3.eu-west-1.amazonaws.com/some-file.jpg?X-Amz-Signature=f0aa21e3d89ba4e7a7108eaf9873566ee5e0e3823bc5862fd3b0b9f1f44d15ac&X-Amz-Algorithm=AWS4-HMAC-SHA256",
      "section_index": 1,
      "width": 1920
    }
  ]
}