RPC API documentation v17.2.0

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

CabinetManager

Creates Authorship. Everything except current date must be already set in Authorship object. Authorship is checked for existence before creation, if exists, existing object is returned. When authorship is successfully created, users priority coefficient is updated.

Parameter nameData typeDescription
authorshipAuthorshipAuthorship to be created
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
AuthorshipCreated authorship

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/createAuthorship

Example params

{ "authorship" : {...} }

Example response

{ ... TODO ... }

Creates new Category for Publications with specified name and rank. Category object's parameter name must be non-empty, max 128 chars long and rank must be double with single digit after decimal point. Other parameters are ignored.

Parameter nameData typeDescription
categoryCategorynew Category object, must contain: name, rank
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
CategoryCreated Category with ID set

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/createCategory

Example params

{ "category" : { "name" : "My testing category" , "rank" : 8.4 } }

Example response

{ ... TODO ... }

Creates new Category for Publications with specified name and rank.

Parameter nameData typeDescription
nameStringthe name of the category
rankDoublethe rank of the category
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
CategoryCreated Category with ID set

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/createCategory

Example params

{ "name" : "My testing category" , "rank" : 8.4 }

Example response

{ ... TODO ... }

Create Publication. If exists by its ID or EXT_ID,PUB_SYS_ID then existing publication is returned.

Parameter nameData typeDescription
publicationPublicationPublication to create
Thrown exceptionDescription
CabinetException
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
PublicationCreated publication with ID set

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/createPublication

Example params

{ "publication" : {...} }

Example response

{ ... TODO ... }

Creates new PublicationSystem.

Parameter nameData typeDescription
pubsysPublicationSystemPublication system to create.
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
PublicationSystemCreated PublicationSystem with ID set.

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/createPublicationSystem

Example params

{ "pubsys" : {...} }

Example response

{ ... TODO ... }

Creates new Thanks for Publication

Parameter nameData typeDescription
thanksThanksnew Thanks 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
ThanksCreated thanks

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/createThanks

Example params

{ "thanks" : {...} }

Example response

{ ... TODO ... }

Delete Authorship by its userId and publicationId.

Parameter nameData typeDescription
publicationIdintPublication id
userIdintUser id
Thrown exceptionDescription
CabinetExceptionWhen Authorship doesn't exists
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
void

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/deleteAuthorship

Example params

{ "publicationId" : 98 , "userId" : 10 }

Example response

null

Delete category by its ID. If category contains any publications, it can't be deleted.

Parameter nameData typeDescription
idintCategory id
Thrown exceptionDescription
CabinetExceptionWhen Category doesn't exists or has publications
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
void

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/deleteCategory

Example params

{ "id" : 53 }

Example response

null

Delete publication by its ID. Only Author of the record or PerunAdmin can do this. - Author deletes Authorships and Thanks from publication. - PerunAdmin also delete publication record.

Parameter nameData typeDescription
idintID of Publication to delete
Thrown exceptionDescription
CabinetExceptionWhen publication not exists
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
void

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/deletePublication

Example params

{ "id" : 30 }

Example response

null

Deletes PublicationSystem by its ID.

Parameter nameData typeDescription
idintID of PublicationSystem to delete.
Thrown exceptionDescription
CabinetExceptionWhen Category doesn't exists or has publications
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
void

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/deletePublicationSystem

Example params

{ "id" : 55 }

Example response

null

Delete Thanks by its ID.

Parameter nameData typeDescription
idintThanks id
Thrown exceptionDescription
CabinetExceptionWhen Thanks doesn't exists
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
void

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/deleteThanks

Example params

{ "id" : 7 }

Example response

null

Return all Authors of Publications. Empty list of none found.

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<Author>List of all Authors of Publications. Empty list of none found.

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findAllAuthors

Example response

{ ... TODO ... }

Return all Authors of Publication specified by its ID. Empty list of none found.

Parameter nameData typeDescription
idintID of Publication to look by
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<Author>List of Authors of Publication specified its ID. Empty list of none found.

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findAuthorsByPublicationId

Example params

{ "id" : 95 }

Example response

{ ... TODO ... }

Finds publications of perun's user specified in param Search is done in external publication systems (MU, ZCU) All parameters are required.

Parameter nameData typeDescription
userintPerun user
yearSinceintYear since
yearTillintYear till - must be equal or greater then yearSince
pubSysNamespaceString(MU or ZCU)
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<Publication>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findExternalPublications

Example params

{ "user" : 56 , "yearSince" : 83 , "yearTill" : 16 , "pubSysNamespace" : "text" }

Example response

{ ... TODO ... }

Find new Authors for Publication. Empty list of none found. Used by users to search for colleagues to add them as co-authors.

Parameter nameData typeDescription
searchStringStringSearch string to find new Authors by
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<Author>List of new possible Authors for Publication. Empty list of none found.

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findNewAuthors

Example params

{ "searchString" : "text" }

Example response

{ ... TODO ... }

Return Publication by its ID.

Parameter nameData typeDescription
idintID of Publication
Thrown exceptionDescription
CabinetExceptionWhen such Publication doesn't exists
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
PublicationForGUIby its ID

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findPublicationById

Example params

{ "id" : 83 }

Example response

{ ... TODO ... }

Finds publications in Cabinet by filter.

Parameter nameData typeDescription
yearSinceintYear since (use <1 to disable this filter)
yearTillintYear till (use <1 to disable this filter)
userIdintAuthor/User 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
List<Publication>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findPublicationsByFilter

Example params

{ "yearSince" : 67 , "yearTill" : 31 , "userId" : 17 }

Example response

{ ... TODO ... }

Finds rich publications in Cabinet by GUI filter: id = exact match (used when search for publication of authors) title = if "like" this substring year = exact match isbn = if "like" this substring category = exact match yearSince = if year >= yearSince yearTill = if year <= yearTill userId = exact match or 0 If you don't want to filter by publication params, do not include the attribute in the query.

Parameter nameData typeDescription
idintPublication id
titleStringTitle
isbnStringISBN
yearintYear
categoryintCategory
doiStringDOI
yearSinceintYear since
yearTillintYear till
userIdintUser 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
List<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findPublicationsByGUIFilter

Example params

{ "id" : 98 , "title" : "text" , "isbn" : "text" , "year" : 60 , "category" : 95 , "doi" : "text" , "yearSince" : 32 , "yearTill" : 91 , "userId" : 35 }

Example response

{ ... TODO ... }

Finds similar publications

Parameter nameData typeDescription
titleStringTitle
isbnStringISBN
doiStringDOI
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<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findSimilarPublications

Example params

{ "title" : "text" , "isbn" : "text" , "doi" : "text" }

Example response

{ ... TODO ... }

Finds similar publications

Parameter nameData typeDescription
isbnStringISBN
doiStringDOI
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<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findSimilarPublications

Example params

{ "isbn" : "text" , "doi" : "text" }

Example response

{ ... TODO ... }

Finds similar publications

Parameter nameData typeDescription
doiStringDOI
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<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findSimilarPublications

Example params

{ "doi" : "text" }

Example response

{ ... TODO ... }

Finds similar publications

Parameter nameData typeDescription
titleStringTitle
doiStringDOI
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<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findSimilarPublications

Example params

{ "title" : "text" , "doi" : "text" }

Example response

{ ... TODO ... }

Finds similar publications

Parameter nameData typeDescription
titleStringTitle
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<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findSimilarPublications

Example params

{ "title" : "text" }

Example response

{ ... TODO ... }

Finds similar publications

Parameter nameData typeDescription
isbnStringISBN
doiStringDOI
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<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findSimilarPublications

Example params

{ "isbn" : "text" , "doi" : "text" }

Example response

{ ... TODO ... }

Finds similar publications

Parameter nameData typeDescription
isbnStringISBN
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<PublicationForGUI>Found publications

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/findSimilarPublications

Example params

{ "isbn" : "text" }

Example response

{ ... TODO ... }

Return list of all Categories in Perun or empty list of none present.

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<Category>Categories

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/getCategories

Example response

{ ... TODO ... }

Get all PublicationSystems in Perun. If none, return empty list.

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<PublicationSystem>List of all PublicationSystems or empty list.

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/getPublicationSystems

Example response

{ ... TODO ... }

Gets overall rank of given user as sum of all his publications Authorships.

Parameter nameData typeDescription
userintID of user to get Rank for
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
doubleTotal rank of user or 1.0 if user has no Authorships yet (default rank).

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/getRank

Example params

{ "user" : 9 }

Example response

{ ... TODO ... }

Get ThanksForGUI of Publication specified by its ID or empty list.

Parameter nameData typeDescription
idintPublication 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
List<ThanksForGUI>Found thanks

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/getRichThanksByPublicationId

Example params

{ "id" : 93 }

Example response

{ ... TODO ... }

(Un)Lock passed Publications for changes.

Parameter nameData typeDescription
lockbooleanTRUE (lock) / FALSE (unlock)
publicationsList<Publication>Publications to (un)lock
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
void

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/lockPublications

Example params

{ "lock" : true , "publications" : {...} }

Example response

null

Updates publications category in Perun. Category to update is found by ID. When category rank is changed, priorityCoefficient for all authors of books from this category, is recalculated.

Parameter nameData typeDescription
categoryCategoryto update to
Thrown exceptionDescription
CabinetExceptionWhen Category doesn't exists
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
CategoryUpdated category

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/updateCategory

Example params

{ "category" : {...} }

Example response

{ ... TODO ... }

Update existing publication by its ID.

Parameter nameData typeDescription
publicationPublicationPublication to update
Thrown exceptionDescription
CabinetExceptionWhen same Publication already exists
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
PublicationUpdated publication by its ID

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/updatePublication

Example params

{ "publication" : {...} }

Example response

{ ... TODO ... }

Updates PublicationSystem by its ID.

Parameter nameData typeDescription
pubsysPublicationSystemPublication system to update.
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
PublicationSystemCreated PublicationSystem with ID set.

Example URL

https://[hostname]/krb/rpc/json/cabinetManager/updatePublicationSystem

Example params

{ "pubsys" : {...} }

Example response

{ ... TODO ... }