Skip to content

JobsApi.md

Latest commit

 

History

History
98 lines (74 loc) · 3.54 KB

JobsApi.md

File metadata and controls

98 lines (74 loc) · 3.54 KB

Avalara.SDK.JobsApi

All URIs are relative to https://api.sbx.avalara.com/avalara1099

Method HTTP request Description
get_job GET /jobs/{id} Retrieves information about the job

get_job

JobResponse get_job(id, avalara_version)

Retrieves information about the job

Retrieves information about the job

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import jobs_api
JobResponse
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 'id_example' # str | Job id obtained from other API responses, like `/1099/bulk-upsert`.
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = '404add46-17ce-4740-8684-de29503d6500' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    # example passing only required values which don't have defaults set
    try:
        # Retrieves information about the job
        api_response = api_instance.get_job(id, avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling JobsApi->get_job: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Retrieves information about the job
        api_response = api_instance.get_job(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling JobsApi->get_job: %s\n" % e)

Parameters

Name Type Description Notes
id str Job id obtained from other API responses, like `/1099/bulk-upsert`.
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

JobResponse

Authorization

bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Server Error -
401 Unauthorized -

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