Development/Release Editor Seeding

From MusicBrainz Wiki
< Development
Revision as of 17:56, 19 July 2013 by Jesus2099 (talk | contribs) (Other data: textarea/multiline)

This page documents a list of parameters you can POST to the release editor to "seed" it. All values are optional unless otherwise stated.

To create a new release: http://musicbrainz.org/release/add

The MusicBrainz server includes an example which demonstrates seeding: seed-love-bug.html.

Release data

name
The name of the release. Non-empty string. Required
release_group
The MBID of the release group
comment
A disambiguation comment for the release. Non-empty string
annotation
Text to place in the releases annotation. Use a <textarea> / multi-line text
barcode
The barcode of the release. May be any valid barcode without whitespace
language
The language of the release. May be any valid ISO 639-2/T code (for example, eng, deu, jpn)
script
The script of the text on the release. May be any valid ISO 15924 code (for example, Latn, Cyrl)
status
The status of the release, as defined by MusicBrainz. Possible values: official, promotion, bootleg, pseudo
type
Ignore if you already specified release_group. The type of the release group, if a release group will be created. Possible values: album, single, ep, compilation, soundtrack, spokenword, interview, audiobook, live, remix, other (this can be specified multiple times to select multiple secondary types, though only one primary type should be specified)
packaging
The type of packaging of the release. Possible values: “jewel case”, “slim jewel case”, “digipak”, “cardboard/paper sleeve”, “other”, “keep case”

 Release events

A release can have zero, one or several release events. Each release event is composed of a date and a country. You must specify a positive integer for the x part of the field name to specify which release event referring to. For example: events.0.date.year & events.0.country or events.3.date.year & events.3.date.month & events.3.date.day & events.3.country_id

events.x.date.year
events.x.date.month
events.x.date.day
The date of the release event. Each field is an integer
events.x.country
The country of the release event. May be any valid country ISO code (for example, GB, US, FR)

But because of the ongoing MBS-6549 bug you have to temporarily use either country_id or Legacy described below work-arounds.

events.x.country_id
The country ID of the release event. This is an secret integer that you can find in release editor page’s source code or in line #150

Legacy release date and country

It is still possible to alternatively use the legacy single release event. It will act the same as if you describe only one real release event.

date.year
date.month
date.day
The date of the release. Each field is an integer
country
The country the release was released in. May be any valid country ISO code (for example, GB, US, FR)

Labels and catalog numbers

Releases may be associated with multiple labels and catalog numbers, so the fields for specifying these is a little different. You must specify a positive integer for the x part of the field name to specify which label/catalog number pair you are referring to. For example: label.0.mbid and label.0.catalog_number

labels.x.mbid
The MBID of the label
labels.x.catalog_number
The catalog number of this release, for label x
labels.x.name
The name of the label. If an MBID is present, this value is ignored

Artist credit

A release may be credited to multiple artists via what is known as an Artist Credit. To specify the artists a release is credited to, you can use the following fields:

artist_credit.names.x.mbid
The MBID of the artist. If omitted you will be able to either create the artist in the release editor, or search MusicBrainz for this artist
artist_credit.names.x.name
The name of the artist, as credited on the release. Optional, if omitted it will default to the artist’s current name
artist_credit.names.x.artist.name
The name of the artist as it is usually referred too. Optional if you already specified both credited name and MBID
artist_credit.names.x.join_phrase
An optional phrase to join this artist with the next artist. For example, you could use “ & ” to join “Calvin” with “Hobbes” to get the final text “Calvin & Hobbes”

Tracklist

As with labels above, there may be multiple mediums and tracklists which themselves may contain multiple tracks, so again you will need to fill in the x and y parameters accordingly. As with others, x and y are 0-indexed. Values for x must be in consecutive order starting with 0; with at least 1 track for each medium.

Mediums

mediums.x.format
Any valid medium format name: you can find the possible values in the release editor page’s source code
mediums.x.position
The position of this medium in the list of mediums. If omitted, it will be inferred from the order of all mediums passed in (which is normally what you want)
mediums.x.name
The name of medium x (for example "Live & Unreleased")

Tracks

mediums.x.track.y.name
The name of track y on medium x
mediums.x.track.y.number
The free-form track number of track y on medium x
mediums.x.track.y.recording
The MBID of an existing recording in the database which should be associated with track y on medium x
mediums.x.track.y.length
The tracks duration, in MM:SS form or a single integer as milliseconds
Track artist credits

Refer to release artist credit, as track artist credits share the same syntax. Here too you can have z artists (the first being 0 again).

mediums.x.track.y.artist_credit.names.z.mbid
mediums.x.track.y.artist_credit.names.z.name
mediums.x.track.y.artist_credit.names.z.artist.name
mediums.x.track.y.artist_credit.names.z.join_phrase

Other data

edit_note
Specify the content of the edit note. Use a <textarea> / multi-line text