Skip to content
Developers

List code graphics

GET/v2/themes/{themeId}/code-graphics

GET
/v2/themes/{themeId}/code-graphics
curl --request GET \
  --url https://api.ligr.live/rest/v2/themes/1/code-graphics \
  --header 'Authorization: Bearer <token>'

Beta. This operation can change between minor versions. See Beta status.

Returns the working copy of every code graphic in the theme. The response leaves out the Rive graphics of the theme.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
themeId
required

Entity identifier

integer format: int32
>= 1

The theme identifier

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
Array<object>

A working code graphic.

id is the row identifier of the working copy. It changes on every publish. stateMachine holds the runtime, the control variables and the user expressions. lock is null when no one holds the graphic.

object
graphicId
required

Stable graphic identifier. It does not change between versions.

string
id
required

Entity identifier

integer format: int32
>= 1
name
required
string
type
required
string
Allowed values: code
version
required

Version number of the editable working copy.

integer format: int32
sports
required
Array<string>
stateMachine
required

Runtime, control variables and user expressions of a code graphic.

The index signature keeps the keys. tsoa strips every key of a Record<string, unknown>, because that type declares no properties.

object
key
additional properties
assets
required

Files of the bundle, sorted by name.

Array<object>
object
name
required

Path of the file inside the bundle, for example assets/app.js.

string
mime
required

Content type recorded for the file.

string
size
required

Size of the file in bytes.

integer format: int32
hash
required

Content hash the client sent. Compare it to skip an unchanged upload.

string
version
required

Revision counter of this file. It increases every time the hash changes.

integer format: int32
updatedAt
required

Time of the last change, in ISO 8601.

string
publishedVersions
required

Published version numbers, in ascending order.

Array<integer>
lock
required
object
userName
required

Name of the lock holder. An API key shows as API key <name>.

string
Example
[
  {
    "type": "code"
  }
]

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Theme or graphic not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}