Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 4.17 KB

FailuresApi.md

File metadata and controls

108 lines (80 loc) · 4.17 KB

inda_hr.FailuresApi

All URIs are relative to https://api.inda.ai

Method HTTP request Description
get_failures_get GET /hr/v2/index/{indexname}/failures/ Get Failures

get_failures_get

IndexedDocumentFailuresResponse get_failures_get(indexname)

Get Failures

This method returns a list of documents that failed to be uploaded to indexname. Note that the optional query parameters (see the schema below) allow to narrow the search to a specific item or import. Users may also indicate a doc_type of interest, and retrieve just the failed documents of that type. Allowed values for the doc_type parameter are: + resume for resumes; + job-ad for job adverts; + application for applications.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import failures_api
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.indexed_document_failures_response import IndexedDocumentFailuresResponse
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# 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 Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = failures_api.FailuresApi(api_client)
    indexname = "indexname_example" # str | 
    import_id = "import_id_example" # str |  (optional)
    resume_id = "resume_id_example" # str |  (optional)
    jobad_id = "jobad_id_example" # str |  (optional)
    doc_type = "resume" # str |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get Failures
        api_response = api_instance.get_failures_get(indexname)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling FailuresApi->get_failures_get: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Failures
        api_response = api_instance.get_failures_get(indexname, import_id=import_id, resume_id=resume_id, jobad_id=jobad_id, doc_type=doc_type)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling FailuresApi->get_failures_get: %s\n" % e)

Parameters

Name Type Description Notes
indexname str
import_id str [optional]
resume_id str [optional]
jobad_id str [optional]
doc_type str [optional]

Return type

IndexedDocumentFailuresResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Failures Successfully Retrieved -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

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