This is a collection of schemas and endpoints for the various JDX, Concentric Sky facing REST endpoints, the schemas define an API contract of sorts between the request and response expectations of the JDX reference application. This API is to be mutually developed by Concentric Sky and BrightHive.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.17
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import openapi_client
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import openapi_client
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
request = openapi_client.Request() # Request | Get framework-recommendations for a given Pipeline ID. (optional)
try:
# Get framework recommendations based on the uploaded job descripton and context.
api_response = api_instance.framework_recommendations_post(request=request)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->framework_recommendations_post: %s\n" % e)
All URIs are relative to https://jdx-api.brighthive.net
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | framework_recommendations_post | POST /framework-recommendations | Get framework recommendations based on the uploaded job descripton and context. |
DefaultApi | framework_selections_post | POST /framework-selections | The user indicates what frameworks they selected |
DefaultApi | generate_job_schema_plus_post | POST /generate-job-schema-plus | Generate JobSchema+ |
DefaultApi | get_score_post | POST /get-score | Provides a scored based on how much metadata you provide and the quality of that data. |
DefaultApi | health_get | GET /health | Health Check |
DefaultApi | match_table_post | POST /match-table | Get the match table associated with the provided `pipelineID` |
DefaultApi | preview_post | POST /preview | Get preview of job description with tagged matches. |
DefaultApi | upload_job_description_context_post | POST /upload-job-description-context | Provide job description context (e.g metadata) on the job description |
DefaultApi | upload_job_description_file_post | POST /upload-job-description-file | Upload a raw job description file. |
DefaultApi | user_actions_post | POST /user-actions | Provide the user responses as a list of user actions |
- Accept
- AnnotatedDefinedTerm
- BadRequestError
- Framework
- FrameworkData
- FrameworkRecommendationResponse
- FrameworkRecommendationResponseAllOf
- FrameworkRecommendations
- FrameworkSelectionRequest
- FrameworkSelectionRequestAllOf
- FrameworkSelectionResponse
- Frameworks
- GenerateJobSchemaPlusResponse
- GeoCoordinates
- HealthResponse
- JobDescriptionContextRequest
- JobDescriptionContextRequestAllOf
- JobDescriptionContextResponse
- JobSchemaPlusFile
- JobSchemaPlusFileHumanReadable
- MatchTableRequest
- MatchTableRequestAllOf
- MatchTableResponse
- MatchTableRows
- MatchTableSelection
- PipelineScoreObject
- PipelineScoreResponse
- Place
- PostalAddress
- PreviewFields
- PreviewObject
- PreviewObjectAutofill
- PreviewResponse
- PreviewResponseAllOf
- RawJobDescriptionRequest
- RawJobDescriptionResponse
- RawJobDescriptionResponseAllOf
- Replace
- Request
- Response
- ServiceUnavailableError
- Substatements
- SubstatementsMatches
- UnsupportedMediaTypeError
- UserActionRequest
- UserActionRequestAllOf
- UserActionResponse
- ValidationError
- ValidationErrorValidationErrors
All endpoints do not require authorization.