Home Page > Integration > REST API > CopyrightHolders

CopyrightHolders

CopyrightHolders - /REST/1/CopyrightHolders/:id

This endpoint is used for manipulating CopyrightHolder resources within the system. Objects are always returned in a  JSON format within an array. Empty results return an empty array.

 

Object

The CopyrightHolders object takes on the following JSON object:

[
    {
        "copyright_policy_id": "<int>",
        "id": "<int>",
        "name": "<string>"
    }
]

 

GET

This verb is used for retrieving resources, it is subject to the parameters mentioned in the overview and all fields mentioned above are searchable, for instance, to search for all CopyrightHolders with a name exactly like "Thomas White":

 

curl -X GET http://my.openasset.example.org/REST/1/CopyrightHolders?name=Thomas%20White&textMatching=exact

 

PUT

This verb is used for updating an existing resource. The following JSON parameters can be used within the body:

 

JSON Parameter Allowed values
name string
copyright_policy_id integer (foreign key)

 

POST

This verb is used for creating a new resource. The following JSON parameters are required within the body:

 

JSON Parameter Allowed values
name string

 


Examples

OpenAsset C# REST Wrapper

Additional general examples using the OpenAsset C-sharp REST Wrapper are found below. The Wrapper itself can be found at the following github location: https://github.com/axomic/openasset-rest-cs

 

 

Ruby

Ruby code example with Albums Noun.

  //Get a collection of Albums from the REST API. 
 //The Rest Library will serialize the results automatically.

require 'openasset-rest-client'

client = OpenAsset::RestClient.new("url","username","password")

--Get copyright holders
copyright_holder = client.get_copyright_holders.first

--Create copyright holder(s)
copyright_holder_obj = CopyrightHolders.new("axomic")
client.create_copyright_holders(copyright_holder_obj)

--Update copyright holder(s)
// edit copyright holders
copyright_holder.name = "Axomic Inc."
client.update_copyright_holders(copyright_holder)

 

 

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.