RPC API documentation v17.2.0

Back to Documentation Version:  General How to use RPC Managers AttributesManagerAuditMessagesManagerAuthzResolverCabinetManagerConfigManagerConsentsManagerDatabaseManagerExtSourcesManagerFacilitiesManagerGroupsManagerIntegrationManagerMembersManagerNotificationManagerOwnersManagerRTMessagesManagerRegistrarManagerResourcesManagerSearcherSecurityTeamsManagerServicesManagerTasksManagerUsersManagerVosManager

OwnersManager

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

Parameter nameData typeDescription
ownerOwnerJSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
OwnerCreated 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 nameData typeDescription
nameStringname of a new owner
contactStringcontact of a new owner
ownerTypeintownerType, 0 - technical, 1 - administrative
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
OwnerCreated 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 nameData typeDescription
ownerintOwner id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "owner" : 93 }

Example response

{ ... TODO ... }

Forcefully deletes an owner.

Parameter nameData typeDescription
ownerintOwner id
forcebooleanForce must be true
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

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

Example response

{ ... TODO ... }

Returns an owner by its id.

Parameter nameData typeDescription
idintOwner id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
OwnerFound Owner

Example URL

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

Example params

{ "id" : 24 }

Example response

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

Returns an owner by its name.

Parameter nameData typeDescription
nameStringOwner name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
OwnerFound 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 exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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" } , {...} , {...} ]