Retrieve a chart

This endpoint retrieves the metadata that is shared between the published and draft versions of a chart (id, key, status, archived etc).

Text

GET https://api-{region}.seatsio.net/charts/{key}

GET https://api-{region}.seatsio.net/charts/{key}?expand=events

PHP

$seatsioClient->charts->retrieve("749b9650-24fb-11e7-93ae-92361f002671");

$seatsioClient->charts->retrieveWithEvents("749b9650-24fb-11e7-93ae-92361f002671");

C#

await Client.Charts.RetrieveAsync("749b9650-24fb-11e7-93ae-92361f002671"));

await Client.Charts.RetrieveAsync("749b9650-24fb-11e7-93ae-92361f002671", expandEvents: true));

Java

client.charts.retrieve("749b9650-24fb-11e7-93ae-92361f002671");

client.charts.retrieveWithEvents("749b9650-24fb-11e7-93ae-92361f002671");

Python

client.charts.retrieve("749b9650-24fb-11e7-93ae-92361f002671")

client.charts.retrieve_with_events("749b9650-24fb-11e7-93ae-92361f002671")

Ruby

client.charts.retrieve('749b9650-24fb-11e7-93ae-92361f002671')

client.charts.retrieve_with_events('749b9650-24fb-11e7-93ae-92361f002671')

Javascript

await client.charts.retrieve('749b9650-24fb-11e7-93ae-92361f002671');

await client.charts.retrieveWithEvents('749b9650-24fb-11e7-93ae-92361f002671');

Go

chart, err := client.Charts.Retrieve("749b9650-24fb-11e7-93ae-92361f002671")

chart, err := client.Charts.RetrieveWithEvents("749b9650-24fb-11e7-93ae-92361f002671")

Query parameters

• expand (optional) A chart can have events linked to it. By adding expand=events, the events are returned in the 'events' field in the response.

Example

curl https://api-{region}.seatsio.net/charts/749b9650-24fb-11e7-93ae-92361f002671 \
-u aSecretKey:

The response is a JSON object that represents the chart:

{
    "name":"chart2",
    "id":"19",
    "key":"749b9650-24fb-11e7-93ae-92361f002671",
    "status":"NOT_USED",
    "archived": false,
    "tags": ['tag1', 'tag2'],
    "publishedVersionThumbnailUrl": "https://thumbnails.seats.io/workspaceKey/.../published/.../thumbnail"
  }
}

status can take the following values:

• NOT_USED: there's no event yet for the chart
• PUBLISHED: there's an event for the chart, and there's no draft version
• PUBLISHED_WITH_DRAFT: there's an event for the chart, and there's a draft version

And with expand=events, it includes the events:

{
    "name":"chart2",
    "id":"19",
    "key":"749b9650-24fb-11e7-93ae-92361f002671",
    "status":"NOT_USED",
    "archived": false,
    "tags": ['tag1', 'tag2'],
    "publishedVersionThumbnailUrl": "https://thumbnails.seats.io/workspaceKey/.../published/.../thumbnail",
    "events": [
        {
            "id": "50",
            "bookWholeTables": false,
            "key": "eventKey2"
        },
        {
            "id": "49",
            "bookWholeTables": false,
            "key": "event34"
        }
    ]
}

Error 404 (Not Found) is returned when the chart does not exist.