signavio-api
Version:
Unofficial node signavio workflow api wrapper
1,008 lines • 27.7 kB
JSON
{
"apiVersion" : "1",
"swaggerVersion" : "1.2",
"basePath" : "https://workflow.signavio.com/api/v1",
"apis" : [ {
"path" : "/oauth_callback",
"operations" : [ {
"method" : "GET",
"nickname" : "/oauth_callback",
"parameters" : [ {
"paramType" : "query",
"name" : "state",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "code",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "error",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/services/{serviceKey}/accounts",
"operations" : [ {
"method" : "GET",
"nickname" : "/services/{serviceKey}/accounts",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
}, {
"method" : "POST",
"nickname" : "/services/{serviceKey}/accounts",
"type" : "Account",
"parameters" : [ {
"paramType" : "header",
"name" : "Authorization",
"description" : "The authentication token must belong to an admin of the organization admin. The token can be obtained from /users/login.",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "organizationKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "body",
"name" : "account",
"dataType" : "Account",
"required" : true
} ]
} ]
}, {
"path" : "/services/{serviceKey}/accounts/{accountId}",
"operations" : [ {
"method" : "GET",
"nickname" : "/services/{serviceKey}/accounts/{accountId}",
"type" : "Account",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
}, {
"method" : "PUT",
"nickname" : "/services/{serviceKey}/accounts/{accountId}",
"type" : "Account",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "body",
"name" : "patchUpdate",
"dataType" : "PatchUpdate",
"required" : true
} ]
} ]
}, {
"path" : "/services/{serviceKey}/accounts/{accountId}/options/{optionsKey}",
"operations" : [ {
"method" : "GET",
"nickname" : "/services/{serviceKey}/accounts/{accountId}/options/{optionsKey}",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "optionsKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/services/{serviceKey}/accounts/{accountId}/references",
"operations" : [ {
"method" : "GET",
"nickname" : "/services/{serviceKey}/accounts/{accountId}/references",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "q",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "parent",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "pathTo",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/services/{serviceKey}/options/{optionsKey}",
"operations" : [ {
"method" : "GET",
"nickname" : "/services/{serviceKey}/options/{optionsKey}",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "optionsKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services",
"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
} ]
} ]
}, {
"path" : "/{organizationKey}/services/oauth/start",
"operations" : [ {
"method" : "POST",
"nickname" : "/{organizationKey}/services/oauth/start",
"type" : "OauthStartResponse",
"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" : "oauthStartRequest",
"dataType" : "OauthStartRequest",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/accounts",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
}, {
"method" : "POST",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts",
"type" : "Account",
"parameters" : [ {
"paramType" : "header",
"name" : "Authorization",
"description" : "The authentication token must belong to an admin of the organization admin. The token can be obtained from /users/login.",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "organizationKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "body",
"name" : "account",
"dataType" : "Account",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}",
"operations" : [ {
"method" : "DELETE",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
} ]
}, {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}",
"type" : "Account",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
}, {
"method" : "PUT",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}",
"type" : "Account",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "body",
"name" : "patchUpdate",
"dataType" : "PatchUpdate",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/inputs/resource/{resourceId}",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/inputs/resource/{resourceId}",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "resourceId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "optionalId",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/inputs/resource/{resourceId}/{optionalId}",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/inputs/resource/{resourceId}/{optionalId}",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "resourceId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "optionalId",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/options/{optionsKey}",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/options/{optionsKey}",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "optionsKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/references",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/accounts/{accountId}/references",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "q",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "parent",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "pathTo",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/actionInstances/lock",
"operations" : [ {
"method" : "POST",
"nickname" : "/{organizationKey}/services/{serviceKey}/actionInstances/lock",
"type" : "ActionInstance",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "body",
"name" : "actionInstance",
"dataType" : "ActionInstance",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/actionInstances/{actionInstanceId}/end",
"operations" : [ {
"method" : "POST",
"nickname" : "/{organizationKey}/services/{serviceKey}/actionInstances/{actionInstanceId}/end",
"type" : "EmptyObject",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "actionInstanceId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "body",
"name" : "actionInstanceEnd",
"dataType" : "ActionInstanceEnd",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/icon",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/icon",
"type" : "FileStream",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
} ]
} ]
}, {
"path" : "/{organizationKey}/services/{serviceKey}/options/{optionsKey}",
"operations" : [ {
"method" : "GET",
"nickname" : "/{organizationKey}/services/{serviceKey}/options/{optionsKey}",
"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" : "serviceKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "accountId",
"dataType" : "string",
"required" : true
}, {
"paramType" : "path",
"name" : "optionsKey",
"dataType" : "string",
"required" : true
}, {
"paramType" : "query",
"name" : "excludeOwner",
"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" : { }
}
}
}