Welcome to AgavePy’s documentation!¶
- agavepy.actors
- add: Register an actor.
- list: List actors
- delete: Delete a specific actor.
- get: Retrieve details about a specific actor.
- update: Retrieve details about a specific actor.
- getMessages: Get the current number of messages for an actor.
- sendBinaryMessage: Send a message to an actor mailbox.
- sendMessage: Send a message to an actor mailbox.
- getState: Get the current state for an actor.
- updateState: Update an actor’s state with a JSON-serializable object.
- getPermissions: Get the current permissions for an actor.
- updatePermissions: Update an actor’s permissions with a new permission for a user.
- addWorker: Add a worker to an actor.
- listWorkers: List the current workers for an actor.
- deleteWorker: Delete a worker.
- getWorker: Get the details about a specific worker for an actor.
- addNonce: Add a nonce to an actor.
- listNonces: List the current nonces for an actor.
- deleteNonce: Delete a nonce.
- getNonce: Get the details about a specific nonce for an actor.
- listExecutions: Summary data of all actor executions.
- getExecution: Retrieve details about a specific actor execution.
- getOneExecutionResult: Get result for a specific actor execution.
- getExecutionLogs: Get logs for a specific actor execution.
- agavepy.apps
- add: Register and update new applications.
- list: Get a list of available applications.
- delete: Deletes an application.
- get: Get details of an application by it’s unique id.
- manage: Edit an application.
- update: Update an application.
- deletePermissions: Deletes all permissions on an application.
- listPermissions: Get the permission ACL for this application.
- updateApplicationPermissions: Add or update a user’s permission for an application.
- deletePermissionsForUser: Deletes all permissions for the given user on an application.
- listPermissionsForUser: Get a specific user’s permissions for an application.
- updatePermissionsForUser: Add or update a user’s permission for an application.
- listByName: Get a list of applications with the given name.
- listBySystemId: Get a list of applications with the given systemId as their executionHost.
- agavepy.files
- deleteFromDefaultSystem: Deletes a file or folder.
- downloadFromDefaultSystem: Download a file from the user’s default storage location.
- importToDefaultSystem: Import a file via direct upload or importing from a url to the user’s default storage location.
- manageOnDefaultSystem: Perform an action on a file or folder.
- delete: Deletes a file or folder.
- download: Download a file from the user’s default storage location.
- importData: Import a file via direct upload or importing from a url to the user’s default storage location.
- manage: Perform an action on a file or folder.
- listOnDefaultSystem: Get a remote directory listing.
- list: Get a remote directory listing on a specific system.
- getHistoryOnDefaultSystem: Download a file from the user’s default storage location.
- getHistory: Return history of api actions.
- listPermissionsOnDefaultSystem: List all the share permissions for a file or folder.
- updatePermissionsOnDefaultSystem: Update permissions for a single user.
- deletePermissions: Deletes all permissions on a file except those of the owner.
- listPermissions: List all the share permissions for a file or folder.
- updatePermissions: Update permissions for a single user.
- agavepy.jobs
- list: Get a list of jobs the authenticated user had submitted.
- submit: Submit a new job request.
- delete: Deletes a job from the user’s history.
- get: Get details of the job with the specific job id.
- manage: Perform an action on a job.
- getHistory: Get the history of this job.
- deletePermissions: Deletes all permissions on an job.
- listPermissions: Get the permission ACL for this job.
- updatePermissions: Add or update a user’s permission for an application.
- deletePermissionsForUser: Deletes all permissions for the given user on an job.
- listPermissionsForUser: Get a specific user’s permissions for a job.
- updatePermissionsForUser: Add or update a user’s permission for an job.
- getStatus: Get the status of the job.
- listOutputs: List contents of a job’s output directory.
- downloadOutput: Download an output file from a specific job.
- search: Find jobs matching the given attribute/value combination(s).
- agavepy.meta
- addMetadata: Update or Add new Metadata.
- listMetadata: List and/or search metadata.
- deleteMetadata: Remove Metadata from the system.
- getMetadata: Retrieve Metadata.
- updateMetadata: Update or Add new Metadata.
- addSchema: Add a new Metadata Schema.
- searchSchema: Retrieve Metadata Schemata.
- deleteSchema: Remove Metadata Schema from the system.
- getSchema: Retrieve Metadata Schemata.
- updateSchema: Update or Add a new Metadata Schema.
- deleteMetadataPermission: Deletes all permissions on the given metadata.
- listMetadataPermissions: Get the permission ACL for this metadata.
- updateMetadataPermissions: Add or update a user’s permission for the given metadata.
- deleteMetadataPermissionsForUser: Deletes all permissions on the given metadata.
- listMetadataPermissionsForUser: Get the permission ACL for this metadata.
- updateMetadataPermissionsForUser: Add or update a user’s permission for the given metadata.
- deleteSchemaPermissions: Deletes all permissions on the given schema.
- listSchemaPermissions: Get the permission ACL for this schema.
- updateSchemaPermissions: Add or update a user’s permission for the given schema.
- deleteSchemaPermissionsForUser: Deletes all permissions on the given metadata.
- listSchemaPermissionsForUser: Get the permission ACL for this schema.
- updateSchemaPermissionsForUser: Add or update a user’s permission for the given metadata schema.
- agavepy.notifications
- agavepy.profiles
- agavepy.systems
- add: Add or update a system.
- list: Show all systems available to the user.
- delete: Delete a system.
- get: Find information about an individual system.
- manage: Perform a management action on the system.
- update: Find information about an individual system.
- deleteRoles: Deletes all roles on a system.
- listRoles: Get a list of all users and their roles on this system.
- updateRole: Add or update a user’s role on a system.
- deleteRoleForUser: Deletes all roles on a system.
- getRoleForUser: Get a specific user’s roles on this system.
- updateRoleForUser: Add or update a user’s role on a system.
- deleteCredentials: Deletes all credentials registered to a system.
- listCredentials: Get a list of all internal users and their credentials on this system.
- updateCredentials: Add or update a user’s credential on a system. This applies both to data and, if applicable, login credenitals.
- deleteCredentialsForInternalUser: Deletes all credentials registered to a system.
- listCredentialsForInternalUser: Get a list of all internal users and their credentials on this system.
- updateCredentialsForInternalUser: Add or update a user’s credentials on a system.
- deleteCredentialsForInternalUserByType: Deletes the internal user credentials for the given credential type on a system.
- listCredentialsForInternalUserByType: Get the internal user credential of the given type on the system.
- updateCredentialsForInternalUserByType: Add or update a credential of the given type on a system.