openapi_client.DefaultApi

All URIs are relative to https://jdx-api.brighthive.net

Method	HTTP request	Description
framework_recommendations_post	POST /framework-recommendations	Get framework recommendations based on the uploaded job descripton and context.
framework_selections_post	POST /framework-selections	The user indicates what frameworks they selected
generate_job_schema_plus_post	POST /generate-job-schema-plus	Generate JobSchema+
get_score_post	POST /get-score	Provides a scored based on how much metadata you provide and the quality of that data.
health_get	GET /health	Health Check
match_table_post	POST /match-table	Get the match table associated with the provided `pipelineID`
preview_post	POST /preview	Get preview of job description with tagged matches.
upload_job_description_context_post	POST /upload-job-description-context	Provide job description context (e.g metadata) on the job description
upload_job_description_file_post	POST /upload-job-description-file	Upload a raw job description file.
user_actions_post	POST /user-actions	Provide the user responses as a list of user actions

framework_recommendations_post

FrameworkRecommendationResponse framework_recommendations_post(request=request)

Get framework recommendations based on the uploaded job descripton and context.

Example

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()
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)

Parameters

Name	Type	Description	Notes
request	Request	Get framework-recommendations for a given Pipeline ID.	[optional]

Return type

FrameworkRecommendationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Provides a list of frameworks, including competencies, occupation and industries, that the user may choose from (one or more).	-
422	Validation error.	-
400	Bad Request error	-
415	Unsupported media type	-
503	Service unavailable	-

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

framework_selections_post

Response framework_selections_post(framework_selection_request=framework_selection_request)

The user indicates what frameworks they selected

Example

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()
framework_selection_request = openapi_client.FrameworkSelectionRequest() # FrameworkSelectionRequest | framework selections (optional)

try:
    # The user indicates what frameworks they selected
    api_response = api_instance.framework_selections_post(framework_selection_request=framework_selection_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->framework_selections_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
framework_selection_request	FrameworkSelectionRequest	framework selections	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Stored the context object associated with `pipelineID`	-
422	Validation error.	-
400	Bad Request error	-
415	Unsupported media type	-
503	Service unavailable	-

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

generate_job_schema_plus_post

GenerateJobSchemaPlusResponse generate_job_schema_plus_post(request=request)

Generate JobSchema+

Example

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()
request = openapi_client.Request() # Request | Generate JobSchema+ from a given pipeline_id (optional)

try:
    # Generate JobSchema+
    api_response = api_instance.generate_job_schema_plus_post(request=request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->generate_job_schema_plus_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	Request	Generate JobSchema+ from a given pipeline_id	[optional]

Return type

GenerateJobSchemaPlusResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	JobSchema+ file	-
422	Validation error.	-
400	Bad Request error	-
415	Unsupported media type	-
503	Service unavailable	-

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

get_score_post

PipelineScoreResponse get_score_post(request=request)

Provides a scored based on how much metadata you provide and the quality of that data.

Example

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()
request = openapi_client.Request() # Request | Get score for a given Pipeline ID. (optional)

try:
    # Provides a scored based on how much metadata you provide and the quality of that data.
    api_response = api_instance.get_score_post(request=request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_score_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	Request	Get score for a given Pipeline ID.	[optional]

Return type

PipelineScoreResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Provides a score for your pipeline work.	-
422	Validation error.	-
400	Bad Request error	-
415	Unsupported media type	-
503	Service unavailable	-

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

health_get

HealthResponse health_get()

Health Check

The health check endpoint can be used to check if the API is up. If the API is running it will return a 200 OK response.

Example

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()

try:
    # Health Check
    api_response = api_instance.health_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->health_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The API is up!	-

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

match_table_post

MatchTableResponse match_table_post(match_table_request=match_table_request)

Get the match table associated with the provided pipelineID

Example

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()
match_table_request = openapi_client.MatchTableRequest() # MatchTableRequest | Get framework-recommendations for a given Pipeline ID. (optional)

try:
    # Get the match table associated with the provided `pipelineID`
    api_response = api_instance.match_table_post(match_table_request=match_table_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->match_table_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
match_table_request	MatchTableRequest	Get framework-recommendations for a given Pipeline ID.	[optional]

Return type

MatchTableResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Provides a match table with `uuid` references along with a json-ld object. The json-ld object contains `uuid`'s that reference into the match table, for instance, containing a list of possble competencies that the user should be asked to choose among, reject or approve one of.	-
422	Validation error.	-
400	Bad Request error	-
415	Unsupported media type	-
503	Service unavailable	-

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

preview_post

PreviewResponse preview_post(request=request)

Get preview of job description with tagged matches.

Example

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()
request = openapi_client.Request() # Request | Get preview of job description wth tagged matches. (optional)

try:
    # Get preview of job description with tagged matches.
    api_response = api_instance.preview_post(request=request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->preview_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	Request	Get preview of job description wth tagged matches.	[optional]

Return type

PreviewResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Provides a chunked job description with matches that refer to the given paragraph chunks.	-
422	Validation error.	-
400	Bad Request error	-
415	Unsupported media type	-
503	Service unavailable	-

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

upload_job_description_context_post

JobDescriptionContextResponse upload_job_description_context_post(job_description_context_request=job_description_context_request)

Provide job description context (e.g metadata) on the job description

Example

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()
job_description_context_request = openapi_client.JobDescriptionContextRequest() # JobDescriptionContextRequest | job description context (optional)

try:
    # Provide job description context (e.g metadata) on the job description
    api_response = api_instance.upload_job_description_context_post(job_description_context_request=job_description_context_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->upload_job_description_context_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_description_context_request	JobDescriptionContextRequest	job description context	[optional]

Return type

JobDescriptionContextResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Stored the context object associated with `pipelineID`	-
400	Bad Request	-
404	Pipeline was not found	-
422	Validation error	-
500	Internal server error	-
503	Service is down	-

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

upload_job_description_file_post

RawJobDescriptionResponse upload_job_description_file_post(file=file)

Upload a raw job description file.

Example

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()
file = '/path/to/file' # file | The file to upload (optional)

try:
    # Upload a raw job description file.
    api_response = api_instance.upload_job_description_file_post(file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->upload_job_description_file_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
file	file	The file to upload	[optional]

Return type

RawJobDescriptionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Created. A pipeline was created and the provided job description was converted to text and attached to the pipeline.	-
400	Bad Request	-
422	Validation error	-
500	Internal server error	-

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

user_actions_post

Response user_actions_post(user_action_request=user_action_request)

Provide the user responses as a list of user actions

Example

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()
user_action_request = openapi_client.UserActionRequest() # UserActionRequest | Contains a list of user responses (optional)

try:
    # Provide the user responses as a list of user actions
    api_response = api_instance.user_actions_post(user_action_request=user_action_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->user_actions_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_action_request	UserActionRequest	Contains a list of user responses	[optional]

Return type

Response

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The user actions response object	-
422	Validation error.	-
400	Bad Request error	-
415	Unsupported media type	-
503	Service unavailable	-

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

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

openapi_client.DefaultApi

framework_recommendations_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

framework_selections_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

generate_job_schema_plus_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_score_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

health_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

match_table_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

preview_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

upload_job_description_context_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

upload_job_description_file_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_actions_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details