Communication APIs

The webservice list end points for

• jobs to be submitted to LINK(s)


• fetching submitted job result and step


• Link(s) to upload job result


• Link(s) to download job packets and upload results

Workflow for LINK(s)

Step 1: Download job packet

Communication API task clients can down the next distribution code jobs by using the end point

GET /task/nextjob/{collectionId}

Step 2: Upload job results to Communication API webservice

LINK(s) need to return the distribution code job results with the following communication APIs end points

POST /task/resultfile/{uuid}/{collectionId}

POST /task/result/{uuid}/{collectionid}

The above endpoints needs to used as the follows

Workflow 1: When response file content is large or has sensitive data

Step 1: upload large result file(s) or sensitive data file(s) with the following end point

/task/resultfile/{uuid}/{collectionId}

Step 2: Post json "result" payload with the following end point, where, setting "query_result.files" to empty array

/task/result/{uuid}/{collectionid}

Workflow 2: When response file content is not large or does not have sensitive data

Post json "Result" payload by setting response file as base64 encoded string to json key "query_result.files.file_data"

/task/result/{uuid}/{collectionid}

How to encode response file with base64 encoding and set "query_result.files.file_data" with encoded data?
For example,

➜ cat demographics.distribution
BIOBANK CODE DESCRIPTION COUNT MIN Q1 MEDIAN MEAN Q3 MAX ALTERNATIVES DATASET OMOP OMOP_DESCR CATEGORY
FI_DEMOCOL1 SEX Sex 984 ^Male|452^Female|532^ person NA NA Demographic
FI_DEMOCOL1 GENOMICS Genomics data 1005 ^No|1005^Imputed whole genome data|0^ personNA NA Demographic

➜ base64 demographics.distribution
QklPQkFOSwlDT0RFCURFU0NSSVBUSU9OCUNPVU5UCU1JTglRMQlNRURJQU4JTUVBTglRMwlNQVgJQUxURVJOQVRJVkVTCURBVEFTRVQJT01PUAlPTU9QX0RFU0NSCUNBVEVHT1JZCkZJX0RFTU9DT0wxCVNFWAlTZXgJOTg0CQkJCQkJCV5NYWxlfDQ1Ml5GZW1hbGV8NTMyXglwZXJzb24JTkEJTkEJRGVtb2dyYXBoaWMKRklfREVNT0NPTDEJR0VOT01JQ1MJR2Vub21pY3MgZGF0YQkxMDA1CQkJCQkJCV5Ob3wxMDA1XkltcHV0ZWQgd2hvbGUgZ2Vub21lIGRhdGF8MF4JcGVyc29uCU5BCU5BCURlbW9ncmFwaGljCg==

In json response payload:
query_result.files.file_data="QklPQkFOSwlDT0RFCURFU0NSSVBUSU9OCUNPVU5UCU1JTglRMQlNRURJQU4JTUVBTglRMwlNQVgJQUxURVJOQVRJVkVTCURBVEFTRVQJT01PUAlPTU9QX0RFU0NSCUNBVEVHT1JZCkZJX0RFTU9DT0wxCVNFWAlTZXgJOTg0CQkJCQkJCV5NYWxlfDQ1Ml5GZW1hbGV8NTMyXglwZXJzb24JTkEJTkEJRGVtb2dyYXBoaWMKRklfREVNT0NPTDEJR0VOT01JQ1MJR2Vub21pY3MgZGF0YQkxMDA1CQkJCQkJCV5Ob3wxMDA1XkltcHV0ZWQgd2hvbGUgZ2Vub21lIGRhdGF8MF4JcGVyc29uCU5BCU5BCURlbW9ncmFwaGljCg=="