Create a new revision

v1.0.0

Update a score by uploading a new revision for this one.

Input

{
  "type": "object",
  "description": "A new created revision",
  "required": [
    "data"
  ],
  "properties": {
    "autosave": {
      "type": "boolean",
      "description": "Must be set to `true` if the revision was created automatically.\n"
    },
    "data": {
      "type": "string",
      "description": "The data of the score file. It must be a MusicXML 3 file (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`), a MIDI file (`audio/midi`) or a Flat.json (aka Adagio.json) file.\nBinary payloads (`vnd.recordare.musicxml` and `audio/midi`) can be encoded in Base64, in this case the `dataEncoding` property must match the encoding used for the API request.\n"
    },
    "dataEncoding": {
      "type": "string",
      "description": "The optional encoding of the score data. This property must match the encoding used for the `data` property.",
      "enum": [
        "base64"
      ]
    },
    "description": {
      "type": "string",
      "description": "A description associated to the revision"
    }
  }
}

Output

{
  "type": "object",
  "description": "A score revision metadata",
  "properties": {
    "autosave": {
      "type": "boolean",
      "description": "True if this revision was automatically generated by Flat and not on\npurpose by the user.\n"
    },
    "collaborators": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "The list of user identifier or collaborators who worked on this\nrevision. This is list is built from the history of the revision\nspecified during the creation of the revision.\n"
      }
    },
    "creationDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date when this revision was created"
    },
    "description": {
      "type": "string",
      "description": "A description associated to the revision"
    },
    "event": {
      "type": "string",
      "description": "The last event (action id) of the revision"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of the revision."
    },
    "statistics": {
      "type": "object",
      "description": "The statistics related to the score revision (additions and deletions)\n",
      "properties": {
        "additions": {
          "type": "number",
          "description": "The number of additions operations in the last revision"
        },
        "deletions": {
          "type": "number",
          "description": "The number of deletions operations in the last revision"
        }
      }
    },
    "user": {
      "type": "string",
      "description": "The user identifier who created the revision"
    }
  }
}