Joins Jobs¶

/api/repositories/(string:repository)/joins/joinjobs

Parameter	Type	Purpose
repository	string	the name of the Repository

Count¶

GET /api/repositories/(string: repository)/joins/joinjobs/count¶: Returns the number of join jobs in the repository.

Response Code	Reason
200	No error
500	Server error

The response contains the number of join jobs in the repository.

{
    "count": "12"
}

Show All¶

GET /api/repositories/(string: repository)/joins/joinjobs¶

GET /api/repositories/jupiter/joins/joinjobs HTTP/1.1
Accept: application/json

Response Code	Reason
200	No error
500	Server error

The columns displayed are:

Human Name	Column Name	Description
JOB_ID	Ref	Job reference Id
_job_name	Name	Job reference name
JOB_CREATE_USER	Created by	User who created this job
_entities	Entities Analyzed	Number of entities analyzed
ORIGINAL	Original Joins	Total number of joins originally discovered by this job
DISCOVERED	Joins Discovered	Number of discovered joins still to be analyzed
DELETED	Joins Deleted	The number of joins deleted
PERMANENT	Joins Permanent	The number of joins made permanent
_pc_reviewed	Reviewed	The percentage of joins reviewed
_created_date	Date Completed	When the job was completed

The dataRow array will contain a list of the join joibs in the Repository:

"dataRow": [
     "116",
     "restjob",
     "",
     "0",
     "1",
     "0",
     "1",
     "0",
     "100.0%",
     "2016/08/08 06:59:07"
   ]

The response will be a Standard Response, with a list of values on the right hand side that did not join.

Show Some¶

POST /api/repositories/(string: repository)/joins/joinjobs¶

Lists join jobs in the repository that match various criteria

JSON Parameters:
	body – The request body

POST /api/repositories/jupiter/joins/joinjobs HTTP/1.1
Content-Type: application/json

{
    "command": "get",
    "options": {
        "where": "'Joins Permanent' > 0"
    }
}

Response Code	Reason
200	Success
500	Server error

The request requires a Standard Request packet. Available commands are:

Command	Description
get	Lists all joins in the repository that match the criteria in Options

The response will be a Standard Response, with a list of Joins Jobs in the Repository matching the given criteria in Options.

Delete¶

POST /api/repositories/{repository}/joins/joinjobs¶: Delete the join jobs

POST /api/repositories/alpha/joins/joinjobs HTTP/1.1
Content-Type: application/json

{
    "command": "delete",
    "data": {
        "jobId":["18", "19"]
    }
}

Response Code	Reason
204	Success
400	Invalid parameters
500	Server error

The delete packet must contain the command and data elements. The following fields should be sent as part of data:

Field	Purpose
jobId	A join job result key. The value of individual key should be similar to the ‘Ref’/JOB_ID column returned from Joins Jobs

Export¶

POST /api/repositories/{repository}/joins/joinjobs¶: Some or all of the join jobs may be exported as a scheduled task.

POST /api/repositories/(string:repository)/joins/joinjobs HTTP/1.1
Content-type:: application/json

{
    "command": "export",
    "options": {
        "where": "Name = \"j3\""
    },
    "data": {
        "filename": "filename.csv"
    }
}

When export is required, the filename for the exported file must be specified. The file will be exported in CSV format using the native encoding of the server.

Response Code	Reason
200	No error
500	Server error

The response will contain the URL of the scheduled task and the link to download the exported file.

{
    "job": "/api/repositories/jupiter/scheduler/1",
    "file": "/api/repositories/jupiter/download/filename.csv"
}

TSS REST API