Glossary
Note that the property names may change slightly in different API libraries.
Space
A space represents a collection of people and assets in Lingo. Each API token is created for a particular Space and is limited to accessing content within that Space.
Because API access is restricted to a space, they are never returned.
Kit
A kit contains a collection of assets which are organized in sections. In Lingo, access controls can be configured at this level, giving members of a space users access to individual kits.
All other objects below are all fetched within a kit.
This screenshot shows the kits as they appear in Lingo.
| Properties | |
|---|---|
| kit_uuidstring | The unique identifier for the kit |
| space_idnumber | The id of the space that owns the kit. |
| namestring | The name of the kit. |
| statusstring | The status of the kit (always active). |
| use_versionstring | The recommended version of the kit. |
| imagesobject | If set, an object containing the cover image for the kit. |
Kit Version
Multiple version of a kit can be created.
Every kit always has a “Shared Draft” which is version 0. In Lingo only the Shared Draft can be updated, all other versions (1+) are immutable snapshots of the kit at the time the version is created.
| Properties | |
|---|---|
| kit_uuidstring | The unique identifier for the kit the version is in |
| versionnumber | The numeric version. |
| version_identifierstring | A string identifier of the version. |
| notesstring | Release notes provided for the version. |
| statusstring | The status of the version (always active). |
| countsobject | Counts of items, assets, and sections in this version. |
Kit Outline
A kit outline provides an overview of the contents of kit version. It is a list of sections each of which include headings in that section.
The outline is the only way to fetch the full list of Sections in a kit.
The outline is used by Lingo to populate the kit navigator shown here. Notice below how the Headings in Lingo are displaying inline with other content as well as in the kit navigator under the section.
| Properties | |
|---|---|
| kit_versionKit Version | The version the outline represents |
| sections[ Section ] | An array of sections in the version. |
Section
A kit contains a collection of assets which are organized in sections.
| Properties | |
|---|---|
| uuidstring | The unique identifier for the kit |
| versionnumber | The numeric version the section belongs to. |
| namestring | The name of the kit. |
| display_ordernumber | A relative order of the section in the version. |
| statusstring | The status of the section (always active). |
| counts[string:number] | Counts of items, assets in the section. |
| headers[ Heading ] | When fetching an outline, a section will contain a list of headings. |
Outline Heading
A heading is special type of item that can be used to create a visual hierarchy within Lingo. Because headings are a type of Item, they are also inlcuded when fetching content in a section.
When included in the Kit Outline, headings are represented by a subset of the data provided when fetching items within a section.
| Properties | |
|---|---|
| uuidstring | The unique identifier for the heading item |
| versionnumber | The version number of the heading. |
| namestring | The text of the heading. |
| display_ordernumber | A relative order of the item within the section. |
Item
A kit contains a collection of items which are organized in sections.
There are a few types of items:
- Asset: A file or color that is intended to be used by consumers of the kit
- Supporting Image: Non-usable images typically used to provide context to the assets.
- Inline Note: A note displayed inline with other content
- Heading: Larger text used to create separation between groups of content
Both asset and supporting image items represent an associated asset object while inline note and heading items display text content embeded in their data attribute.
In Javascript, accessing text item content this looks like:
const item = ... // fetched inline note
item.type; // inline_note
const note = item.data.content;
| Properties | |
|---|---|
| uuidstring | The unique identifier for the item |
| kit_uuidnumber | The id of the kit the item is in. |
| section_uuidstring | the id of the section the item is in. |
| versionnumber | The version number of the item. |
| statusstring | The status of the item (always active). |
| display_ordernumber | A relative order of the item in the section. |
typeasset, inline_note, heading, supporting_image |
A relative order of the item in the section. |
| asset_uuidstring or null | If type is asset or supporting_image, the uuid of the asset. |
| assetAsset | If type is asset or supporting_image, the data for the asset. |
| dataobject | For headings and inline notes, access the text with data.content. |
Asset
Assets represent the visual content of Lingo. Typically this is a file but in some cases assets are stored as data (i.e. colors).
Assets themselves have no relationship to a kit. [Item] objects manage that relationship. It may be important to note that a single asset can have multiple items in the same or different kits; In Lingo those we call those References.
| Properties | |
|---|---|
| uuidstring | The unique identifier for the kit |
| typeAssetType | The id of the space that owns the kit. |
| namestring | The name of the asset. |
| notesstring | Notes for the asset, if any. |
| keywordsstring | A comma separated list of keywords. |
| colors[ Color ] | An array of colors for COLOR assets. |
| file_hashstring | A hash of the asset file (or color). |
| file_idstring | A unique identifier of the file. |
| sizenumber | The size of the file in bytes, if any, otherwise 0. |
Color
Color assets contain a list of colors. Colors are stored in HSBA.
| Properties | |
|---|---|
| namestring | The unique identifier for the kit |
| huenumber | The hue value of the color (0-360). |
| saturationnumber | The saturation value of the color (0-100). |
| brightnessnumber | The brightness value of the color (0-100). |
| alphanumber | The alpha value of the color (0-100). |
AssetType
| File Type | Type |
|---|---|
| SVG | SVG |
| JPG | JPG |
| PNG | PNG |
| GIF | GIF |
| EPS | EPS |
| EPS | EPS |
| TIFIF | TIFF |
| Text Style | TEXT_STYLE |
| PowerPoint | PPTX |
| PowerPoint Template | POTX |
| Word Document | DOCX |
| Word Template | DOTX |
| Keynote | KEYNOTE |
| Keynote Theme | KEYNOTE_THEME |
| Pages Document | PAGES |
| Pages Template | PAGES_TEMPLATE |
| Photoshop Document | PSD |
| Illustrator | AI |
| Sketch Symbol | SKETCH_SYMBOL |
| Sketch Layer (e.g. artboard) | SKETCH_LAYER |
| Sketch Layer Style | SKETCH_LAYER_STYLE |
| Sketch Text Style | SKETCH_TEXT_STYLE |
| Color | COLOR |
Last update: 2019-05-22 11:59:46 -0700