Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 3.38 KB

SyncStatusApi.md

File metadata and controls

96 lines (68 loc) · 3.38 KB
Raw

MergeATSClient.SyncStatusApi

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

Method HTTP request Description
sync_status_list GET /sync-status

sync_status_list

PaginatedSyncStatusList sync_status_list(x_account_token)

Get syncing status. Possible values: DISABLED, DONE, FAILED, PAUSED, SYNCING

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeATSClient
from MergeATSClient.api import sync_status_api
from MergeATSClient.model.paginated_sync_status_list import PaginatedSyncStatusList
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 = sync_status_api.SyncStatusApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" # str | The pagination cursor value. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.sync_status_list(x_account_token, cursor=cursor, page_size=page_size)
        pprint(api_response)
    except MergeATSClient.ApiException as e:
        print("Exception when calling SyncStatusApi->sync_status_list: %s\n" % e)

Parameters

Name Type Description Notes
x_account_token str Token identifying the end user.
cursor str The pagination cursor value. [optional]
page_size int Number of results to return per page. [optional]

Return type

PaginatedSyncStatusList

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]