ImportTask

List ImportTask

GET https://api.idol.io/api/v2/import-tasks

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": [
    {
      "id": "<ID>",
      "type": "import-tasks",
      "links": {
        "self": "http://api.idol.io/api/v2/import-tasks/<ID>"
      },
      "attributes": {
        "created-at": "2019-03-22T12:26:32.113+01:00",
        "updated-at": "2019-03-22T12:26:32.113+01:00",
        "precision": "16",
        "master-type": "cd",
        "support-number": null,
        "status": "completed",
        "url": 'https://<download_record_url>',
        "message": null,
        "md5": "82ec2f5bc5372ef72332606fa74209d1"
      },
      "relationships": {
        "product": {
          "links": {
            "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/product",
            "related": "http://api.idol.io/api/v2/import-tasks/<ID>/product"
          },
          "data": {
            "type": "products",
            "id": "<ID>"
          }
        },
        "track": {
          "links": {
            "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/track",
            "related": "http://api.idol.io/api/v2/import-tasks/<ID>/track"
          },
          "data": {
            "type": "tracks",
            "id": "<ID>"
          }
        },
        "video": {
          "links": {
            "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/video",
            "related": "http://api.idol.io/api/v2/import-tasks/<ID>/video"
          },
          "data": {
            "type": "videos",
            "id": "<ID>"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "import-tasks",
      "links": {
        "self": "http://api.idol.io/api/v2/import-tasks/<ID>"
      },
      "attributes": {
        "created-at": "2019-03-22T12:26:32.363+01:00",
        "updated-at": "2019-03-22T12:26:32.363+01:00",
        "precision": "16",
        "master-type": "cd",
        "support-number": null,
        "status": "uploaded",
        "cover-url": "/dragonfly/W1siZiIsIjIwMTkvMDMvMjIvUG9jaGV0dGUgQWxidW0vcmdiMjAxOTAzMjItMzg3OC0xM21pNWU3LmpwZ18xNTUzMjUzOTgyLjQ5NDgwMzIuanBnIl0sWyJwIiwidGh1bWIiLCIzMDB4MzAwIyIseyJmb3JtYXQiOiJqcGcifV1d.jpg?sha=b488283aa2bc62af",
        "url": "http://hettinger.net/reyes_purdy",
        "message": null
      },
      "relationships": {
        "product": {
          "links": {
            "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/product",
            "related": "http://api.idol.io/api/v2/import-tasks/<ID>/product"
          },
          "data": {
            "type": "products",
            "id": "<ID>"
          }
        },
        "track": {
          "links": {
            "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/track",
            "related": "http://api.idol.io/api/v2/import-tasks/<ID>/track"
          },
          "data": {
            "type": "tracks",
            "id": "<ID>"
          }
        },
        "video": {
          "links": {
            "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/video",
            "related": "http://api.idol.io/api/v2/import-tasks/<ID>/video"
          },
          "data": {
            "type": "videos",
            "id": "<ID>"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 2,
    "page-count": 1
  },
  "links": {
    "first": "http://api.idol.io/api/v2/import-tasks?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "http://api.idol.io/api/v2/import-tasks?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Filter resources

Product

api/v2/import-tasks?filter[product-id]=1

Distributor

api/v2/import-tasks?filter[distributor-id]=1

Get ImportTask

GET https://api.idol.io/api/v2/import-tasks/:id

Path Parameters

Name	Type	Description
id*	number	ID of the ImportTask

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": {
    "id": "<ID>",
    "type": "import-tasks",
    "links": {
      "self": "http://api.idol.io/api/v2/import-tasks/1"
    },
    "attributes": {
      "created-at": "2019-03-22T12:26:32.113+01:00",
      "updated-at": "2019-03-22T12:26:32.113+01:00",
      "precision": "16",
      "master-type": "cd",
      "support-number": null,
      "status": "completed",
      "url": 'https://<download_record_url>',
      "message": null,
      "md5": "82ec2f5bc5372ef72332606fa74209d1"
    },
    "relationships": {
      "product": {
        "links": {
          "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/product",
          "related": "http://api.idol.io/api/v2/import-tasks/<ID>/product"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      },
      "track": {
        "links": {
          "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/track",
          "related": "http://api.idol.io/api/v2/import-tasks/<ID>/track"
        },
        "data": {
          "type": "tracks",
          "id": "<ID>"
        }
      },
      "video": {
        "links": {
          "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/video",
          "related": "http://api.idol.io/api/v2/import-tasks/<ID>/video"
        },
        "data": {
          "type": "videos",
          "id": "<ID>"
        }
      }
    }
  }
}

Create ImportTask

POST https://api.idol.io/api/v2/import-tasks

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
master-type*	string	cd, hd or dolby_atmos
track	object	Track Object
product*	object	Product Object
video	object	Video Object
precision	number	16 or 24 (bit)
status	string	uploaded
url	string	The secured url where the audio / video files was imported
md5	string	md5 checksum of the file

200

{
  "data": {
    "id": <ID>,
    "type": "import-tasks",
    "links": {
        "self": "http://api.idol.io/api/v2/import-tasks/3"
    },
    "attributes": {
        "created-at": "2019-03-22T16:33:38.866+01:00",
        "updated-at": "2019-03-22T16:33:38.866+01:00",
        "precision": "24",
        "master-type": "hd",
        "support-number": null,
        "status": "uploaded",
        "url": 'https://<download_record_url>',
        "message": null
    },
    "relationships": {
        "product": {
            "links": {
                "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/product",
                "related": "http://api.idol.io/api/v2/import-tasks/<ID>/product"
            },
            "data": {
                "type": "products",
                "id": "<ID>"
            }
        },
        "track": {
            "links": {
                "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/track",
                "related": "http://api.idol.io/api/v2/import-tasks/<ID>/track"
            },
            "data": {
                "type": "tracks",
                "id": "<ID>"
            }
        },
        "video": {
            "links": {
                "self": "http://api.idol.io/api/v2/import-tasks/<ID>/relationships/video",
                "related": "http://api.idol.io/api/v2/import-tasks/<ID>/video"
            },
            "data": {
                "type": "videos",
                "id": "<ID>"
            }
        }
    }
  }
}

Creating an upload ImportTask launches a job that will :

• Retrieve the file stored on the url provided

• Check the md5 checksum if present

• Create a record associated to the track if provided

• Update the associated video if it exists

• Change the status of the import-task to completed

Find more information about audio specifications in this Help Center's article.