automic-rest 0.0.3

Automic REST-API

automic_rest

Under construction! Not ready for use yet! Currently experimenting and planning!

How To Use

import automic_rest as automic

# init
automic.connection(
    userid='admin', 
    password='*****', 
    url='https://autmic-rest.com', 
    noproxy=True, 
    sslverify=False
)

# listExecutions 
execs = automic.executions().listExecutions(client_id=1).json()

for o in execs['data']:
    print(o['name'])


# executeObject
data = {
  "object_name": "SCRI.NEW.5",
  "execution_option": "execute",
  "inputs":
  {
    "PASS#": "test"
  }
 }
runid = automic.executions().executeObject(client_id=1111, data=data).json()['run_id']

print(runid)

response = automic.executions().listReportContent(client_id=1111, run_id=runid, report_type='ACT').json()
print(response['data'][0]['content'])

Class	Function	Infos
executions	changeExecutionStatus	summary - Changes the status of an execution. path - /{client_id}/executions/{run_id}/status method - post
executions	computeErtEstimations	summary - Get ERT estimations for the given workflow. path - /{client_id}/executions/{run_id}/ert method - get
executions	createComments	summary - Appends a comment to a given execution. path - /{client_id}/executions/{run_id}/comments method - post
executions	executeObject	summary - Execute an object with or without input parameters (promptsets variables). path - /{client_id}/executions method - post
executions	getChildrenOfExecution	summary - Gets all immediate execution children, ordered descending by activation_time and run_id. path - /{client_id}/executions/{run_id}/children method - get
executions	getExecution	summary - Get details of a given execution. path - /{client_id}/executions/{run_id} method - get
executions	listComments	summary - List all comments for a given execution. path - /{client_id}/executions/{run_id}/comments method - get
executions	listExecutions	summary - List executions, ordered descending by activation_time and run_id. path - /{client_id}/executions method - get
executions	listReportContent	summary - Report content pages. path - /{client_id}/executions/{run_id}/reports/{report_type} method - get
executions	listReports	summary - Report list for a given execution. path - /{client_id}/executions/{run_id}/reports method - get
executions	listVariables	summary - List all variables for a given execution. path - /{client_id}/executions/{run_id}/variables method - get
forecasts	createForecast	summary - Create a forecast. path - /{client_id}/forecasts method - post
forecasts	deleteForecast	summary - Delete forecasts using ids. path - /{client_id}/forecasts method - delete
forecasts	getForecast	summary - Get details of a given forecast. path - /{client_id}/forecasts/{forecast_id} method - get
forecasts	listForecastAgents	summary - List forecast agents and gaps. path - /{client_id}/forecasts/agents method - get
forecasts	listForecasts	summary - List all forecasts, ordered descending by start_time. path - /{client_id}/forecasts method - get
forecasts	modifyForecast	summary - Changes the title of a forecast item. path - /{client_id}/forecasts/{forecast_id} method - post
objects	getObjects	summary - Can be used to export single objects by name path - /{client_id}/objects/{object_name} method - get
objects	getTimezoneInfo	summary - Returns the time zone used by an object definition or defaults if the object or time zone does not exist. path - /{client_id}/objects/{object_name}/timezone method - get
objects	listObjectInputs	summary - List all inputs for a given object. path - /{client_id}/objects/{object_name}/inputs method - get
objects	postObjects	summary - Can be used to import single objects path - /{client_id}/objects method - post
objects	usage	summary - Returns a list of objects with a reference name, a boolean to show if the actual result has hidden objects due to acl conflicts, for the given objectname path - /{client_id}/objects/{object_name}/usage method - get
objects	usageForCalendarEvents	summary - Returns a list of objects with a reference name, a boolean to show if the actual result has hidden objects due to acl conflicts, for the given objectname path - /{client_id}/objects/{object_name}/usage/calendarevent/{event_name} method - get
ping	ping	summary - Can be used to determine if the JCP process is currently running. path - /ping method - get
repositories	branchDiff	summary - Get content of two files to see their differences. path - /{client_id}/repositories/branches/{branch_name}/diff method - get
repositories	branchLog	summary - Retrieves the history of the repository for max_results entries. path - /{client_id}/repositories/branches/{branch_name}/log method - get
repositories	commitChanges	summary - Commits only changed objects for client to repository. path - /{client_id}/repositories/commits method - post
repositories	createBranch	summary - Create a new branch. path - /{client_id}/repositories/branches method - post
repositories	createRepository	summary - Initializes the repository for the specified client. path - /{client_id}/repositories method - post
repositories	delete	summary - Abort merging so we get out of merging state. path - /{client_id}/repositories/merge method - delete
repositories	getChanges	summary - Returns a list of objects that have uncommitted changes. path - /{client_id}/repositories/changes method - get
repositories	getRepository	summary - Retrieves repository information for the given client. path - /{client_id}/repositories method - get
repositories	listBranches	summary - Retrieves a list of branches. path - /{client_id}/repositories/branches method - get
repositories	mergeBranchIntoActive	summary - Merge another branch in active branch. path - /{client_id}/repositories/merge method - post
repositories	moveHead	summary - Imports version of provided GIT Hash to automation engine. path - /{client_id}/repositories/commits/{commit_id} method - post
repositories	pull	summary - Pull changes from repository for active branch. path - /{client_id}/repositories/pull method - post
scripts	activateScript	summary - Runs scripts written in the Automation Engine scripting language. path - /{client_id}/scripts method - post
search	findObjects	summary - Search the process assembly for objects using different filter criteria. path - /{client_id}/search method - post
system	deleteClients	summary - Delete a client path - /{client_id}/system/clients/{client_id} method - delete
system	getAgentDetails	summary - Returns detailed agent information path - /{client_id}/system/agents/{object_name} method - get
system	getFeatureList	summary - Retrieve system feature information. path - /{client_id}/system/features method - get
system	healthCheck	summary - Can be used to determine if the automation system is in a healthy state. A system is healthy if there is a PWP and at least one instance of CP and JWP respectively. When healthy, HTTP 200 is returned. When unhealthy, HTTP 503. Note: only use the HTTP status code to determine the health status since the response body is optional. path - /{client_id}/system/health method - get
system	listAgentgroups	summary - path - /{client_id}/system/agentgroups method - get
system	listAgents	summary - Lists all agents that are defined in the system. The returned list contains running and stopped agents. path - /{client_id}/system/agents method - get
system	listClients	summary - List of clients in the system. path - /{client_id}/system/clients method - get
telemetry	export	summary - Retrieve telemetry data per month as json for the last n months, including the current month. Only works for client 0. path - /{client_id}/telemetry/export/{start_from} method - get
telemetry	productList	summary - Retrieve available products path - /{client_id}/telemetry/products method - get