signavio-api

{ "apiVersion" : "1", "swaggerVersion" : "1.2", "basePath" : "https://workflow.signavio.com/api/v1", "apis" : [ { "path" : "/{organizationKey}/templates", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/templates", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "category", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "offset", "dataType" : "integer", "required" : true }, { "paramType" : "query", "name" : "pagesize", "dataType" : "integer", "required" : true }, { "paramType" : "query", "name" : "trigger", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "name", "dataType" : "string", "required" : true } ] }, { "method" : "POST", "nickname" : "/{organizationKey}/workflows", "type" : "EditorWorkflowDetail", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "newWorkflow", "dataType" : "NewWorkflow", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/import/bpmn", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/import/bpmn", "type" : "ImportResponse", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "body", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/import/bpmn/{fileId}", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/import/bpmn/{fileId}", "type" : "ImportResponse", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "fileId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/import/bpmndmn", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/import/bpmndmn", "type" : "AbstractWorkflow", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "dmnBpmnImportWrapper", "dataType" : "DmnBpmnImportWrapper", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/import/json", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/import/json", "type" : "EditorWorkflow", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "editorWorkflow", "dataType" : "EditorWorkflow", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/scope/reports", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/scope/reports", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "offset", "dataType" : "integer", "required" : true }, { "paramType" : "query", "name" : "pagesize", "dataType" : "integer", "required" : true }, { "paramType" : "query", "name" : "trigger", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "name", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}", "operations" : [ { "method" : "DELETE", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "cascade", "dataType" : "boolean", "required" : true } ] }, { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}", "type" : "EditorWorkflowDetail", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] }, { "method" : "PUT", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}", "type" : "EditorWorkflowDetail", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "editorWorkflow", "dataType" : "EditorWorkflow", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/actions/{activityId}/inputs", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/actions/{activityId}/inputs", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "activityId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/actions/{activityId}/outputs", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/actions/{activityId}/outputs", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "activityId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/activities/{activityId}/test", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/activities/{activityId}/test", "type" : "ScriptResult", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "activityId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/copy", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/copy", "type" : "EditorWorkflowDetail", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/export/bpmn/", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/export/bpmn/", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/export/bpmndmn/", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/export/bpmndmn/", "type" : "DmnBpmnExportWrapper", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/export/json", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/export/json", "type" : "EditorWorkflow", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/lock", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/lock", "type" : "EditorWorkflow", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/startForm", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/startForm", "type" : "FormInstance", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/startInfo", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/startInfo", "type" : "StartInfo", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/unlock", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/unlock", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/update/bpmn", "operations" : [ { "method" : "PUT", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/update/bpmn", "type" : "ImportResponse", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "body", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/update/bpmndmn", "operations" : [ { "method" : "PUT", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/update/bpmndmn", "type" : "EditorWorkflow", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "dmnBpmnImportWrapper", "dataType" : "DmnBpmnImportWrapper", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/versions", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/versions", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "offset", "dataType" : "integer", "required" : true }, { "paramType" : "query", "name" : "pagesize", "dataType" : "integer", "required" : true } ] }, { "method" : "POST", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/versions", "type" : "ExecutableWorkflow", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "versionRequest", "dataType" : "VersionRequest", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{editorWorkflowId}/versions/{versionId}/restore", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/{editorWorkflowId}/versions/{versionId}/restore", "type" : "EditorWorkflowDetail", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "editorWorkflowId", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "versionId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/workflows/{workflowId}/versions/{versionId}/publish", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/workflows/{workflowId}/versions/{versionId}/publish", "type" : "ExecutableWorkflow", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "workflowId", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "versionId", "dataType" : "string", "required" : true } ] } ] } ], "models" : { "LeaveRequest" : { "id" : "LeaveRequest", "properties" : { } }, "EmptyObject" : { "id" : "EmptyObject", "properties" : { } }, "EditorWorkflow" : { "id" : "EditorWorkflow", "properties" : { "nameLower" : { "type" : "string" } } }, "DmnBpmnExportWrapper" : { "id" : "DmnBpmnExportWrapper", "properties" : { } }, "FormInstance" : { "id" : "FormInstance", "properties" : { } }, "User" : { "id" : "User", "properties" : { "features" : { "type" : "FeatureCache" }, "emailAddressLower" : { "type" : "string" }, "passwordHash" : { "type" : "string" }, "passwordReset" : { "type" : "PasswordReset" }, "permissions" : { "type" : "array", "items" : { "$ref" : "Permission" } }, "token" : { "type" : "string" } } }, "HandoverLogin" : { "id" : "HandoverLogin", "properties" : { } }, "ActionInstance" : { "id" : "ActionInstance", "properties" : { } }, "LdapConfiguration" : { "id" : "LdapConfiguration", "properties" : { } }, "StartInfo" : { "id" : "StartInfo", "properties" : { } }, "PasswordResetConfirmation" : { "id" : "PasswordResetConfirmation", "properties" : { } }, "FormInstanceField" : { "id" : "FormInstanceField", "properties" : { } }, "Account" : { "id" : "Account", "properties" : { } }, "LdapSynchronisationResult" : { "id" : "LdapSynchronisationResult", "properties" : { } }, "NewCase" : { "id" : "NewCase", "properties" : { "nameLower" : { "type" : "string" }, "access" : { "type" : "AccessControlList" }, "hasDueDate" : { "type" : "boolean" }, "hasPriority" : { "type" : "boolean" } } }, "About" : { "id" : "About", "properties" : { } }, "TaskDetail" : { "id" : "TaskDetail", "properties" : { } }, "VersionRequest" : { "id" : "VersionRequest", "properties" : { } }, "LoginResponse" : { "id" : "LoginResponse", "properties" : { } }, "NewTask" : { "id" : "NewTask", "properties" : { "nameLower" : { "type" : "string" }, "access" : { "type" : "AccessControlList" } } }, "RegistrationRequest" : { "id" : "RegistrationRequest", "properties" : { } }, "ExecutableWorkflow" : { "id" : "ExecutableWorkflow", "properties" : { } }, "OauthStartRequest" : { "id" : "OauthStartRequest", "properties" : { } }, "ServiceLogin" : { "id" : "ServiceLogin", "properties" : { } }, "CaseCancellation" : { "id" : "CaseCancellation", "properties" : { } }, "SystemConfiguration" : { "id" : "SystemConfiguration", "properties" : { } }, "ActionInstanceEnd" : { "id" : "ActionInstanceEnd", "properties" : { } }, "PurchaseOrder" : { "id" : "PurchaseOrder", "properties" : { } }, "PatchUpdate" : { "id" : "PatchUpdate", "properties" : { } }, "NewUser" : { "id" : "NewUser", "properties" : { } }, "ScriptResult" : { "id" : "ScriptResult", "properties" : { } }, "CaseSummaries" : { "id" : "CaseSummaries", "properties" : { } }, "EditorWorkflowDetail" : { "id" : "EditorWorkflowDetail", "properties" : { "nameLower" : { "type" : "string" } } }, "File" : { "id" : "File", "properties" : { } }, "FileStream" : { "id" : "FileStream", "properties" : { } }, "LoginRequest" : { "id" : "LoginRequest", "properties" : { } }, "ImportResponse" : { "id" : "ImportResponse", "properties" : { } }, "NewWorkflow" : { "id" : "NewWorkflow", "properties" : { "nameLower" : { "type" : "string" } } }, "UserMailAddress" : { "id" : "UserMailAddress", "properties" : { } }, "LdapValidationResult" : { "id" : "LdapValidationResult", "properties" : { } }, "DmnBpmnImportWrapper" : { "id" : "DmnBpmnImportWrapper", "properties" : { } }, "License" : { "id" : "License", "properties" : { } }, "NewAssignmentRequest" : { "id" : "NewAssignmentRequest", "properties" : { } }, "Group" : { "id" : "Group", "properties" : { } }, "Organization" : { "id" : "Organization", "properties" : { "created" : { "type" : "LocalDateTime" } } }, "OauthStartResponse" : { "id" : "OauthStartResponse", "properties" : { } }, "Registration" : { "id" : "Registration", "properties" : { "pictureId" : { "type" : "object-id" } } }, "CaseDetail" : { "id" : "CaseDetail", "properties" : { } }, "AbstractWorkflow" : { "id" : "AbstractWorkflow", "properties" : { } }, "Event" : { "id" : "Event", "properties" : { } } } }