Skip to content

Latest commit

 

History

History
185 lines (135 loc) · 7.89 KB

IssuesApi.md

File metadata and controls

185 lines (135 loc) · 7.89 KB
Raw

MergeATSClient.IssuesApi

All URIs are relative to https://api.merge.dev/api/ats/v1

Method HTTP request Description
issues_list GET /issues
issues_retrieve GET /issues/{id}

issues_list

PaginatedIssueList issues_list()

Gets issues.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeATSClient
from MergeATSClient.api import issues_api
from MergeATSClient.model.paginated_issue_list import PaginatedIssueList
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeATSClient.Configuration(
    host = "https://api.merge.dev/api/ats/v1"
)

# 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: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with MergeATSClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = issues_api.IssuesApi(api_client)
    account_token = "account_token_example" # str |  (optional)
    cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" # str | The pagination cursor value. (optional)
    end_date = "end_date_example" # str | If included, will only include issues whose most recent action occurred before this time (optional)
    end_user_organization_name = "end_user_organization_name_example" # str |  (optional)
    first_incident_time_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return issues whose first incident time was after this datetime. (optional)
    first_incident_time_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return issues whose first incident time was before this datetime. (optional)
    include_muted = "include_muted_example" # str | If True, will include muted issues (optional)
    integration_name = "integration_name_example" # str |  (optional)
    last_incident_time_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return issues whose first incident time was after this datetime. (optional)
    last_incident_time_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime, none_type | If provided, will only return issues whose first incident time was before this datetime. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    start_date = "start_date_example" # str | If included, will only include issues whose most recent action occurred after this time (optional)
    status = "ONGOING" # str |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.issues_list(account_token=account_token, cursor=cursor, end_date=end_date, end_user_organization_name=end_user_organization_name, first_incident_time_after=first_incident_time_after, first_incident_time_before=first_incident_time_before, include_muted=include_muted, integration_name=integration_name, last_incident_time_after=last_incident_time_after, last_incident_time_before=last_incident_time_before, page_size=page_size, start_date=start_date, status=status)
        pprint(api_response)
    except MergeATSClient.ApiException as e:
        print("Exception when calling IssuesApi->issues_list: %s\n" % e)

Parameters

Name Type Description Notes
account_token str [optional]
cursor str The pagination cursor value. [optional]
end_date str If included, will only include issues whose most recent action occurred before this time [optional]
end_user_organization_name str [optional]
first_incident_time_after datetime, none_type If provided, will only return issues whose first incident time was after this datetime. [optional]
first_incident_time_before datetime, none_type If provided, will only return issues whose first incident time was before this datetime. [optional]
include_muted str If True, will include muted issues [optional]
integration_name str [optional]
last_incident_time_after datetime, none_type If provided, will only return issues whose first incident time was after this datetime. [optional]
last_incident_time_before datetime, none_type If provided, will only return issues whose first incident time was before this datetime. [optional]
page_size int Number of results to return per page. [optional]
start_date str If included, will only include issues whose most recent action occurred after this time [optional]
status str [optional]

Return type

PaginatedIssueList

Authorization

tokenAuth

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]

issues_retrieve

Issue issues_retrieve(id)

Get a specific issue.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeATSClient
from MergeATSClient.api import issues_api
from MergeATSClient.model.issue import Issue
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeATSClient.Configuration(
    host = "https://api.merge.dev/api/ats/v1"
)

# 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: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with MergeATSClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = issues_api.IssuesApi(api_client)
    id = "id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.issues_retrieve(id)
        pprint(api_response)
    except MergeATSClient.ApiException as e:
        print("Exception when calling IssuesApi->issues_retrieve: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

Issue

Authorization

tokenAuth

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]