5 Loader API

This section describes the APIs for OHPM loaders. It contains the following topics:

Section 5.1, "Fetch Job Status and Log"
Section 5.2, "Data Ingestion with Loaders"

5.1 Fetch Job Status and Log

You can view the latest job status (running or completed), progress and the completion status (success or failure). If the job failed, you can see more information on the error by referring the job logs.

For Authorization, provide a user that is in the allowed role (pm_admin_group)

5.1.1 Job Status

This provides the current status for the Loader Job.

PATH	<server url>/trc/opmconfigapi/v1.0/config/loader/jobstatus/{jobId}
ACCEPTS	application/json
RETURNS	application/json
METHOD	GET

Response

Code	Reason		Representation (Example)
200	success		{ "status": "COMPLETE", "links": [ { "rel": "logs", "href": "/trc/opmconfigapi/v1.0/config/loader/jobstatus/{jobId}/logs" } ] }
500	error	error message object

5.1.2 Job Log

This provides detailed log information for the job.

PATH	<server url>/trc/opmconfigapi/v1.0/config/loader/jobstatus/{jobId}/logs
ACCEPTS	application/json
RETURNS	application/json
METHOD	GET

Response

Code	Reason		Representation (Example)
200	success		[ { "insertDate": string, "logDetail": string, "errorCode": string, "errorInfo": string } ]
500	error	error message object

5.2 Data Ingestion with Loaders

5.2.1 Preferred Transcript Loader

Loads the preferred transcript data files into the OHPM environment.

Allowed Roles for API: pm_admin_group

Loader Procedure: load_pref_transcr_stg

PATH	<server url>/trc/opmconfigapi/v1.0/config/loader/preferred-transcript
ACCEPTS	application/json
RETURNS	application/json
METHOD	POST

Request

PARAMETER	DESCRIPTION	PARAMETER TYPE	DATA TYPE/ REPRESENTATION
body		body	{ "file": "{bucketName}/{objectName}", "readSize":Number, "fullRefresh" : boolean }

readSize is optional in the request
fullRefresh is optional and if not specified, the default value is false.

Note:

For the file input parameter, specify the bucketName and objectName that was used in the File Upload Service when uploading the file. If you have manually uploaded the file, then directly specify the file name.

Example

{
    "file":"mypreferred/preferred_transcript_2020"
    "readSize" : 8
}

Response

Code	Reason	Representation (Example)
200	success	HTTP/1.1 202 Accepted Location: /trc/opmconfigapi/v1.0/config/loader/jobstatus/{jobId} Note: The `Location` points to the URI for the JobId. Use this to fetch the job status.
500	error	error message object