Skip to content

Latest commit

 

History

History
executable file
·
335 lines (223 loc) · 9.46 KB

JobstepApi.md

File metadata and controls

executable file
·
335 lines (223 loc) · 9.46 KB

epiccore.JobstepApi

All URIs are relative to https://epic.zenotech.com/api/v2

Method HTTP request Description
jobstep_cancel POST /jobstep/{id}/cancel/
jobstep_list GET /jobstep/
jobstep_logs_read GET /jobstep/{id}/logs/
jobstep_read GET /jobstep/{id}/

jobstep_cancel

jobstep_cancel(id, data)

Cancel job step with ID {id}

Example

  • Api Key Authentication (Bearer):
import time
import os
import epiccore
from epiccore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://epic.zenotech.com/api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with epiccore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = epiccore.JobstepApi(api_client)
    id = 'id_example' # str | 
    data = None # object | 

    try:
        api_instance.jobstep_cancel(id, data)
    except Exception as e:
        print("Exception when calling JobstepApi->jobstep_cancel: %s\n" % e)

Parameters

Name Type Description Notes
id str
data object

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 Cancel request received -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobstep_list

JobstepList200Response jobstep_list(parent_job=parent_job, limit=limit, offset=offset)

List all the job steps you have read permission for

Example

  • Api Key Authentication (Bearer):
import time
import os
import epiccore
from epiccore.models.jobstep_list200_response import JobstepList200Response
from epiccore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://epic.zenotech.com/api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with epiccore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = epiccore.JobstepApi(api_client)
    parent_job = 'parent_job_example' # str | Filter by ID of the parent Job (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)

    try:
        api_response = api_instance.jobstep_list(parent_job=parent_job, limit=limit, offset=offset)
        print("The response of JobstepApi->jobstep_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobstepApi->jobstep_list: %s\n" % e)

Parameters

Name Type Description Notes
parent_job str Filter by ID of the parent Job [optional]
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]

Return type

JobstepList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobstep_logs_read

JobLog jobstep_logs_read(id)

Get the logs for the job step with ID {id}

Example

  • Api Key Authentication (Bearer):
import time
import os
import epiccore
from epiccore.models.job_log import JobLog
from epiccore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://epic.zenotech.com/api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with epiccore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = epiccore.JobstepApi(api_client)
    id = 'id_example' # str | 

    try:
        api_response = api_instance.jobstep_logs_read(id)
        print("The response of JobstepApi->jobstep_logs_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobstepApi->jobstep_logs_read: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

JobLog

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobstep_read

JobStepDetails jobstep_read(id)

See the details for the job step with ID {id}

Example

  • Api Key Authentication (Bearer):
import time
import os
import epiccore
from epiccore.models.job_step_details import JobStepDetails
from epiccore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://epic.zenotech.com/api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'

# Enter a context with an instance of the API client
with epiccore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = epiccore.JobstepApi(api_client)
    id = 'id_example' # str | 

    try:
        api_response = api_instance.jobstep_read(id)
        print("The response of JobstepApi->jobstep_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobstepApi->jobstep_read: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

JobStepDetails

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]