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
Example params
{ "owner" : { "name" : "The Owner" , "contact" : "the contact", "ownerType" : 0 } }
Example response
{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" }
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
Example params
{ "name" : "The Owner" , "contact" : "the contact" , "ownerType" : 0 }
Example response
{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "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
Example params
{ "owner" : 2 }
Example response
{ ... TODO ... }
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
Example params
{ "owner" : 67 , "force" : true }
Example response
{ ... TODO ... }
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
Example params
{ "owners" : [ 60 , 27 ] }
Example response
{ ... TODO ... }
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
Example params
{ "owners" : [ 20 , 50 ] , "force" : true }
Example response
{ ... TODO ... }
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
Example params
{ "id" : 38 }
Example response
{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" }
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
Example params
{ "name" : "text" }
Example response
{ "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" }
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
Example response
[ { "id" : 183 , "name" : "Some Body" , "type" : "administrative" , "contact" : "mail@mail.com" , "beanName" : "Owner" } , {...} , {...} ]