Automic REST-API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for ufopilot from gravatar.com ufopilot

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: ufopilot
  • Requires: Python >=3.6
Classifiers

Project description

automic_rest (python client)

version coverage state automic

Automic-Rest-Client generated from AE/Swagger
https://docs.automic.com/documentation/webhelp/english/AA/12.3/DOCU/12.3/REST%20API/Automation.Engine/swagger.json

import automic_rest as automic
import base64

"""
 accessible response variables
    - url          # request url
    - body         # post body
    - headers      # response headers
    - status       # http status_code
    - content      # raw bytes
    - text         # content to string 
    - response     # content to json
"""

# init -  connection
# ----------------------------------------------------
userid="abc"
passowrd="abc"
credentials = userid + ':' + password
auth = base64.b64encode(credentials.encode()).decode()

automic.connection(
    url='https://automic-system-abc.de', 
    auth=auth,                  # base64 userid:password 
    noproxy=True,               # defalut False 
    sslverify=False,            # default True
    cert='/path/to/certfile',   # default None
    timeout=60                  # default 3600  
)

# change connection string (userid, password, url)
# ----------------------------------------------------
automic.connection(url="https://automic-system-xyz.de", sslverify=True, cert='/path/to/certfile')
  
# help
# ----------------------------------------------------
# all modules
automic.help() 
# single module
automic.help(module="listAgents")

# listExecutions 
# ----------------------------------------------------
re = automic.listExecutions(client_id=1111)
for o in re.response['data']:
    print(o['name'])

# executeObject  -  ACTIVATE_UC_OBJECT
# ----------------------------------------------------
body = {
  "object_name": "SCRI.NEW.5",
  "execution_option": "execute",
  "inputs":
  {
    "PASS#": "test"
  }
 }

re = automic.executeObject(client_id=1111, body=body)
runid = re.response['run_id']
# getExecution
# ----------------------------------------------------
re = automic.getExecution(client_id=1111, run_id=runid)
print(re.response)

# wait until execution done
# ----------------------------------------------------
import time
def get_uc_status(client, runid):
    re = automic.getExecution(client_id=client, run_id=runid)
    return re.response['status']

while get_uc_status(1111, runid) != 1900:
    time.sleep(3)

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



# list Agents
# ----------------------------------------------------
re = automic.listAgents(client_id=1111)
if re.status == 200:
    for agent in re.response['data']:
        # do some stuff
        print(agent['name'])

# productList telemetry
# ----------------------------------------------------
re = automic.productList(client_id=1111)
print(re.text)

# usageObject
# ----------------------------------------------------
re = automic.usageObject(client_id=1111, object_name='EXY.EXAM.JOBS')
print(re.response)

# activateScript
# ----------------------------------------------------
re = automic.activateScript(client_id=1111, body={"script": ":SET &VAR# = 'PYTHON is ....' \n:PRINT &VAR#"})
runid = re.response['run_id']
re = automic.listReportContent(client_id=1111, run_id=runid, report_type='ACT')
print(re.response['data'][0]['content'])

executions

changeExecutionStatus

  • summary - Changes the status of an execution.
  • path - /{client_id}/executions/{run_id}/status
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": true
    }
]
Code-Example: 
CODE

computeErtEstimations

  • summary - Get ERT estimations for the given workflow.
  • path - /{client_id}/executions/{run_id}/ert
  • method - get
Parameters: 
""
Code-Example: 
CODE

createComments

  • summary - Appends a comment to a given execution.
  • path - /{client_id}/executions/{run_id}/comments
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": true
    }
]
Code-Example: 
CODE

executeObject

  • summary - Execute an object with or without input parameters (promptsets variables).
  • path - /{client_id}/executions
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": true
    }
]
Code-Example: 
CODE

getChildrenOfExecution

  • summary - Gets all immediate execution children, ordered descending by activation_time and run_id.
  • path - /{client_id}/executions/{run_id}/children
  • method - get
Parameters: 
[
    {
        "description": "Maximum number of executions for a page result set. If this parameter is omitted the default value 50 is applied.",
        "format": "int32",
        "in": "query",
        "minimum": 1,
        "name": "max_results",
        "required": false,
        "type": "integer",
        "x-example": 50
    },
    {
        "description": "Requested page starts with execution with RunID > this parameter. If this parameter is omitted (no offset) the very first page is returned.",
        "format": "int32",
        "in": "query",
        "name": "start_at_run_id",
        "required": false,
        "type": "integer",
        "x-example": 1000030
    }
]
Code-Example: 
CODE

getExecution

  • summary - Get details of a given execution.
  • path - /{client_id}/executions/{run_id}
  • method - get
Parameters: 
[
    {
        "collectionFormat": "multi",
        "description": "Parameter to include various additional information about an execution.
comments - Includes a list of all comments that have been added to the execution
variables - Includes a list of all object variables defined at the execution's scope
reports - Includes a list of all report types of the execution
restarts - Includes the number of restarts
predecessors - Includes a list of the predecessors of a workflow task
recurring - Includes details of a C_PERIOD task",
        "in": "query",
        "items": {
            "enum": [
                "comments",
                "variables",
                "reports",
                "restarts",
                "predecessors",
                "recurring"
            ],
            "type": "string"
        },
        "name": "fields",
        "required": false,
        "type": "array"
    }
]
Code-Example: 
CODE

listComments

  • summary - List all comments for a given execution.
  • path - /{client_id}/executions/{run_id}/comments
  • method - get
Parameters: 
""
Code-Example: 
CODE

listExecutions

  • summary - List executions, ordered descending by activation_time and run_id.
  • path - /{client_id}/executions
  • method - get
Parameters: 
[
    {
        "description": "Maximum number of executions for a page result set. If this parameter is omitted the default value 50 is applied.",
        "format": "int32",
        "in": "query",
        "minimum": 1,
        "name": "max_results",
        "required": false,
        "type": "integer",
        "x-example": 50
    },
    {
        "description": "Requested page starts with execution with RunID > this parameter. If this parameter is omitted (no offset) the very first page is returned.",
        "format": "int32",
        "in": "query",
        "name": "start_at_run_id",
        "required": false,
        "type": "integer",
        "x-example": 1000030
    },
    {
        "description": "RunID of the execution.",
        "format": "int32",
        "in": "query",
        "name": "run_id",
        "required": false,
        "type": "integer",
        "x-example": 1000030
    },
    {
        "description": "Object name to query. Supports wildcards (*).",
        "in": "query",
        "name": "name",
        "required": false,
        "type": "string",
        "x-example": "SCRI.NEW.1"
    },
    {
        "description": "Exclude object name.",
        "in": "query",
        "name": "name_exclude",
        "required": false,
        "type": "boolean",
        "x-example": true
    },
    {
        "description": "Object alias to query. Supports wildcards (*).",
        "in": "query",
        "name": "alias",
        "required": false,
        "type": "string",
        "x-example": "SCRI.ALIAS.1"
    },
    {
        "collectionFormat": "multi",
        "description": "Object types to query. Supports multiple, comma-separated values. If omitted, all executable object types are used as default value.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "type",
        "required": false,
        "type": "array",
        "x-example": "SCRI"
    },
    {
        "collectionFormat": "multi",
        "description": "Status to query. Supports multiple, comma-separated values.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "status",
        "required": false,
        "type": "array",
        "x-example": "1800"
    },
    {
        "description": "Agent name to query. Supports wildcards (*).",
        "in": "query",
        "name": "agent",
        "required": false,
        "type": "string",
        "x-example": "WIN01"
    },
    {
        "description": "Exclude agent name.",
        "in": "query",
        "name": "agent_exclude",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "collectionFormat": "multi",
        "description": "Agent types to query. Supports multiple, comma-separated values.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "platform",
        "required": false,
        "type": "array",
        "x-example": "WINDOWS"
    },
    {
        "collectionFormat": "multi",
        "description": "Queues to query. Supports multiple, comma-separated values.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "queue",
        "required": false,
        "type": "array",
        "x-example": "CLIENT_QUEUE"
    },
    {
        "description": "Include deactivated executions into query.",
        "in": "query",
        "name": "include_deactivated",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "description": "Timeframe option to be used for the query. If omitted, the default value of 'all' is applied.",
        "enum": [
            "activation",
            "start",
            "end",
            "all"
        ],
        "in": "query",
        "name": "time_frame_option",
        "required": false,
        "type": "string"
    },
    {
        "description": "Timeframe lower bound to be used for the query.",
        "in": "query",
        "name": "time_frame_from",
        "pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])[T](?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)[Z]$",
        "required": false,
        "type": "string",
        "x-example": "2015-04-15T06:37:59Z"
    },
    {
        "description": "Timeframe upper bound to be used for the query.",
        "in": "query",
        "name": "time_frame_to",
        "pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])[T](?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)[Z]$",
        "required": false,
        "type": "string",
        "x-example": "2015-04-15T06:37:59Z"
    },
    {
        "description": "Username to query. Supports wildcards (*).",
        "in": "query",
        "name": "user",
        "required": false,
        "type": "string",
        "x-example": "TEST/DEP"
    },
    {
        "description": "Exclude username.",
        "in": "query",
        "name": "user_exclude",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "description": "Archive key1 to query. Supports wildcards (*).",
        "in": "query",
        "name": "archive_key1",
        "required": false,
        "type": "string",
        "x-example": "key1"
    },
    {
        "description": "Exclude archive key1.",
        "in": "query",
        "name": "archive_key1_exclude",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "description": "Archive key2 to query. Supports wildcards (*).",
        "in": "query",
        "name": "archive_key2",
        "required": false,
        "type": "string",
        "x-example": "key2"
    },
    {
        "description": "Exclude archive key2.",
        "in": "query",
        "name": "archive_key2_exclude",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "description": "Query only commented tasks.",
        "in": "query",
        "name": "commented_only",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "description": "Query only modified workflows.",
        "in": "query",
        "name": "modified_only",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "description": "Remote status text to query.",
        "format": "int32",
        "in": "query",
        "name": "remote_status_number",
        "required": false,
        "type": "integer",
        "x-example": 1200
    },
    {
        "description": "Remote status number to query.",
        "in": "query",
        "name": "remote_status_text",
        "required": false,
        "type": "string",
        "x-example": "Executed"
    },
    {
        "description": "RunID of the original execution, zero if this was not a restart.",
        "format": "int32",
        "in": "query",
        "name": "reference_run_id",
        "required": false,
        "type": "integer",
        "x-example": 1000031
    },
    {
        "description": "Query ZDU Version.",
        "enum": [
            "B",
            "T"
        ],
        "in": "query",
        "name": "zdu_version",
        "pattern": "([BT])",
        "required": false,
        "type": "string"
    },
    {
        "collectionFormat": "multi",
        "description": "Sync objects to query. Supports multiple, comma-separated values.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "sync_usage",
        "required": false,
        "type": "array",
        "x-example": "SYNC1"
    },
    {
        "collectionFormat": "multi",
        "description": "Parameter to include various additional information about an execution.
restarts - Includes the number of restarts
predecessors - Includes a list of the predecessors of a workflow taskrecurring - Includes details of a C_PERIOD task",
        "in": "query",
        "items": {
            "enum": [
                "restarts",
                "predecessors",
                "recurring"
            ],
            "type": "string"
        },
        "name": "fields",
        "required": false,
        "type": "array"
    }
]
Code-Example: 
CODE

listReportContent

  • summary - Report content pages.
  • path - /{client_id}/executions/{run_id}/reports/{report_type}
  • method - get
Parameters: 
[
    {
        "description": "Type of a execution report",
        "in": "path",
        "name": "report_type",
        "required": true,
        "type": "string"
    },
    {
        "default": 1,
        "description": "Maximum number of report pages. If this parameter is omitted the default value 1 is applied.",
        "format": "int32",
        "in": "query",
        "name": "max_results",
        "required": false,
        "type": "integer",
        "x-example": 5
    },
    {
        "default": 1,
        "description": "Response lists report pages with numbers > this parameter.",
        "format": "int32",
        "in": "query",
        "name": "start_at",
        "required": false,
        "type": "integer",
        "x-example": 3
    }
]
Code-Example: 
CODE

listReports

  • summary - Report list for a given execution.
  • path - /{client_id}/executions/{run_id}/reports
  • method - get
Parameters: 
""
Code-Example: 
CODE

listVariables

  • summary - List all variables for a given execution.
  • path - /{client_id}/executions/{run_id}/variables
  • method - get
Parameters: 
""
Code-Example: 
CODE

forecasts

createForecast

  • summary - Create a forecast.
  • path - /{client_id}/forecasts
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": true
    }
]
Code-Example: 
CODE

deleteForecast

  • summary - Delete forecasts using ids.
  • path - /{client_id}/forecasts
  • method - delete
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": false
    }
]
Code-Example: 
CODE

getForecast

  • summary - Get details of a given forecast.
  • path - /{client_id}/forecasts/{forecast_id}
  • method - get
Parameters: 
[
    {
        "description": "ID of the forecast.",
        "format": "int32",
        "in": "path",
        "name": "forecast_id",
        "pattern": "\\d+",
        "required": true,
        "type": "integer"
    },
    {
        "description": "Object name to query. Supports wildcards (*).",
        "in": "query",
        "name": "name",
        "required": false,
        "type": "string",
        "x-example": "SCRI.NEW.1"
    },
    {
        "collectionFormat": "multi",
        "description": "Object types to query. Supports multiple, comma-separated values. If omitted, all executable object types are used as default value.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "type",
        "required": false,
        "type": "array",
        "x-example": "SCRI"
    },
    {
        "description": "Logical start date lower bound to be used for the query.",
        "in": "query",
        "name": "estimated_start_from",
        "required": false,
        "type": "string",
        "x-example": "2018-02-18T10:00:00Z"
    },
    {
        "description": "Logical start date upper bound to be used for the query.",
        "in": "query",
        "name": "estimated_start_to",
        "required": false,
        "type": "string",
        "x-example": "2018-02-19T10:00:00Z"
    },
    {
        "description": "Agent name to query. Supports wildcards (*).",
        "in": "query",
        "name": "agent_destination",
        "required": false,
        "type": "string",
        "x-example": "WIN01"
    },
    {
        "description": "Source agent name to query. Supports wildcards (*).",
        "in": "query",
        "name": "agent_source",
        "required": false,
        "type": "string",
        "x-example": "WIN01"
    },
    {
        "collectionFormat": "multi",
        "description": "Agent platform to query. Supports multiple, comma-separated values.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "platform_destination",
        "required": false,
        "type": "array",
        "x-example": "WINDOWS"
    },
    {
        "collectionFormat": "multi",
        "description": "Parameter to include various additional information about a forecast.
entries - Includes a list of all entries within a forecast",
        "in": "query",
        "items": {
            "enum": [
                "entries"
            ],
            "type": "string"
        },
        "name": "fields",
        "required": false,
        "type": "array"
    }
]
Code-Example: 
CODE

listForecastAgents

  • summary - List forecast agents and gaps.
  • path - /{client_id}/forecasts/agents
  • method - get
Parameters: 
[
    {
        "description": "Agent name to query. Supports wildcards (*).",
        "in": "query",
        "name": "name",
        "required": false,
        "type": "string",
        "x-example": "WIN01"
    },
    {
        "description": "Agent types to query. Supports multiple, comma-separated values.",
        "in": "query",
        "name": "type",
        "required": false,
        "type": "string",
        "x-example": "WINDOWS"
    },
    {
        "description": "Agent version to query. Supports wildcards (*).",
        "in": "query",
        "name": "version",
        "required": false,
        "type": "string",
        "x-example": "12.3.0+low.build.1100"
    },
    {
        "description": "Timeframe lower bound to be used for the query.",
        "in": "query",
        "name": "from",
        "required": true,
        "type": "string",
        "x-example": "2015-04-15T06:37:59Z"
    },
    {
        "description": "Timeframe upper bound to be used for the query.",
        "in": "query",
        "name": "to",
        "required": true,
        "type": "string",
        "x-example": "2015-04-15T06:37:59Z"
    },
    {
        "description": "Timeframe upper bound to be used for the query.",
        "in": "query",
        "name": "execution_name",
        "required": false,
        "type": "string",
        "x-example": "2015-04-15T06:37:59Z"
    },
    {
        "description": "Minimal duration of the gap.",
        "in": "query",
        "name": "min_duration",
        "pattern": "([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?",
        "required": false,
        "type": "string",
        "x-example": "PT9H11M34S"
    }
]
Code-Example: 
CODE

listForecasts

  • summary - List all forecasts, ordered descending by start_time.
  • path - /{client_id}/forecasts
  • method - get
Parameters: 
[
    {
        "description": "Forecast title to query. Supports wildcards (*).",
        "in": "query",
        "name": "fc_title",
        "required": false,
        "type": "string",
        "x-example": "JOBP.NEW.FORECAST"
    },
    {
        "description": "Minimum start time to query.",
        "in": "query",
        "name": "fc_start_time",
        "required": false,
        "type": "string",
        "x-example": "2018-02-18T10:00:00Z"
    },
    {
        "description": "Maximum end time to query.",
        "in": "query",
        "name": "fc_end_time",
        "required": false,
        "type": "string",
        "x-example": "2018-02-19T10:00:00Z"
    },
    {
        "description": "Forecast type to query. Omit to get all types.",
        "enum": [
            "FCST",
            "AFCST"
        ],
        "in": "query",
        "name": "fc_type",
        "required": false,
        "type": "string",
        "x-example": "FCST"
    },
    {
        "description": "Object name to query. Supports wildcards (*).",
        "in": "query",
        "name": "name",
        "required": false,
        "type": "string",
        "x-example": "SCRI.NEW.1"
    },
    {
        "collectionFormat": "multi",
        "description": "Object types to query. Supports multiple, comma-separated values. If omitted, all executable object types are used as default value.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "type",
        "required": false,
        "type": "array",
        "x-example": "SCRI"
    },
    {
        "description": "Logical start date lower bound to be used for the query.",
        "in": "query",
        "name": "estimated_start_from",
        "required": false,
        "type": "string",
        "x-example": "2018-02-18T10:00:00Z"
    },
    {
        "description": "Logical start date upper bound to be used for the query.",
        "in": "query",
        "name": "estimated_start_to",
        "required": false,
        "type": "string",
        "x-example": "2018-02-19T10:00:00Z"
    },
    {
        "description": "Agent name to query. Supports wildcards (*).",
        "in": "query",
        "name": "agent_destination",
        "required": false,
        "type": "string",
        "x-example": "WIN01"
    },
    {
        "description": "Source agent name to query. Supports wildcards (*).",
        "in": "query",
        "name": "agent_source",
        "required": false,
        "type": "string",
        "x-example": "WIN01"
    },
    {
        "collectionFormat": "multi",
        "description": "Agent platform to query. Supports multiple, comma-separated values.",
        "in": "query",
        "items": {
            "type": "string"
        },
        "name": "platform_destination",
        "required": false,
        "type": "array",
        "x-example": "WINDOWS"
    },
    {
        "collectionFormat": "multi",
        "description": "Parameter to include various additional information about a forecast.
entries - Includes a list of all entries within a forecast",
        "in": "query",
        "items": {
            "enum": [
                "entries"
            ],
            "type": "string"
        },
        "name": "fields",
        "required": false,
        "type": "array"
    }
]
Code-Example: 
CODE

modifyForecast

  • summary - Changes the title of a forecast item.
  • path - /{client_id}/forecasts/{forecast_id}
  • method - post
Parameters: 
[
    {
        "description": "ID of the forecast.",
        "format": "int32",
        "in": "path",
        "name": "forecast_id",
        "required": true,
        "type": "integer"
    },
    {
        "in": "body",
        "name": "body",
        "required": true
    }
]
Code-Example: 
CODE

objects

getObjects

  • summary - Can be used to export single objects by name
  • path - /{client_id}/objects/{object_name}
  • method - get
Parameters: 
[
    {
        "collectionFormat": "multi",
        "description": "Optional list of additional fields.
modification_details - Includes modification/creation date and user name.
",
        "in": "query",
        "items": {
            "enum": [
                "modification_details"
            ],
            "type": "string"
        },
        "name": "fields",
        "required": false,
        "type": "array"
    }
]
Code-Example: 
CODE

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
Parameters: 
""
Code-Example: 
CODE

listObjectInputs

  • summary - List all inputs for a given object.
  • path - /{client_id}/objects/{object_name}/inputs
  • method - get
Parameters: 
""
Code-Example: 
CODE

postObjects

  • summary - Can be used to import single objects
  • path - /{client_id}/objects
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": false
    },
    {
        "default": false,
        "description": "Determines whether existing objects should get overwritten by the import",
        "in": "query",
        "name": "overwrite_existing_objects",
        "required": false,
        "type": "boolean",
        "x-example": true
    }
]
Code-Example: 
CODE

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
Parameters: 
[
    {
        "description": "Name of the Calendar Event.",
        "in": "path",
        "name": "event_name",
        "required": true,
        "type": "string"
    }
]
Code-Example: 
CODE

usageObject

  • 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
Parameters: 
""
Code-Example: 
CODE

ping

ping

  • summary - Can be used to determine if the JCP process is currently running.
  • path - /ping
  • method - get
Parameters: 
""
Code-Example: 
CODE

repositories

branchDiff

  • summary - Get content of two files to see their differences.
  • path - /{client_id}/repositories/branches/{branch_name}/diff
  • method - get
Parameters: 
[
    {
        "description": "Branch name where our file is located.",
        "in": "path",
        "name": "branch_name",
        "required": true,
        "type": "string",
        "x-example": "master"
    },
    {
        "description": "Branch name where their file is located.",
        "in": "query",
        "name": "branch_name_theirs",
        "required": true,
        "type": "string",
        "x-example": "dev"
    },
    {
        "description": "Path of the object on our branch which should be compared.",
        "in": "query",
        "name": "object_path_ours",
        "required": true,
        "type": "string",
        "x-example": "I.AM.CONFLICTING.SCRI"
    },
    {
        "description": "Path of the object on their branch which should be compared.",
        "in": "query",
        "name": "object_path_theirs",
        "required": true,
        "type": "string",
        "x-example": "I.AM.CONFLICTING.SCRI"
    }
]
Code-Example: 
CODE

branchLog

  • summary - Retrieves the history of the repository for max_results entries.
  • path - /{client_id}/repositories/branches/{branch_name}/log
  • method - get
Parameters: 
[
    {
        "description": "Name of the branch.",
        "in": "path",
        "name": "branch_name",
        "required": true,
        "type": "string"
    },
    {
        "description": "Maximum number of executions for a page result set. If this parameter is omitted the default value 50 is applied.",
        "format": "int32",
        "in": "query",
        "minimum": 1,
        "name": "max_results",
        "required": false,
        "type": "integer",
        "x-example": 50
    },
    {
        "description": "From which history entry paging should be started.",
        "format": "int32",
        "in": "query",
        "minimum": 0,
        "name": "start_at",
        "required": false,
        "type": "integer"
    }
]
Code-Example: 
CODE

commitChanges

  • summary - Commits only changed objects for client to repository.
  • path - /{client_id}/repositories/commits
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": false
    }
]
Code-Example: 
CODE

createBranch

  • summary - Create a new branch.
  • path - /{client_id}/repositories/branches
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": false
    }
]
Code-Example: 
CODE

createRepository

  • summary - Initializes the repository for the specified client.
  • path - /{client_id}/repositories
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": false
    }
]
Code-Example: 
CODE

deleteRepository

  • summary - Abort merging so we get out of merging state.
  • path - /{client_id}/repositories/merge
  • method - delete
Parameters: 
""
Code-Example: 
CODE

getChanges

  • summary - Returns a list of objects that have uncommitted changes.
  • path - /{client_id}/repositories/changes
  • method - get
Parameters: 
[
    {
        "collectionFormat": "multi",
        "description": "Parameter to include various additional information about changes.
total - the total number of uncommitted files.
",
        "in": "query",
        "items": {
            "enum": [
                "total"
            ],
            "type": "string"
        },
        "name": "fields",
        "required": false,
        "type": "array"
    }
]
Code-Example: 
CODE

getRepository

  • summary - Retrieves repository information for the given client.
  • path - /{client_id}/repositories
  • method - get
Parameters: 
""
Code-Example: 
CODE

listBranches

  • summary - Retrieves a list of branches.
  • path - /{client_id}/repositories/branches
  • method - get
Parameters: 
[
    {
        "description": "Maximum number of executions for a page result set. If this parameter is omitted the default value 50 is applied.",
        "format": "int32",
        "in": "query",
        "minimum": 1,
        "name": "max_results",
        "required": false,
        "type": "integer",
        "x-example": 50
    },
    {
        "description": "From which branch list entry paging should start.",
        "format": "int32",
        "in": "query",
        "minimum": 0,
        "name": "start_at",
        "required": false,
        "type": "integer"
    }
]
Code-Example: 
CODE

mergeBranchIntoActive

  • summary - Merge another branch in active branch.
  • path - /{client_id}/repositories/merge
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": false
    }
]
Code-Example: 
CODE

moveHead

  • summary - Imports version of provided GIT Hash to automation engine.
  • path - /{client_id}/repositories/commits/{commit_id}
  • method - post
Parameters: 
[
    {
        "description": "GIT Hash of the target commit.",
        "in": "path",
        "name": "commit_id",
        "required": true,
        "type": "string",
        "x-example": "1"
    }
]
Code-Example: 
CODE

pullRepository

  • summary - Pull changes from repository for active branch.
  • path - /{client_id}/repositories/pull
  • method - post
Parameters: 
[
    {
        "description": "Parameters for importing after a pull. The pull will abort if there are conflicts and overwriting is not enabled.",
        "in": "body",
        "name": "body",
        "required": true
    }
]
Code-Example: 
CODE

scripts

activateScript

  • summary - Runs scripts written in the Automation Engine scripting language.
  • path - /{client_id}/scripts
  • method - post
Parameters: 
[
    {
        "in": "body",
        "name": "body",
        "required": true
    }
]
Code-Example: 
CODE

system

deleteClients

  • summary - Delete a client
  • path - /{client_id}/system/clients/{client_id}
  • method - delete
Parameters: 
""
Code-Example: 
CODE

getAgentDetails

  • summary - Returns detailed agent information
  • path - /{client_id}/system/agents/{object_name}
  • method - get
Parameters: 
""
Code-Example: 
CODE

getFeatureList

  • summary - Retrieve system feature information.
  • path - /{client_id}/system/features
  • method - get
Parameters: 
""
Code-Example: 
CODE

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
Parameters: 
""
Code-Example: 
CODE

listAgentgroups

  • summary -
  • path - /{client_id}/system/agentgroups
  • method - get
Parameters: 
""
Code-Example: 
CODE

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
Parameters: 
[
    {
        "description": "Maximum number of executions for a page result set. If this parameter is omitted the default value 50 is applied.",
        "format": "int32",
        "in": "query",
        "minimum": 1,
        "name": "max_results",
        "required": false,
        "type": "integer",
        "x-example": 5000
    },
    {
        "description": "Filter after the name of the agent. Supports wildcards (*).",
        "in": "query",
        "name": "name",
        "required": false,
        "type": "string",
        "x-example": "WIN01"
    },
    {
        "description": "Filter after running agents.",
        "in": "query",
        "name": "active",
        "required": false,
        "type": "boolean",
        "x-example": true
    },
    {
        "description": "Filter after IP address. Supports wildcards (*).",
        "in": "query",
        "name": "ip_address",
        "required": false,
        "type": "string",
        "x-example": "10.243.20.155"
    },
    {
        "description": "Filter after the agents version. Supports wildcards (*).",
        "in": "query",
        "name": "version",
        "required": false,
        "type": "string",
        "x-example": "12.3.0+low.build.1100"
    },
    {
        "description": "Filter after the computer's hardware information. Supports wildcards (*).",
        "in": "query",
        "name": "hardware",
        "required": false,
        "type": "string",
        "x-example": "x86/2/64"
    },
    {
        "description": "Filter after the Computer's operating system. Supports wildcards (*).",
        "in": "query",
        "name": "software",
        "required": false,
        "type": "string",
        "x-example": "WinNT"
    },
    {
        "description": "Filter after agents that are linked to the service manager",
        "in": "query",
        "name": "linked",
        "required": false,
        "type": "boolean",
        "x-example": "False"
    },
    {
        "description": "Filter after agent platform (type). Supports wildcards (*).",
        "in": "query",
        "name": "platform",
        "required": false,
        "type": "string",
        "x-example": "WINDOWS"
    }
]
Code-Example: 
CODE

listClients

  • summary - List of clients in the system.
  • path - /{client_id}/system/clients
  • method - get
Parameters: 
""
Code-Example: 
CODE

telemetry

exportTelemetry

  • 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
Parameters: 
[
    {
        "description": "Timeframe lower bound to be used for the query.",
        "format": "int32",
        "in": "path",
        "name": "start_from",
        "required": true,
        "type": "integer"
    }
]
Code-Example: 
CODE

productList

  • summary - Retrieve available products
  • path - /{client_id}/telemetry/products
  • method - get
Parameters: 
""
Code-Example: 
CODE

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for ufopilot from gravatar.com ufopilot

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: ufopilot
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

This version

0.0.6

0.0.5

0.0.4

0.0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

automic_rest-0.0.6.tar.gz (34.9 kB view hashes)

Uploaded Source

Built Distribution

automic_rest-0.0.6-py3-none-any.whl (61.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page