RPC API documentation v49.3.0

OwnersManager

Deprecated createOwner ( Owner owner )

Creates a new owner. Owner object must contain: name, contact, ownerType which can be: 0 - technical, 1 - administrative. Other parameters are ignored.

Parameter name	Data type	Description
owner	Owner	JSON object

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Owner	Created object

Example URL

https://[hostname]/krb/rpc/json/ownersManager/createOwner

see URL structure

Example params

{ "owner" : { "name" : "The Owner" , "contact" : "the contact", "ownerType" : 0 } }

see Passing params

Example response

{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" }

Deprecated createOwner ( String name, String contact, int ownerType )

Creates a new owner.

Parameter name	Data type	Description
name	String	name of a new owner
contact	String	contact of a new owner
ownerType	int	ownerType, 0 - technical, 1 - administrative

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Owner	Created object

Example URL

https://[hostname]/krb/rpc/json/ownersManager/createOwner

see URL structure

Example params

{ "name" : "The Owner" , "contact" : "the contact" , "ownerType" : 0 }

see Passing params

Example response

{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" }

Deprecated deleteOwner ( int owner )

Deletes an owner.

Parameter name	Data type	Description
owner	int	Owner `id`

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Object	Always null

Example URL

https://[hostname]/krb/rpc/json/ownersManager/deleteOwner

see URL structure

Example params

{ "owner" : 26 }

see Passing params

Example response

{ ... TODO ... }

Deprecated deleteOwner ( int owner, boolean force )

Forcefully deletes an owner.

Parameter name	Data type	Description
owner	int	Owner `id`
force	boolean	Force must be true

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Object	Always null

Example URL

https://[hostname]/krb/rpc/json/ownersManager/deleteOwner

see URL structure

Example params

{ "owner" : 20 , "force" : true }

see Passing params

Example response

{ ... TODO ... }

Deprecated deleteOwners ( List<Integer> owners )

Deletes owners.

Parameter name	Data type	Description
owners	List<Integer>	Owner `id`

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Object	Always null

Example URL

https://[hostname]/krb/rpc/json/ownersManager/deleteOwners

see URL structure

Example params

{ "owners" : [ 86 , 35 ] }

see Passing params

Example response

{ ... TODO ... }

Deprecated deleteOwners ( List<Integer> owners, boolean force )

Forcefully deletes owners.

Parameter name	Data type	Description
owners	List<Integer>	Owner `id`
force	boolean	Force must be true

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Object	Always null

Example URL

https://[hostname]/krb/rpc/json/ownersManager/deleteOwners

see URL structure

Example params

{ "owners" : [ 18 , 65 ] , "force" : true }

see Passing params

Example response

{ ... TODO ... }

Deprecated getOwnerById ( int id )

Returns an owner by its id.

Parameter name	Data type	Description
id	int	Owner `id`

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Owner	Found Owner

Example URL

https://[hostname]/krb/rpc/json/ownersManager/getOwnerById

see URL structure

Example params

{ "id" : 69 }

see Passing params

Example response

{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" }

Deprecated getOwnerByName ( String name )

Returns an owner by its name.

Parameter name	Data type	Description
name	String	Owner name

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
Owner	Found Owner

Example URL

https://[hostname]/krb/rpc/json/ownersManager/getOwnerByName

see URL structure

Example params

{ "name" : "text" }

see Passing params

Example response

{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" }

Deprecated getOwners ( )

Returns all owners.

Thrown exception	Description
InternalErrorException	When unspecified error occur. See exception param `message` for explanation.
PrivilegeException	When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcException	Wrong usage of API (wrong url, missing param etc.). See exception params `message` and `type` for explanation.

Return type	Description
List<Owner>	All owners

Example URL

https://[hostname]/krb/rpc/json/ownersManager/getOwners

see URL structure

Example response

[ { "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" } , {...} , {...} ]