Right

List Rights

GET https://api.idol.io/api/v2/rights

Headers

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

200

{
  "data": [
    {
      "id": "<ID>",
      "type": "rights",
      "links": {
        "self": "https://api.idol.io/api/v2/rights/<ID>"
      },
      "attributes": {
        "action": "add",
        "comments": null,
        "created-at": "2024-10-10T16:06:17.000+02:00",
        "updated-at": "2024-10-10T16:06:17.000+02:00",
        "created-by": "[email protected]",
        "updated-by": "[email protected]",
        "user-email": null,
        "computed-dsps": "iTunes + Soudncloud + Spotify",
        "computed-territories": "WW"
      },
      "relationships": {
        "distributor": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributor",
            "related": "https://api.idol.io/api/v2/rights/<ID>/distributor"
          },
          "data": {
            "type": "distributors",
            "id": "<ID>"
          }
        },
        "distributed": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributed",
            "related": "https://api.idol.io/api/v2/rights/<ID>/distributed"
          },
          "data": {
            "type": "companies",
            "id": "<ID>"
          }
        },
        "dsps": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/dsps",
            "related": "https://api.idol.io/api/v2/rights/<ID>/dsps"
          }
        },
        "minus-dsps": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-dsps",
            "related": "https://api.idol.io/api/v2/rights/<ID>/minus-dsps"
          }
        },
        "minus-right-dsp-tags": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-right-dsp-tags",
            "related": "https://api.idol.io/api/v2/rights/<ID>/minus-right-dsp-tags"
          }
        },
        "right-dsp-tags": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/right-dsp-tags",
            "related": "https://api.idol.io/api/v2/rights/<ID>/right-dsp-tags"
          }
        },
        "territories": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/territories",
            "related": "https://api.idol.io/api/v2/rights/<ID>/territories"
          }
        },
        "minus-territories": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-territories",
            "related": "https://api.idol.io/api/v2/rights/<ID>/minus-territories"
          }
        },
        "continents": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/continents",
            "related": "https://api.idol.io/api/v2/rights/<ID>/continents"
          }
        },
        "minus-continents": {
          "links": {
            "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-continents",
            "related": "https://api.idol.io/api/v2/rights/<ID>/minus-continents"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 1879,
    "page-count": 1879
  },
  "links": {
    "first": "https://api.idol.io/api/v2/rights?page%5Bnumber%5D=1&page%5Bsize%5D=1",
    "next": "https://api.idol.io/api/v2/rights?page%5Bnumber%5D=2&page%5Bsize%5D=1",
    "last": "https://api.idol.io/api/v2/rights?page%5Bnumber%5D=1879&page%5Bsize%5D=1"
  }
}

Filter resources

Products

api/v2/rights?filter[product-ids]=1,2

Labels

api/v2/rights?filter[label-ids]=1,2

Companies

api/v2/rights?filter[company-ids]=1,2

Get Right

GET https://api.idol.io/api/v2/rights/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Right

Headers

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

200

{
  "data": {
    "id": "<ID>",
    "type": "rights",
    "links": {
      "self": "https://api.idol.io/api/v2/rights/<ID>"
    },
    "attributes": {
      "action": "add",
      "comments": null,
      "created-at": "2018-07-18T18:53:38.917+02:00",
      "updated-at": "2018-07-18T18:53:38.911+02:00",
      "created-by": "[email protected]",
      "updated-by": "[email protected]",
      "user-email": "[email protected]",
      "computed-dsps": "Spotify",
      "computed-territories": "France + Belgium"
    },
    "relationships": {
      "distributor": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributor",
          "related": "https://api.idol.io/api/v2/rights/<ID>/distributor"
        },
        "data": {
          "type": "distributors",
          "id": "<ID>"
        }
      },
      "distributed": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributed",
          "related": "https://api.idol.io/api/v2/rights/<ID>/distributed"
        },
        "data": {
          "type": "companies",
          "id": "<ID>"
        }
      },
      "dsps": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/dsps",
          "related": "https://api.idol.io/api/v2/rights/<ID>/dsps"
        }
      },
      "minus-dsps": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-dsps",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-dsps"
        }
      },
      "minus-right-dsp-tags": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-right-dsp-tags",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-right-dsp-tags"
        }
      },
      "right-dsp-tags": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/right-dsp-tags",
          "related": "https://api.idol.io/api/v2/rights/<ID>/right-dsp-tags"
        }
      },
      "territories": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/territories",
          "related": "https://api.idol.io/api/v2/rights/<ID>/territories"
        }
      },
      "minus-territories": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-territories",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-territories"
        }
      },
      "continents": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/continents",
          "related": "https://api.idol.io/api/v2/rights/<ID>/continents"
        }
      },
      "minus-continents": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-continents",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-continents"
        }
      }
    }
  }
}

Create Right

POST https://api.idol.io/api/v2/rights

Headers

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

Request Body

Name	Type	Description
distributed*	object	Polymorphic - Product / Label / Company Object
dsps	object	Dsp Object
minus-dsps	object	Dsp Object
territories	object	Territory Object
minus-territories	object	Territory Object
continents	object	Continent Object
minus-continents	object	Continent Object
right-dsp-tags	object	DspTag object
minus-right-dsp-tags	object	DspTag object
action*	string	add / remove / clear
comments	string	Acls object
user-email*	string	[email protected]

200

{
  "data": {
    "id": "<ID>",
    "type": "rights",
    "links": {
      "self": "https://api.idol.io/api/v2/rights/<ID>"
    },
    "attributes": {
      "action": "add",
      "comments": null,
      "created-at": "2018-07-18T18:53:38.917+02:00",
      "updated-at": "2018-07-18T18:53:38.911+02:00",
      "created-by": "[email protected]",
      "updated-by": "[email protected]",
      "user-email": "[email protected]",
      "computed-dsps": "Spotify",
      "computed-territories": "France + Belgium"
    },
    "relationships": {
      "distributor": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributor",
          "related": "https://api.idol.io/api/v2/rights/<ID>/distributor"
        },
        "data": {
          "type": "distributors",
          "id": "<ID>"
        }
      },
      "distributed": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributed",
          "related": "https://api.idol.io/api/v2/rights/<ID>/distributed"
        },
        "data": {
          "type": "companies",
          "id": "<ID>"
        }
      },
      "dsps": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/dsps",
          "related": "https://api.idol.io/api/v2/rights/<ID>/dsps"
        }
      },
      "minus-dsps": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-dsps",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-dsps"
        }
      },
      "minus-right-dsp-tags": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-right-dsp-tags",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-right-dsp-tags"
        }
      },
      "right-dsp-tags": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/right-dsp-tags",
          "related": "https://api.idol.io/api/v2/rights/<ID>/right-dsp-tags"
        }
      },
      "territories": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/territories",
          "related": "https://api.idol.io/api/v2/rights/<ID>/territories"
        }
      },
      "minus-territories": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-territories",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-territories"
        }
      },
      "continents": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/continents",
          "related": "https://api.idol.io/api/v2/rights/<ID>/continents"
        }
      },
      "minus-continents": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-continents",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-continents"
        }
      }
    }
  }
}

Update Right

PUT https://api.idol.io/api/v2/rights/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Right

Headers

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

Request Body

Name	Type	Description
distributed*	object	Polymorphic - Product / Label / Company Object
dsps	object	Dsp Object
minus-dsps	object	Dsp Object
territories	object	Territory Object
minus-territories	object	Territory Object
continents	object	Continent Object
minus-continents	object	Continent Object
right-dsp-tags	object	DspTag object
minus-right-dsp-tags	object	DspTag object
action*	string	add / remove / clear
comments	string	Acls object
user-email*	string	[email protected]

200

{
  "data": {
    "id": "<ID>",
    "type": "rights",
    "links": {
      "self": "https://api.idol.io/api/v2/rights/<ID>"
    },
    "attributes": {
      "action": "add",
      "comments": null,
      "created-at": "2018-07-18T18:53:38.917+02:00",
      "updated-at": "2018-07-18T18:53:38.911+02:00",
      "created-by": "[email protected]",
      "updated-by": "[email protected]",
      "user-email": "[email protected]",
      "computed-dsps": "Spotify",
      "computed-territories": "France + Belgium"
    },
    "relationships": {
      "distributor": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributor",
          "related": "https://api.idol.io/api/v2/rights/<ID>/distributor"
        },
        "data": {
          "type": "distributors",
          "id": "<ID>"
        }
      },
      "distributed": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/distributed",
          "related": "https://api.idol.io/api/v2/rights/<ID>/distributed"
        },
        "data": {
          "type": "companies",
          "id": "<ID>"
        }
      },
      "dsps": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/dsps",
          "related": "https://api.idol.io/api/v2/rights/<ID>/dsps"
        }
      },
      "minus-dsps": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-dsps",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-dsps"
        }
      },
      "minus-right-dsp-tags": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-right-dsp-tags",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-right-dsp-tags"
        }
      },
      "right-dsp-tags": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/right-dsp-tags",
          "related": "https://api.idol.io/api/v2/rights/<ID>/right-dsp-tags"
        }
      },
      "territories": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/territories",
          "related": "https://api.idol.io/api/v2/rights/<ID>/territories"
        }
      },
      "minus-territories": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-territories",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-territories"
        }
      },
      "continents": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/continents",
          "related": "https://api.idol.io/api/v2/rights/<ID>/continents"
        }
      },
      "minus-continents": {
        "links": {
          "self": "https://api.idol.io/api/v2/rights/<ID>/relationships/minus-continents",
          "related": "https://api.idol.io/api/v2/rights/<ID>/minus-continents"
        }
      }
    }
  }
}

Delete Right

DELETE https://api.idol.io/api/v2/rights/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Right

Headers

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

200