RPC API documentation v17.2.0

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

TasksManager

Returns the count of all tasks.

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
intTask count

Example URL

https://[hostname]/krb/rpc/json/tasksManager/countTasks

Example response

65

Delete Task and TaskResults.

Parameter nameData typeDescription
taskintTask to delete.
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/tasksManager/deleteTask

Example params

{ "task" : 88 }

Example response

null

Delete TaskResult by its ID

Parameter nameData typeDescription
taskResultIdintID of TaskResult to deleted
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/tasksManager/deleteTaskResultById

Example params

{ "taskResultId" : 51 }

Example response

null

Delete TaskResults for specified Task and Destination.

Parameter nameData typeDescription
taskIdintID of Task to delete TaskResults for
destinationIdintID of Destination to delete TaskResults 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
void

Example URL

https://[hostname]/krb/rpc/json/tasksManager/deleteTaskResults

Example params

{ "taskId" : 88 , "destinationId" : 14 }

Example response

null

Delete TaskResults for specified Task and Destination.

Parameter nameData typeDescription
taskIdintID of Task to delete TaskResults for
destinationNameStringName of Destination to delete TaskResults for
destinationTypeStringType of Destination to delete TaskResults 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
void

Example URL

https://[hostname]/krb/rpc/json/tasksManager/deleteTaskResults

Example params

{ "taskId" : 83 , "destinationName" : "text" , "destinationType" : "text" }

Example response

null

Return propagation status of all facilities in Perun.

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<FacilityState>Propagation status

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getAllFacilitiesStates

Example response

{ ... TODO ... }

Return propagation status of all facilities related to VO resources.

Parameter nameData typeDescription
vointVO 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<FacilityState>Propagation status

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getAllFacilitiesStates

Example params

{ "vo" : 15 }

Example response

{ ... TODO ... }

Return propagation status of all resources related to VO.

Parameter nameData typeDescription
voIdintVO 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<ResourceState>Propagation status

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getAllResourcesState

Example params

{ "voId" : 71 }

Example response

{ ... TODO ... }

Returns service states for defined facility.

Parameter nameData typeDescription
Facilityintid of facility
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<ServiceState>serviceStates.

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getFacilityServicesState

Example params

{ "Facility" : 6 }

Example response

{ ... TODO ... }

Return propagation status of facility.

Parameter nameData typeDescription
facilityintFacility 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
FacilityStateFacility state

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getFacilityState

Example params

{ "facility" : 62 }

Example response

{ ... TODO ... }

Returns a task.

Parameter nameData typeDescription
serviceintService id
facilityintFacility 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
TaskFound task

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTask

Example params

{ "service" : 78 , "facility" : 64 }

Example response

{ ... TODO ... }

Returns Task by its id.

Parameter nameData typeDescription
idintTask 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
TaskTask

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskById

Example params

{ "id" : 40 }

Example response

{ ... TODO ... }

Returns TaskResult by its id.

Parameter nameData typeDescription
taskResultintTaskResult 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
TaskResultResult

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultById

Example params

{ "taskResult" : 18 }

Example response

{ ... TODO ... }

Returns all task results.

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<TaskResult>Task results.

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResults

Example response

{ ... TODO ... }

Return list of TaskResults by a Task.

Parameter nameData typeDescription
taskintTask 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<TaskResult>Results

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultsByTask

Example params

{ "task" : 38 }

Example response

{ ... TODO ... }

Return list of TaskResults by a Task and destination for GUI.

Parameter nameData typeDescription
taskintTask
destinationintDestination 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<TaskResult>Results

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultsByTaskAndDestination

Example params

{ "task" : 4 , "destination" : 8 }

Example response

{ ... TODO ... }

Return list of only newest TaskResults by a Task for GUI.

Parameter nameData typeDescription
taskintTask
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<TaskResult>Results

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultsByTaskOnlyNewest

Example params

{ "task" : 24 }

Example response

{ ... TODO ... }

Returns task results for defined destinations.

Parameter nameData typeDescription
destinationsList<String>Destinations
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<TaskResult>Results.

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultsForDestinations

Example params

{ "destinations" : [ "text" , "text" ] }

Example response

{ ... TODO ... }

Return list of TaskResults by a Task for GUI.

Parameter nameData typeDescription
taskintTask
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<TaskResult>Results

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultsForGUIByTask

Example params

{ "task" : 54 }

Example response

{ ... TODO ... }

Return list of TaskResults by a Task and destination for GUI.

Parameter nameData typeDescription
taskintTask
destinationintDestination 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<TaskResult>Results

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultsForGUIByTaskAndDestination

Example params

{ "task" : 50 , "destination" : 23 }

Example response

{ ... TODO ... }

Return list of only newest TaskResults by a Task for GUI.

Parameter nameData typeDescription
taskintTask
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<TaskResult>Results

Example URL

https://[hostname]/krb/rpc/json/tasksManager/getTaskResultsForGUIByTaskOnlyNewest

Example params

{ "task" : 38 }

Example response

{ ... TODO ... }

Whether task exists.

Parameter nameData typeDescription
serviceintService id
facilityintFacility 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
int1 = true; 0 = false

Example URL

https://[hostname]/krb/rpc/json/tasksManager/isThereSuchTask

Example params

{ "service" : 76 , "facility" : 35 }

Example response

74

Returns all tasks.

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<Task>All tasks

Example URL

https://[hostname]/krb/rpc/json/tasksManager/listAllTasks

Example response

{ ... TODO ... }

Returns all tasks associated with selected facility.

Parameter nameData typeDescription
facilityintFacility 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<Tasks>Tasks

Example URL

https://[hostname]/krb/rpc/json/tasksManager/listAllTasksForFacility

Example params

{ "facility" : 35 }

Example response

{ ... TODO ... }

Resumes dispatcher's tasks propagation to the engine.

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/tasksManager/resumeTasksPropagation

Example response

null

Stops dispatcher from propagating waiting tasks to the engine. Tasks which were sent to the engine before won't be affected and will be finished.

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/tasksManager/suspendTasksPropagation

Example response

null