RPC API documentation v49.3.0

ExtSourcesManager

Associate an external source definition with a VO.

Parameter name	Data type	Description
vo	int	VO `id`
source	int	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/addExtSource

see URL structure

Example params

{ "vo" : 46 , "source" : 67 }

see Passing params

Example response

null

addExtSource ( int group, int source )

Associate an external source definition with a GROUP.

Parameter name	Data type	Description
group	int	GROUP `id`
source	int	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/addExtSource

see URL structure

Example params

{ "group" : 13 , "source" : 57 }

see Passing params

Example response

null

addExtSources ( int vo, List<Integer> sourceIds )

Associate external source definitions with a VO.

Parameter name	Data type	Description
vo	int	VO `id`
sourceIds	List<Integer>	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/addExtSources

see URL structure

Example params

{ "vo" : 45 , "sourceIds" : [ 7 , 54 ] }

see Passing params

Example response

null

addExtSources ( int group, List<Integer> extSources )

Associate external source definitions with a GROUP.

Parameter name	Data type	Description
group	int	GROUP `id`
extSources	List<Integer>	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/addExtSources

see URL structure

Example params

{ "group" : 46 , "extSources" : [ 29 , 22 ] }

see Passing params

Example response

null

createExtSource ( ExtSource extSource )

Creates an external source. ExtSource object must contain: name, type. Other parameters are ignored.

Parameter name	Data type	Description
extSource	ExtSource	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
ExtSource	Created ExtSource

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/createExtSource

see URL structure

Example params

{ "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } }

see Passing params

Example response

{ "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" }

createExtSource ( String name, String type )

Creates an external source.

Parameter name	Data type	Description
name	String	name of ExtSource
type	String	type of ExtSource

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
ExtSource	Created ExtSource

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/createExtSource

see URL structure

Example params

{ "name" : "text" , "type" : "text" }

see Passing params

Example response

{ "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" }

getExtSourceByName ( String name )

Returns an external source by its name.

Parameter name	Data type	Description
name	String	ExtSource 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
ExtSource	Found ExtSource

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getExtSourceByName

see URL structure

Example params

{ "name" : "text" }

see Passing params

Example response

{ "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" }

getExtSources ( )

Returns the list of all external sources.

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<ExtSource>	all external sources

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getExtSources

see URL structure

Example response

[ { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , {...} , {...} ]

getGroupExtSources ( int group )

Returns the list of external sources associated with a GROUP.

Parameter name	Data type	Description
group	int	GROUP `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
List<ExtSource>	GROUP external sources

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/getGroupExtSources

see URL structure

Example params

{ "group" : 25 }

see Passing params

Example response

[ { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , {...} , {...} ]

loadExtSourcesDefinitions ( )

Loads ext source definitions from the configuration file and updates entries stored in the DB.

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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/loadExtSourcesDefinitions

see URL structure

Example response

null

removeExtSource ( int vo, int source )

Remove an association of an external source from a VO.

Parameter name	Data type	Description
vo	int	VO `id`
source	int	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/removeExtSource

see URL structure

Example params

{ "vo" : 54 , "source" : 85 }

see Passing params

Example response

null

removeExtSource ( int group, int source )

Remove an association of an external source from a GROUP.

Parameter name	Data type	Description
group	int	GROUP `id`
source	int	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/removeExtSource

see URL structure

Example params

{ "group" : 3 , "source" : 0 }

see Passing params

Example response

null

removeExtSources ( int vo, List<Integer> sourceIds )

Remove associations of external sources from a VO.

Parameter name	Data type	Description
vo	int	VO `id`
sourceIds	List<Integer>	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/removeExtSources

see URL structure

Example params

{ "vo" : 46 , "sourceIds" : [ 35 , 24 ] }

see Passing params

Example response

null

removeExtSources ( int group, List<Integer> extSources )

Remove associations of external sources from a GROUP.

Parameter name	Data type	Description
group	int	GROUP `id`
extSources	List<Integer>	ExtSource `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
void

Example URL

https://[hostname]/krb/rpc/json/extSourcesManager/removeExtSources

see URL structure

Example params

{ "group" : 8 , "extSources" : [ 46 , 60 ] }

see Passing params

Example response

null