Base Info
Interface Path：POST /api/rest_j/v1/dss/flow/entrance/execute
Request Param
Body:
{
"isReExecute":"" //must Added parameter, this parameter needs to be added when re-execution fails
}Return Parameter
{
"status":"", //code status
"message":"", //info
"data":{
"taskID":"",
"execID":""
}
}Base Info
Interface Path：POST /api/rest_j/v1/flow/entrance/{id}/status
Request Param
Body:
{
"id":"", //must
"taskID":""
}Return Parameter
{
"status":"", //code status
"message":"", //info
"data":{
"taskID":"",
"execID":""
}
}Base Info
Interface Path：GET /api/rest_j/v1/dss/flow/entrance/{id}/killWorkflow
Request Param
Body:
{
"taskID":"" //must
}response parameter
{
"massage":"",
"data":{
"result":"",
"errorInfo":""
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/release/getReleaseStatus
Request Param
Body:
{
"dssLabel":"", //must dssLabel
"releaseTaskId":"" //must Query's release id
}Response Parameter
{
"massage":"",
"data":{
"status":"",
"errorMsg":""
}
}Base Info
Interface Path：POST /api/rest_j/v1/dss/framework/release/releaseOrchestrator
Request Param
Body:
{
"orchestratorId":"", //must Orchestration mode id
"orchestratorVersionId":"", //must Orchestration mode version id
"comment":"", //must Post a note
"dssLabel":"" //must dssLabel
}Response Parameter
{
"massage":"",
"data":""
}Base Info
Interface Path：GET /api/rest_j/v1/dss/apiservice/tokenQuery
Request Param
Body:
{
"apiId":"",
"user":"",
"status":"",
"startDate":"",
"endDate":"",
"currentPage":1,
"pageSize":10
}Response Parameter
{
"massage":"",
"data":{
"queryList":[
"id":"",
"apiId":"",
"apiVersionId":"",
"publisher":"",
"user":"",
"applyTime":"",
"duration":"",
"reason":"",
"ipWhitelist":"",
"status":"",
"caller":"",
"accessLimit":"",
"token":"",
"applySource":""
]
}
}Base Info
Interface Path：GET /api/rest_j/v1/dss/apiservice/approvalRefresh
Request Param
Body:
{
"approvalNo":""
}Response Parameter
{
"massage":"",
"data":{
"approvalStatus":""
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/workflow/tables
Request Param
Body:
{
"contextID":"", //ID
"nodeName":"", //node name
"labels":{
"route":""
}
}Response Parameter
{
"massage":"",
"data":{
"tables":[]
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/workflow/columns
Request Param
Body:
{
"contextID":"",
"nodeName":"",
"contextKey":"",
"labels":{
"route":""
}
}Response Parameter
{
"massage":"",
"data":{
"columns":[]
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/getDicList
Request Param
Body:
{
"workspaceId":"", //must workspace id
"dicKey":"",
"parentKey":"" //parent key
}Response Parameter
{
"massage":"",
"data":{
"list":[{
"id":0,
"workspaceId":0, //workspace id
"parentKey":"", //parent key
"dicName":"", //dictionary name
"dicNameEn":"", //dictionary english name
"dicKey":"", //key Equivalent to encoding, the space starts with w_, and the project is p_
"dicValue":"", //the value corresponding to the key
"dicValueEn":"", //The value corresponding to the key (English)
"title":"", //title
"titleEn":"", //title(english)
"url":"",
"urlType":1, //url type: 0-internal system, 1-external system; default is internal
"icon":"", //icon
"orderNum":1, //order
"remark":"",
"createUser":"",
"createTime":"",
"updateUser":"",
"updateTime":""
}]
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/getDicSecondList
Request Param
Body:
{
"workspaceId":"", //must
"dicKey":"", //key Equivalent to encoding, the space starts with w_, and the project is p_
"parentKey":""
}Response Parameter
{
"massage":"",
"data":{
"list":[],
"mapList":{}
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/orchestrator/createOrchestrator
Request Param
Body:
{
"orchestratorName":"", //must Orchestration name
"orchestratorMode":"", //Orchestration patterns such as workflow, composition orchestration, etc.
"orchestratorWays":[], //must Orchestration way
"orchestratorLevel":"", //Orchestration Importance Levels
"dssLabels":[],
"uses":"", //Orchestration use
"description":"", //must
"projectName":"",
"workspaceName":""
}Response Parameter
{
"massage":"",
"data":{
"orchestratorId":1
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/orchestrator/getAllOrchestrator
Request Param
Body:
{
"workspaceId":"", //must
"projectId":"", //must
"orchestratorMode":"", //orchestrator type, such as workflow, compositional orchestrator, etc.
"orchestratorLevel":"", //Orchestration Importance Levels
"dssLabels":{"route":""} //dssLabels is passed in through the front end, mainly used for current environment information
}Response Parameter
{
"massage":"",
"data":{
"page":[{
"id":1, //primary key ID
"workspaceId":"", //workspace id
"projectId":"", //project id
"orchestratorId":1, //Orchestration mode id (workflow, the orchestratorId returned by calling the orchestrator service)
"orchestratorVersionId":1, //Orchestration mode version id (workflow, the orchestratorVersionId returned by calling the orchestrator service)
"orchestratorName":"", //orchestrator Name
"orchestratorMode":"", //Orchestration mode, the value obtained is dic_key(parent_key=p_orchestratorment_mode) in dss_dictionary
"uses":"",
"description":"",
"createUser":"",
"createTime":"",
"updateUser":"",
"updateTime":"",
"orchestratorWays":[],
"orchestratorLevel":"", //Orchestration Importance Levels
"flowEditLockExist":false //Whether the workflow edit lock is exited
}]
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/orchestrator/modifyOrchestrator
Request Param
Body:
{
"id":"", //must
"orchestratorName":"", //must orchestrator Name
"orchestratorMode":"", //Choreography type, such as workflow, compositional choreography, etc.
"orchestratorLevel":"", //Orchestration Importance Levels
"uses":"", //Orchestration use
"description":"", //must describe
"orchestratorWays":[], //must orchestrator Ways
"dssLabels":"" //Current environmental information
}Response Parameter
{
"massage":"",
"data":{
"orchestratorId":1
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/orchestrator/deleteOrchestrator
Request Param
Body:
{
"id":"" //must
}Response Parameter
{
"massage":""
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/orchestrator/orchestratorLevels
Request Param
Body:
{}Response Parameter
{
"massage":"",
"data":{
"orchestratorLevels":["HIGH","MEDIUM","LOW"],
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/release/importOldDSSProject
Request Param
Body:
{
"file":"" //must MultipartFile
}Response Parameter
{
"massage":""
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/release/importworkflow
Request Param
Body:
{
"workspaceName":"", //must workspace Name
"projectName":"", //Create without project name
"projectUser":"", // Project user, the interface will ensure that this user is added to the permission list
"flowName":"",
"file":"" //Import file, MultipartFile type
}Response Parameter
{
"massage":"",
"data":{
"flowId":"",
"bmlVersion":""
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/release/exportOrcSqlFile
Request Param
Body:
{
"outputFileName":"", //Default exportOrc
"charset":"utf-8", //encoding default utf-8
"outputFileType":"zip", // output file type default zip
"projectName":"", //project Name
"orchestratorId":"", //orchestrator Id
"orcVersionId":"", //orchestrator version number ID
"addOrcVersion":false, //Whether to increase the version number
"labels":""
}Response Parameter
{}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/release/exportallflow
Request Param
Body:
{
"workspaceName":"",
"projectName":"",
"pathRoot":""
}Response Parameter
{
"message":"",
"data":{
"count":0,
"location":"",
"serviceInstance":""
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/getSideInfos
Request Param
Body:
{
"workspaceID":""
}Response Parameter
{
"message":"",
"data":{
"presentations":[{
"name":"",
"title":"",
"type":"",
"contents":[{
"name":"",
"title":"",
"url":0, //url type: 0-internal system, 1-external system; default is internal
"icon":"" //icon is the icon representing the Content, if it is empty, there is no
}]
}]
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/exportOrcSqlFile
Request Param
Body:
{
"workspaceId":""
}Response Parameter
{
"message":"",
"data":{
"workspaceMenuPrivs":{
"workspaceId":1,
"menuPrivVOS":[{
"id":"",
"name":"",
"menuPrivs":[{}]
}],
"DSSWorkspaceComponentPrivVO":[{
"id":"",
"name":"",
"componentPrivs":[{}]
}],
"DSSWorkspaceRoleVO":[{
"roleId":"",
"roleName":"",
"roleFrontName":""
}]
}
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getWorkspaceHomepageSettings
Request Param
Body:
{
"workspaceId":"" //工作workspace id
}Response Parameter
{
"message":"",
"data":{
"homepageSettings":{
"roleName":"",
"homepageName":"",
"homepageUrl":"",
"roleId":1,
"roleFrontName":""
}
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/updateRoleMenuPriv
Request Param
Body:
{
"menuId":"",
"workspaceId":"",
"menuPrivs":"" //menu permissions
}Response Parameter
{
"message":""
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/updateRoleComponentPriv
Request Param
Body:
{
"componentId":"",
"workspaceId":"",
"componentPrivs":"" //component permissions
}Response Parameter
{
"message":"",
"data":{
"updateRoleComponentPriv":""
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/createWorkspace
Request Param
Body:
{
"workspaceName":"",
"department":"",
"description":"",
"tags":"",
"productName":""
}Response Parameter
{
"message":"",
"data":{
"workspaceId":1,
"workspaceName":""
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/listDepartments
Request Param
Body:
{}Response Parameter
{
"message":"",
"data":{
"departments":[{
"id":1,
"name":"",
"frontName":""
}]
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getWorkspaces
Request Param
Body:
{}Response Parameter
{
"message":"",
"data":{
"workspaces":[{
"id":1,
"name":"",
"tags":"",
"department":"",
"description":"",
"product":""
}]
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getWorkspaceHomePage
Request Param
Body:
{
"micro_module":"" //module name
}Response Parameter
{
"message":"",
"data":{
"workspaceHomePage":{
"workspaceId":1,
"roleName":"",
"homePageUrl":""
]
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getOverview
Request Param
Body:
{
"workspaceId":1
}Response Parameter
{
"message":"",
"data":{
"overview":{
"title":1,
"description":"",
"dssDescription":"",
"videos":[{
"id":"",
"title":"",
"url":""
}],
"demos":[{}]
]
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/refreshCache
Request Param
Body:
{}Response Parameter
{
"message":""
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getWorkspaceRoles
Request Param
Body:
{
"workspaceId":""
}Response Parameter
{
"message":"",
"data":{
"workspaceRoles":[{
"roleId":1,
"roleName":"",
"roleFrontName":""
}]
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/addWorkspaceRole
Request Param
Body:
{
"workspaceId":1,
"roleName":"",
"menuIds":[],
"componentIds":[]
}Response Parameter
{
"message":""
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getWorkspaceUsers
Request Param
Body:
{
"workspaceId":1,
"pageNow":1, //current page default 1
"pageSize":20, //Quantity per page The default display is 20
"department":"",
"userName":"",
"roleName":""
}Response Parameter
{
"message":"",
"data":{
"roles":"",
"workspaceUsers":[{
"id":"",
"name":"",
"roles":[],
"department":"",
"office":"",
"creator":"",
"joinTime":""
}],
"total":100
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getWorkspaceUsers
Request Param
Body:
{}Response Parameter
{
"message":"",
"data":{
"users":{
"editUsers":[],
"accessUsers":[],
"releaseUsers":[]
}
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/existUserInWorkspace
Request Param
Body:
{
"workspaceId":1,
"queryUserName":""
}Response Parameter
{
"message":"",
"data":{
"existFlag":true
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/existUserInWorkspace
Request Param
Body:
{
"workspaceId":1,
"userName":"",
"roles":[],
"userId":""
}Response Parameter
{
"message":""
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/updateWorkspaceUser
Request Param
Body:
{
"workspaceId":1,
"userName":"",
"roles":[],
"userId":""
}Response Parameter
{
"message":""
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/workspace/updateWorkspaceUser
Request Param
Body:
{
"workspaceId":1,
"userName":"",
"roles":[],
"userId":""
}Response Parameter
{
"message":""
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/listAllUsers
Request Param
Body:
{}Response Parameter
{
"message":"",
"data":{
"users":{
"id":"",
"username":"",
"department":"",
"office":""
}
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/workspace/getWorkspaceIdByUserName
Request Param
Body:
{
"userName":""
}Response Parameter
{
"message":"",
"data":{
"userWorkspaceIds":""
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/orchestrator/importOrchestratorFile
Request Param
Body:
{
"projectName":"",
"projectID":1,
"labels":"", //Environmental information
"files":"" //MultipartFile type, supports multiple files
}Response Parameter
{
"message":"",
"data":{
"importOrcId":1
}
}Interface Path：GET/api/rest_j/v1/dss/framework/orchestrator/exportOrchestrator
Request Param
Body:
{
"outputFileName":"exportOrc", //output filename default exportOrc
"charset":"utf-8", //encoding default utf-8
"outputFileType":"zip", //output file type default zip
"projectName":"", //Construction name
"orchestratorId":"",
"orcVersionId":"",
"addOrcVersion":"",
"labels":"" //Environmental information
}Response Parameter
{}Base Info
Interface Path：GET/api/rest_j/v1/dss/framework/orchestrator/rollbackOrchestrator
Request Param
Body:
{
"orchestratorId":1,
"version":"",
"projectId":1,
"projectName":"",
"labels":"" //Environmental information
}Response Parameter
{
"message":"",
"data":{
"newVersion":""
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/orchestrator/openOrchestrator
Request Param
Body:
{
"workspaceName":1,
"orchestratorId":"",
"labels":{
"route":""
},
}Response Parameter
{
"message":"",
"data":{
"OrchestratorOpenUrl":"",
"OrchestratorVo":""
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/framework/orchestrator/getVersionByOrchestratorId
Request Param
Body:
{
"orchestratorId":"" //must
}Response Parameter
{
"message":"",
"data":{
"list":[]
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/workflow/addFlow
Request Param
Body:
{
"name":"",
"workspaceName":"",
"projectName":"",
"version":"",
"description":"",
"parentFlowID":"",
"uses":"",
"labels":{
"route":""
},
"userName":""
}Response Parameter
{
"massage":"",
"data":{
"flow":{
"id":1,
"name":"",
"state":true, //Represents published and unpublished
"source":"",
"description":"",
"createTime":"",
"creator":"",
"isRootFlow":true,
"rank":1,
"projectID":1,
"linkedAppConnNames":"",
"dssLabels":"",
"flowEditLock":"", //Workflow Edit Lock
"hasSaved":true, //ture indicates that the workflow has never been saved and is ignored when publishing
"uses":"",
"children":[],
"flowType":"",
"resourceId":"",
"bmlVersion":""
}
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/workflow/publishWorkflow
Request Param
Body:
{
"workflowId":"",
"comment":"",
"labels":{
"route":""
},
"dssLabel":"",
"orchestratorId":1,
"orchestratorVersionId":1
}Response Parameter
{
"massage":""
}Base Info
Interface Path：POST/api/rest_j/v1/dss/workflow/getReleaseStatus
Request Param
Body:
{
"releaseTaskId":1 //must
}Response Parameter
{
"massage":"",
"data":{
"status":""
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/workflow/get
Request Param
Body:
{
"flowID":1, //must
"isNotHaveLock":true
}Response Parameter
{
"massage":"",
"data":{
"flow":{
"id":1,
"name":"",
"state":true, //Represents published and unpublished
"source":"",
"description":"",
"createTime":"",
"creator":"",
"isRootFlow":true,
"rank":1,
"projectID":1,
"linkedAppConnNames":"",
"dssLabels":"",
"flowEditLock":"", //Workflow Edit Lock
"hasSaved":true, //ture indicates that the workflow has never been saved and is ignored when publishing
"uses":"",
"children":[],
"flowType":"",
"resourceId":"",
"bmlVersion":""
}
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/workflow/deleteFlow
Request Param
Body:
{
"id":1, //must
"sure":true,
"labels":{
"route":""
}
}Response Parameter
{
"massage":""
}Base Info
Interface Name：Workflow save interface, if the workflow Json content changes, it will update the Json content of the workflow
Interface Path：POST/api/rest_j/v1/dss/workflow/saveFlow
Request Param
Body:
{
"id":1, //must
"json":"",
"workspaceName":"",
"projectName":"",
"flowEditLock":"",
"isNotHaveLock":true,
"labels":{
"route":""
}
}Response Parameter
{
"massage":"",
"data":{
"flowVersion":"",
"flowEditLock":""
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/workflow/updateFlowEditLock
Request Param
Body:
{
"flowEditLock":""
}Response Parameter
{
"massage":"",
"data":{
"flowEditLock":""
}
}Base Info
Interface Path：POST/api/rest_j/v1/dss/workflow/getExtraToolBars
Request Param
Body:
{
"projectId":1,
"workflowId":"",
"labels":{
"route":""
}
}Response Parameter
{
"massage":"",
"data":{
"extraBars":[{
"name":"",
"url":"",
"icon":""
}]
}
}Base Info
Interface Path：GET/api/rest_j/v1/dss/workflow/listNodeType
Request Param
Body:
{
"projectId":1,
"workflowId":"",
"labels":{
"route":""
}
}Response Parameter
{
"massage":"",
"data":{
"extraBars":[{
"name":"",
"url":"",
"icon":""
}]
}
}