Home Page > Integration > REST API > CopyrightPolicies

CopyrightPolicies

CopyrightPolicies - /REST/1/CopyrightPolicies/:id

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

 

Object

The CopyrightPolicies object takes on the following JSON object:

[
    {
        "code": "<hash>",
        "description": "<text>",
        "id": "<int>",
        "name": "<string>"
    }
]

 

GET

As with other resources, this resource is subject to the global parameters mentioned in the REST Overview.

 

PUT

The following JSON parameters are available when updating a resource:

 

JSON Parameter

Allowed values

name string
description text

    

POST

The following JSON parameters are required when creating a resource:

 

JSON Parameter Allowed values
name string

 

DELETE

The resource can be deleted using this verb and including the id in the endpoint URL.


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 policies
policies = client.get_copyright_policies

--Create create copyright policies
new_policy = CopyrightPolicies.new("Policy Name")
client.create_copyright_policies(new_policy)

--Update copyright policies
// edit policy
policy.text = "New long description"
policy.name = "New policy name"
client.update_copyright_policies(policy)

--Delete copyright policies
client.delete_copyright_policies(policy)


 

 

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.