Register Library Import

MUTATIONregisterLibraryImport(input: RegisterLibraryImportInput!): LibraryImport!

Access: Requires the music_tracks:write permission. Requires the music scheduling add-on.

Arguments

input*

Returns

registerLibraryImport

columnMapping?

completedAt?DateTime

DateTime custom scalar type that expects an ISO 8601 string

contentType?String

createdAt*DateTime!

DateTime custom scalar type that expects an ISO 8601 string

createdCount*Int!

errorMessage?String

failedCount*Int!

fileName*String!

id*ID!

processedRows*Int!

report?

shortId*String!

sizeBytes?Int

status*LibraryImportStatus!

Value inCOMPLETEDFAILEDIMPORTINGPENDINGREADY

targetLibrary?

totalRows?Int

unchangedCount*Int!

updatedAt?DateTime

DateTime custom scalar type that expects an ISO 8601 string

updatedCount*Int!

Example Request

mutation RegisterLibraryImport($input: RegisterLibraryImportInput!) {
  registerLibraryImport(input: $input) {
    columnMapping {
      album
      artist
      bpm
      cartId
      comments
      composer
      durationSeconds
      isrc
    }
    completedAt
    contentType
    createdAt
    createdCount
    errorMessage
    failedCount
    fileName
    id
    report {
      rows {
        cartId
        message
        rowNumber
        status
      }
    }
  }
}

mutation RegisterLibraryImport($input: RegisterLibraryImportInput!) {  registerLibraryImport(input: $input) {    columnMapping {      album      artist      bpm      cartId      comments      composer      durationSeconds      isrc    }    completedAt    contentType    createdAt    createdCount    errorMessage    failedCount    fileName    id    report {      rows {        cartId        message        rowNumber        status      }    }  }}

Variables

{
  "input": {
    "fileName": "string",
    "storageRef": "string"
  }
}

Variables

{  "input": {    "fileName": "string",    "storageRef": "string"  }}

Example Response

{
  "data": {
    "registerLibraryImport": {
      "columnMapping": {
        "album": "string",
        "artist": "string",
        "bpm": "string",
        "cartId": "string",
        "comments": "string",
        "composer": "string",
        "durationSeconds": "string",
        "isrc": "string"
      },
      "completedAt": "<DateTime>",
      "contentType": "string",
      "createdAt": "<DateTime>",
      "createdCount": 10,
      "errorMessage": "string",
      "failedCount": 10,
      "fileName": "string",
      "id": "1",
      "report": {
        "rows": [
          {
            "cartId": "string",
            "message": "string",
            "rowNumber": 10,
            "status": "CREATED"
          }
        ]
      }
    }
  }
}

Example Response

{  "data": {    "registerLibraryImport": {      "columnMapping": {        "album": "string",        "artist": "string",        "bpm": "string",        "cartId": "string",        "comments": "string",        "composer": "string",        "durationSeconds": "string",        "isrc": "string"      },      "completedAt": "<DateTime>",      "contentType": "string",      "createdAt": "<DateTime>",      "createdCount": 10,      "errorMessage": "string",      "failedCount": 10,      "fileName": "string",      "id": "1",      "report": {        "rows": [          {            "cartId": "string",            "message": "string",            "rowNumber": 10,            "status": "CREATED"          }        ]      }    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns