signavio-api

{ "apiVersion" : "1", "swaggerVersion" : "1.2", "basePath" : "https://workflow.signavio.com/api/v1", "apis" : [ { "path" : "/about", "operations" : [ { "method" : "GET", "nickname" : "/about", "type" : "About", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/login/{providerKey}", "operations" : [ { "method" : "POST", "nickname" : "/login/{providerKey}", "type" : "ServiceLogin", "parameters" : [ { "paramType" : "path", "name" : "providerKey", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "serviceLogin", "dataType" : "ServiceLogin", "required" : true } ] }, { "method" : "PUT", "nickname" : "/login/{providerKey}", "type" : "ServiceLogin", "parameters" : [ { "paramType" : "path", "name" : "providerKey", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "code", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "state", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "error", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "error_description", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "serviceLogin", "dataType" : "ServiceLogin", "required" : true } ] } ] }, { "path" : "/registrations", "operations" : [ { "method" : "POST", "nickname" : "/registrations", "type" : "EmptyObject", "parameters" : [ { "paramType" : "body", "name" : "registrationRequest", "dataType" : "RegistrationRequest", "required" : true } ] } ] }, { "path" : "/registrations/{code}", "operations" : [ { "method" : "GET", "nickname" : "/registrations/{code}", "type" : "Registration", "parameters" : [ { "paramType" : "path", "name" : "code", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/registrations/{code}/activate", "operations" : [ { "method" : "POST", "nickname" : "/registrations/{code}/activate", "type" : "LoginResponse", "parameters" : [ { "paramType" : "path", "name" : "code", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "registrationRequest", "dataType" : "RegistrationRequest", "required" : true } ] } ] }, { "path" : "/registrations/{code}/picture", "operations" : [ { "method" : "GET", "nickname" : "/registrations/{code}/picture", "type" : "FileStream", "parameters" : [ { "paramType" : "path", "name" : "code", "dataType" : "string", "required" : true } ] }, { "method" : "POST", "nickname" : "/registrations/{code}/picture", "type" : "EmptyObject", "parameters" : [ { "paramType" : "path", "name" : "code", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/registrations/{code}/pictureiframe", "operations" : [ { "method" : "POST", "nickname" : "/registrations/{code}/pictureiframe", "parameters" : [ { "paramType" : "path", "name" : "code", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/users/confirm", "operations" : [ { "method" : "POST", "nickname" : "/users/confirm", "type" : "LoginResponse", "parameters" : [ { "paramType" : "body", "name" : "passwordResetConfirmation", "dataType" : "PasswordResetConfirmation", "required" : true } ] } ] }, { "path" : "/users/login", "operations" : [ { "method" : "POST", "nickname" : "/users/login", "parameters" : [ { "paramType" : "body", "name" : "loginRequest", "dataType" : "LoginRequest", "required" : true } ] } ] }, { "path" : "/users/login/handover", "operations" : [ { "method" : "POST", "nickname" : "/users/login/handover", "type" : "HandoverLogin", "parameters" : [ { "paramType" : "body", "name" : "handoverLogin", "dataType" : "HandoverLogin", "required" : true } ] } ] }, { "path" : "/users/reset", "operations" : [ { "method" : "POST", "nickname" : "/users/reset", "type" : "EmptyObject", "parameters" : [ { "paramType" : "body", "name" : "userMailAddress", "dataType" : "UserMailAddress", "required" : true } ] } ] }, { "path" : "/users/{userId}", "operations" : [ { "method" : "GET", "nickname" : "/users/{userId}", "type" : "User", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true } ] }, { "method" : "PUT", "nickname" : "/users/{userId}", "type" : "User", "parameters" : [ { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "patchUpdate", "dataType" : "PatchUpdate", "required" : true } ] } ] }, { "path" : "/users/{userId}/picture", "operations" : [ { "method" : "POST", "nickname" : "/users/{userId}/picture", "type" : "EmptyObject", "parameters" : [ { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/users/{userId}/pictureiframe", "operations" : [ { "method" : "POST", "nickname" : "/users/{userId}/pictureiframe", "parameters" : [ { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/users", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/users", "parameters" : [ { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "emailAddress", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "name", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "groupId", "dataType" : "string", "required" : true }, { "paramType" : "query", "name" : "offset", "dataType" : "integer", "required" : true }, { "paramType" : "query", "name" : "pagesize", "dataType" : "integer", "required" : true } ] } ] }, { "path" : "/{organizationKey}/users/{userId}", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/users/{userId}", "type" : "User", "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" : "userId", "dataType" : "string", "required" : true } ] }, { "method" : "PUT", "nickname" : "/{organizationKey}/users/{userId}", "type" : "User", "parameters" : [ { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "patchUpdate", "dataType" : "PatchUpdate", "required" : true } ] } ] }, { "path" : "/{organizationKey}/users/{userId}/handover", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/users/{userId}/handover", "type" : "HandoverLogin", "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" : "userId", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "handoverLogin", "dataType" : "HandoverLogin", "required" : true } ] } ] }, { "path" : "/{organizationKey}/users/{userId}/leave", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/users/{userId}/leave", "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" : "userId", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "leaveRequest", "dataType" : "LeaveRequest", "required" : true } ] } ] }, { "path" : "/{organizationKey}/users/{userId}/picture", "operations" : [ { "method" : "GET", "nickname" : "/{organizationKey}/users/{userId}/picture", "type" : "FileStream", "parameters" : [ { "paramType" : "path", "name" : "organizationKey", "dataType" : "string", "required" : true }, { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true } ] }, { "method" : "POST", "nickname" : "/{organizationKey}/users/{userId}/picture", "type" : "EmptyObject", "parameters" : [ { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{organizationKey}/users/{userId}/pictureiframe", "operations" : [ { "method" : "POST", "nickname" : "/{organizationKey}/users/{userId}/pictureiframe", "parameters" : [ { "paramType" : "path", "name" : "userId", "dataType" : "string", "required" : true } ] } ] }, { "path" : "/{workspaceKey}/users/{userId}/preferences", "operations" : [ { "method" : "PUT", "nickname" : "/{workspaceKey}/users/{userId}/preferences", "parameters" : [ { "paramType" : "header", "name" : "Authorization", "description" : "The authentication token can be obtained from /users/login.", "dataType" : "string", "required" : true }, { "paramType" : "body", "name" : "put any json in here", "dataType" : "string", "required" : false } ] } ] } ], "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" : { } } } }