Control Plane API (0.0.1-alpha.0.0)

Download OpenAPI specification:

Control Plane API

Approval

/api/Approval/GetMemberships

Authorizations:
Bearer
query Parameters
projectId
integer <int32>
showOnlyUnprocessed
boolean

Responses

Response samples

Content type
No sample

/api/Approval/GetAllTreProjects

Authorizations:
Bearer
query Parameters
showOnlyUnprocessed
boolean

Responses

Response samples

Content type
No sample

/api/Approval/GetTreProject

Authorizations:
Bearer
query Parameters
projectId
integer <int32>

Responses

Response samples

Content type
No sample

/api/Approval/GetAllActiveTreProjects

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Approval/GetAllTreUsers

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Approval/GetAllActiveTreUsers

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Approval/GetAllMembershipDecisions

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Approval/GetAllActiveMembershipDecisions

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Approval/GetAllUndecidedMembershipDecisions

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Approval/UpdateProjects

Authorizations:
Bearer
Request Body schema:
Array
error
boolean
errorMessage
string or null
id
integer <int32>
submissionProjectId
integer <int32>
userName
string or null
password
string or null
submissionProjectName
string or null
description
string or null
Array of objects or null (TreMembershipDecision)
localProjectName
string or null
decision
integer <int32> (Decision)
Enum: 0 1 2
archived
boolean
approvedBy
string or null
lastDecisionDate
string <date-time>
projectExpiryDate
string <date-time>
submissionBucketTre
string or null
outputBucketTre
string or null
Array of objects or null (TreAuditLog)
outputBucketSub
string or null

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/api/Approval/UpdateMembershipDecisions

Authorizations:
Bearer
Request Body schema:
Array
error
boolean
errorMessage
string or null
id
integer <int32>
object (TreUser)
object (TreProject)
archived
boolean
decision
integer <int32> (Decision)
Enum: 0 1 2
projectExpiryDate
string <date-time>
approvedBy
string or null
lastDecisionDate
string <date-time>
Array of objects or null (TreAuditLog)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/api/Approval/SyncSubmissionWithTre

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

DEBUGHasura

/api/DEBUGHasura/RunHasuraSetup

Authorizations:
Bearer

Responses

/api/DEBUGHasura/DoSyncWork

Authorizations:
Bearer

Responses

/api/DEBUGHasura/DoAgentWork

Authorizations:
Bearer

Responses

HasuraAuthentication

/api/HasuraAuthentication

Authorizations:
Bearer
header Parameters
Token
string

Responses

Response samples

Content type
No sample

OPA

/api/OPA/TokenPlease/{pass}/{name}

Authorizations:
Bearer
path Parameters
pass
required
string
name
required
string

Responses

/api/OPA/UpdateOPA

Authorizations:
Bearer

Responses

/api/OPA/BundleGetv2/{ServiceName}/{Resource}

Authorizations:
Bearer
path Parameters
ServiceName
required
string
Resource
required
string

Responses

/api/OPA/BundleGet/{ServiceName}/{Resource}

Authorizations:
Bearer
path Parameters
ServiceName
required
string
Resource
required
string

Responses

/api/OPA/CheckUserAccess

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Submission

/api/Submission/IsUserApprovedOnProject

Authorizations:
Bearer
query Parameters
projectId
integer <int32>
userId
integer <int32>

Responses

Response samples

Content type
No sample

/api/Submission/GetWaitingSubmissionsForTre

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Submission/UpdateStatusForTre

Authorizations:
Bearer
query Parameters
subId
string
statusType
integer <int32> (StatusType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
description
string

Responses

Response samples

Content type
No sample

/api/Submission/GetOutputBucketInfo

Authorizations:
Bearer
query Parameters
subId
string

Responses

Response samples

Content type
No sample

/api/Submission/FilesReadyForReview

Authorizations:
Bearer
Request Body schema:
subId
string or null
files
Array of strings or null
tesId
string or null
name
string or null

Responses

Request samples

Content type
{
  • "subId": "string",
  • "files": [
    ],
  • "tesId": "string",
  • "name": "string"
}

Response samples

Content type
No sample

/api/Submission/EgressResults

Authorizations:
Bearer
Request Body schema:
subId
string or null
Array of objects or null (EgressResult)
outputBucket
string or null

Responses

Request samples

Content type
{
  • "subId": "string",
  • "fileResults": [
    ],
  • "outputBucket": "string"
}

Response samples

Content type
No sample

/api/Submission/FinalOutcome

Authorizations:
Bearer
Request Body schema:
subId
string or null
file
string or null

Responses

Request samples

Content type
{
  • "subId": "string",
  • "file": "string"
}

Response samples

Content type
No sample

/api/Submission/SendSubmissionToHUTCH

Authorizations:
Bearer
Request Body schema:
error
boolean
errorMessage
string or null
id
integer <int32>
parentId
integer or null <int32>
tesId
string or null
sourceCrate
string or null
tesName
string or null
tesJson
string or null
finalOutputFile
string or null
dockerInputLocation
string or null
object (Project)
parent
object (Submission) Recursive
children
Array of objects or null (Submission)
Array of objects or null (HistoricStatus)
Array of objects or null (StageInfo)
Array of objects or null (SubmissionFile)
Array of objects or null (AuditLog)
object (Tre)
object (User)
lastStatusUpdate
string <date-time>
startTime
string <date-time>
endTime
string <date-time>
status
integer <int32> (StatusType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
statusDescription
string or null
queryToken
string or null

Responses

Request samples

Content type
{
  • "error": true,
  • "errorMessage": "string",
  • "id": 0,
  • "parentId": 0,
  • "tesId": "string",
  • "sourceCrate": "string",
  • "tesName": "string",
  • "tesJson": "string",
  • "finalOutputFile": "string",
  • "dockerInputLocation": "string",
  • "project": {
    },
  • "parent": { },
  • "children": [
    ],
  • "historicStatuses": [
    ],
  • "stageInfo": [
    ],
  • "submissionFiles": [
    ],
  • "auditLogs": [
    ],
  • "tre": {
    },
  • "submittedBy": {
    },
  • "lastStatusUpdate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "statusDescription": "string",
  • "queryToken": "string"
}

/api/Submission/SimulateSubmissionProcessing

Authorizations:
Bearer
Request Body schema:
error
boolean
errorMessage
string or null
id
integer <int32>
parentId
integer or null <int32>
tesId
string or null
sourceCrate
string or null
tesName
string or null
tesJson
string or null
finalOutputFile
string or null
dockerInputLocation
string or null
object (Project)
parent
object (Submission) Recursive
children
Array of objects or null (Submission)
Array of objects or null (HistoricStatus)
Array of objects or null (StageInfo)
Array of objects or null (SubmissionFile)
Array of objects or null (AuditLog)
object (Tre)
object (User)
lastStatusUpdate
string <date-time>
startTime
string <date-time>
endTime
string <date-time>
status
integer <int32> (StatusType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
statusDescription
string or null
queryToken
string or null

Responses

Request samples

Content type
{
  • "error": true,
  • "errorMessage": "string",
  • "id": 0,
  • "parentId": 0,
  • "tesId": "string",
  • "sourceCrate": "string",
  • "tesName": "string",
  • "tesJson": "string",
  • "finalOutputFile": "string",
  • "dockerInputLocation": "string",
  • "project": {
    },
  • "parent": { },
  • "children": [
    ],
  • "historicStatuses": [
    ],
  • "stageInfo": [
    ],
  • "submissionFiles": [
    ],
  • "auditLogs": [
    ],
  • "tre": {
    },
  • "submittedBy": {
    },
  • "lastStatusUpdate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "statusDescription": "string",
  • "queryToken": "string"
}

/api/Submission/GetRequestCancelSubsForTre

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Submission/CloseSubmissionForTre

Authorizations:
Bearer
query Parameters
subId
string
statusType
integer <int32> (StatusType)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
finalFile
string
description
string

Responses

Response samples

Content type
No sample

/api/Submission/GetAllSubmissions

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Submission/TestSubRabbitSendRemoveBeforeDeploy

Authorizations:
Bearer
query Parameters
id
integer <int32>

Responses

/api/Submission/GetASubmission/{submissionId}

Authorizations:
Bearer
path Parameters
submissionId
required
integer <int32>

Responses

Response samples

Content type
No sample

/api/Submission/StageTypes

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Submission/DownloadFile

Authorizations:
Bearer
query Parameters
submissionId
integer <int32>

Responses

/api/Submission/SaveSubmissionFiles

Authorizations:
Bearer
query Parameters
submissionId
integer <int32>
Request Body schema:
Array
id
integer <int32>
name
string or null
treBucketFullPath
string or null
submisionBucketFullPath
string or null
status
integer <int32> (FileStatus)
Enum: 0 1 2
description
string or null
object (Submission)

Responses

Request samples

Content type
[
  • {
    }
]

SubmissionCredentials

/api/SubmissionCredentials/CheckCredentialsAreValid

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/SubmissionCredentials/UpdateCredentials

Authorizations:
Bearer
Request Body schema:
error
boolean
errorMessage
string or null
id
integer <int32>
userName
required
string non-empty
passwordEnc
required
string non-empty
confirmPassword
string or null
credentialType
integer <int32> (CredentialType)
Enum: 0 1 2
valid
boolean

Responses

Request samples

Content type
{
  • "error": true,
  • "errorMessage": "string",
  • "id": 0,
  • "userName": "string",
  • "passwordEnc": "string",
  • "confirmPassword": "string",
  • "credentialType": 0,
  • "valid": true
}

Response samples

Content type
No sample

TRECredentials

/api/TRECredentials/CheckCredentialsAreValid

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/TRECredentials/UpdateCredentials

Authorizations:
Bearer
Request Body schema:
error
boolean
errorMessage
string or null
id
integer <int32>
userName
required
string non-empty
passwordEnc
required
string non-empty
confirmPassword
string or null
credentialType
integer <int32> (CredentialType)
Enum: 0 1 2
valid
boolean

Responses

Request samples

Content type
{
  • "error": true,
  • "errorMessage": "string",
  • "id": 0,
  • "userName": "string",
  • "passwordEnc": "string",
  • "confirmPassword": "string",
  • "credentialType": 0,
  • "valid": true
}

Response samples

Content type
No sample

Project

/api/Project/SaveProject

Authorizations:
Bearer
Request Body schema:
id
integer <int32>
formIoUrl
string or null
formIoString
string or null
createdDate
string <date-time>

Responses

Request samples

Content type
{
  • "id": 0,
  • "formIoUrl": "string",
  • "formIoString": "string",
  • "createdDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

/api/Project/CheckUserExists

Authorizations:
Bearer
Request Body schema:
userId
integer <int32>
projectId
integer <int32>
Array of objects or null (SelectListItem)
Array of objects or null (SelectListItem)

Responses

Request samples

Content type
{
  • "userId": 0,
  • "projectId": 0,
  • "projectItemList": [
    ],
  • "userItemList": [
    ]
}

Response samples

Content type
No sample

/api/Project/AddUserMembership

Authorizations:
Bearer
Request Body schema:
userId
integer <int32>
projectId
integer <int32>
Array of objects or null (SelectListItem)
Array of objects or null (SelectListItem)

Responses

Request samples

Content type
{
  • "userId": 0,
  • "projectId": 0,
  • "projectItemList": [
    ],
  • "userItemList": [
    ]
}

Response samples

Content type
No sample

/api/Project/RemoveUserMembership

Authorizations:
Bearer
Request Body schema:
userId
integer <int32>
projectId
integer <int32>
Array of objects or null (SelectListItem)
Array of objects or null (SelectListItem)

Responses

Request samples

Content type
{
  • "userId": 0,
  • "projectId": 0,
  • "projectItemList": [
    ],
  • "userItemList": [
    ]
}

Response samples

Content type
No sample

/api/Project/AddTreMembership

Authorizations:
Bearer
Request Body schema:
projectId
integer <int32>
treId
integer <int32>
Array of objects or null (SelectListItem)
Array of objects or null (SelectListItem)

Responses

Request samples

Content type
{
  • "projectId": 0,
  • "treId": 0,
  • "projectItemList": [
    ],
  • "treItemList": [
    ]
}

Response samples

Content type
No sample

/api/Project/RemoveTreMembership

Authorizations:
Bearer
Request Body schema:
projectId
integer <int32>
treId
integer <int32>
Array of objects or null (SelectListItem)
Array of objects or null (SelectListItem)

Responses

Request samples

Content type
{
  • "projectId": 0,
  • "treId": 0,
  • "projectItemList": [
    ],
  • "treItemList": [
    ]
}

Response samples

Content type
No sample

/api/Project/GetProjectUI

Authorizations:
Bearer
query Parameters
projectId
integer <int32>

Responses

Response samples

Content type
No sample

/api/Project/GetProject

Authorizations:
Bearer
query Parameters
projectId
integer <int32>

Responses

Response samples

Content type
No sample

/api/Project/GetAllProjects

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Project/GetAllProjectsForTre

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Project/SyncTreProjectDecisions

Authorizations:
Bearer
Request Body schema:
Array
projectId
integer <int32>
decision
integer <int32> (Decision)
Enum: 0 1 2

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/api/Project/SyncTreMembershipDecisions

Authorizations:
Bearer
Request Body schema:
Array
projectId
integer <int32>
userId
integer <int32>
decision
integer <int32> (Decision)
Enum: 0 1 2

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

/api/Project/GetTresInProject

Authorizations:
Bearer
query Parameters
projectId
integer <int32>

Responses

Response samples

Content type
No sample

/api/Project/TestFetchAndStoreObject

Authorizations:
Bearer
Request Body schema:
url
string or null
bucketName
string or null
key
string or null

Responses

Request samples

Content type
{
  • "url": "string",
  • "bucketName": "string",
  • "key": "string"
}

/api/Project/IsUserOnProject

Authorizations:
Bearer
query Parameters
projectId
integer <int32>
userId
integer <int32>

Responses

Response samples

Content type
No sample

/api/Project/GetMinioEndPoint

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Project/UploadToMinio

Authorizations:
Bearer
query Parameters
bucketName
string
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
No sample

/api/Project/GetSearchData

Authorizations:
Bearer
query Parameters
searchString
string

Responses

Response samples

Content type
No sample

SignalR

/api/SignalR/Index

Authorizations:
Bearer

Responses

/api/SignalR/StartConnection

Authorizations:
Bearer

Responses

TaskServiceApi

/v1/tasks/{id}:cancel

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/v1/tasks

Authorizations:
Bearer
Request Body schema:
id
string or null
state
integer <int32> (TesState)
Enum: 1 2 3 4 5 6 7 8 9
name
string or null
description
string or null
Array of objects or null (TesInput)
Array of objects or null (TesOutput)
object (TesResources)
Array of objects or null (TesExecutor)
volumes
Array of strings or null
object or null
Array of objects or null (TesTaskLog)
creationTime
string or null <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "state": 1,
  • "name": "string",
  • "description": "string",
  • "inputs": [
    ],
  • "outputs": [
    ],
  • "resources": {
    },
  • "executors": [
    ],
  • "volumes": [
    ],
  • "tags": {
    },
  • "logs": [
    ],
  • "creationTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

/v1/tasks

Authorizations:
Bearer
query Parameters
namePrefix
string
pageSize
integer <int64>
pageToken
string
view
string

Responses

Response samples

Content type
No sample

/v1/service-info

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/v1/get_test_tes

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/v1/tasks/{id}

Authorizations:
Bearer
path Parameters
id
required
string
query Parameters
view
string

Responses

Response samples

Content type
No sample

Tre

/api/Tre/SaveTre

Authorizations:
Bearer
Request Body schema:
id
integer <int32>
formIoUrl
string or null
formIoString
string or null
createdDate
string <date-time>

Responses

Request samples

Content type
{
  • "id": 0,
  • "formIoUrl": "string",
  • "formIoString": "string",
  • "createdDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

/api/Tre/GetTresInProject/{projectId}

Authorizations:
Bearer
path Parameters
projectId
required
integer <int32>

Responses

Response samples

Content type
No sample

/api/Tre/GetAllTresUI

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Tre/GetAllTres

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/Tre/GetATre

Authorizations:
Bearer
query Parameters
treId
integer <int32>

Responses

Response samples

Content type
No sample

User

/api/User/SaveUser

Authorizations:
Bearer
Request Body schema:
id
integer <int32>
formIoUrl
string or null
formIoString
string or null
createdDate
string <date-time>

Responses

Request samples

Content type
{
  • "id": 0,
  • "formIoUrl": "string",
  • "formIoString": "string",
  • "createdDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

/api/User/GetUser

Authorizations:
Bearer
query Parameters
userId
integer <int32>

Responses

Response samples

Content type
No sample

/api/User/GetAllUsersUI

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/User/GetAllUsers

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/User/AddProjectMembership

Authorizations:
Bearer
Request Body schema:
userId
integer <int32>
projectId
integer <int32>
Array of objects or null (SelectListItem)
Array of objects or null (SelectListItem)

Responses

Request samples

Content type
{
  • "userId": 0,
  • "projectId": 0,
  • "projectItemList": [
    ],
  • "userItemList": [
    ]
}

Response samples

Content type
No sample

/api/User/RemoveProjectMembership

Authorizations:
Bearer
Request Body schema:
userId
integer <int32>
projectId
integer <int32>
Array of objects or null (SelectListItem)
Array of objects or null (SelectListItem)

Responses

Request samples

Content type
{
  • "userId": 0,
  • "projectId": 0,
  • "projectItemList": [
    ],
  • "userItemList": [
    ]
}

Response samples

Content type
No sample