RPC API documentation v34.4.0

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.

Example URL

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

• see URL structure

Example params

{ "authorship" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates new Category for Publications with specified name and rank.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "publication" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates new PublicationSystem.

Example URL

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

• see URL structure

Example params

{ "pubsys" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates new Thanks for Publication

Example URL

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

• see URL structure

Example params

{ "thanks" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Delete Authorship by its userId and publicationId.

Example URL

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

• see URL structure

Example params

{ "publicationId" : 43 , "userId" : 12 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "id" : 91 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "id" : 87 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes PublicationSystem by its ID.

Example URL

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

• see URL structure

Example params

{ "id" : 84 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Delete Thanks by its ID.

Example URL

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

• see URL structure

Example params

{ "id" : 33 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "id" : 2 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "user" : 93 , "yearSince" : 84 , "yearTill" : 60 , "pubSysNamespace" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "searchString" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Return Publication by its ID.

Example URL

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

• see URL structure

Example params

{ "id" : 38 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds publications in Cabinet by filter.

Example URL

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

• see URL structure

Example params

{ "yearSince" : 89 , "yearTill" : 42 , "userId" : 9 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "id" : 41 , "title" : "text" , "isbn" : "text" , "year" : 38 , "category" : 82 , "doi" : "text" , "yearSince" : 73 , "yearTill" : 92 , "userId" : 91 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds similar publications

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds similar publications

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds similar publications

Example URL

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

• see URL structure

Example params

{ "doi" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds similar publications

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds similar publications

Example URL

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

• see URL structure

Example params

{ "title" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds similar publications

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Finds similar publications

Example URL

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

• see URL structure

Example params

{ "isbn" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "user" : 77 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "id" : 4 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

(Un)Lock passed Publications for changes.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "category" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Update existing publication by its ID.

Example URL

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

• see URL structure

Example params

{ "publication" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Updates PublicationSystem by its ID.

Example URL

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

• see URL structure

Example params

{ "pubsys" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes