Skip to content

Latest commit

 

History

History
3081 lines (2440 loc) · 80.1 KB

API.md

File metadata and controls

3081 lines (2440 loc) · 80.1 KB
Raw

3.0.4 API Reference (v1)

Auto-generated Api documentation. Base path: https://app.effektif.com/api/v1 Table of contents:

File

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

File getUserInstance

File proxy

File createFiles

Represents call to: POST /{organizationKey}/files

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: File
  • resp: Http response

File deleteFile

Represents call to: DELETE /{organizationKey}/files/{fileId}

Requires authorization

Arguments:

  • organizationKey: required string
  • fileId: required string
  • callback: required function - function(err, body, resp)

File getFile

Represents call to: GET /{organizationKey}/files/{fileId}

Requires authorization

Arguments:

  • organizationKey: required string
  • fileId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: File
  • resp: Http response

File getFileStream

Represents call to: GET /{organizationKey}/files/{fileId}/stream

Requires authorization

Arguments:

  • organizationKey: required string
  • fileId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: FileStream
  • resp: Http response

File createFilesiframe

Represents call to: POST /{organizationKey}/filesiframe

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Mail

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

Mail getUserInstance

Mail proxy

Mail createMailIncoming

Represents call to: POST /mail/incoming

Arguments:

  • callback: required function - function(err, body, resp)

Case

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

Case getUserInstance

Case proxy

Case getCases

Represents call to: GET /{organizationKey}/cases

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: string
  • closed: boolean
  • canceled: boolean
  • sorting: string
  • workflowDeleted: boolean
  • callback: required function - function(err, body, resp)

Case createCases

Represents call to: POST /{organizationKey}/cases

Requires authorization

Arguments:

  • organizationKey: required string
  • newCase: required object NewCase
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: CaseDetail
  • resp: Http response

Case deleteCase

Represents call to: DELETE /{organizationKey}/cases/{caseId}

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • callback: required function - function(err, body, resp)

Case getCase

Represents call to: GET /{organizationKey}/cases/{caseId}

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: CaseDetail
  • resp: Http response

Case updateCase

Represents call to: PUT /{organizationKey}/cases/{caseId}

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • case: required object Case
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: CaseDetail
  • resp: Http response

Case cancel

Represents call to: POST /{organizationKey}/cases/{caseId}/cancel

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: CaseDetail
  • resp: Http response

Case close

Represents call to: POST /{organizationKey}/cases/{caseId}/close

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: CaseDetail
  • resp: Http response

Case getCaseEvents

Represents call to: GET /{organizationKey}/cases/{caseId}/events

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • taskId: string
  • type: string
  • offset: number
  • pagesize: number
  • callback: required function - function(err, body, resp)

Case createCaseEvents

Represents call to: POST /{organizationKey}/cases/{caseId}/events

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • event: required object Event
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Event
  • resp: Http response

Case createCaseFiles

Represents call to: POST /{organizationKey}/cases/{caseId}/files

Arguments:

  • organizationKey: required string
  • caseId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: File
  • resp: Http response

Case createCaseFile

Represents call to: POST /{organizationKey}/cases/{caseId}/files/{fileId}

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • fileId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: File
  • resp: Http response

Case createCaseIframeFiles

Represents call to: POST /{organizationKey}/cases/{caseId}/iframe/files

Arguments:

  • organizationKey: required string
  • caseId: required string
  • callback: required function - function(err, body, resp)

Case getCaseTasks

Represents call to: GET /{organizationKey}/cases/{caseId}/tasks

Requires authorization

Arguments:

  • organizationKey: required string
  • caseId: required string
  • completed: boolean
  • callback: required function - function(err, body, resp)

Case getInfoCases

Represents call to: GET /{organizationKey}/info/cases

Requires authorization

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Task

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

Task getUserInstance

Task proxy

Task getTasks

Represents call to: GET /{organizationKey}/tasks

Requires authorization

Arguments:

  • organizationKey: required string
  • involvement: array api type array
  • dueDate: array api type array
  • process: string
  • completed: boolean
  • callback: required function - function(err, body, resp)

Task createTasks

Represents call to: POST /{organizationKey}/tasks

Requires authorization

Arguments:

  • organizationKey: required string
  • newTask: required object NewTask
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: TaskDetail
  • resp: Http response

Task deleteTask

Represents call to: DELETE /{organizationKey}/tasks/{taskId}

Requires authorization

Arguments:

  • organizationKey: required string
  • taskId: required string
  • callback: required function - function(err, body, resp)

Task getTask

Represents call to: GET /{organizationKey}/tasks/{taskId}

Requires authorization

Arguments:

  • organizationKey: required string
  • taskId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: TaskDetail
  • resp: Http response

Task updateTask

Represents call to: PUT /{organizationKey}/tasks/{taskId}

Requires authorization

Arguments:

  • organizationKey: required string
  • taskId: required string
  • task: required object Task
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: TaskDetail
  • resp: Http response

Task completeTask

Represents call to: POST /{organizationKey}/tasks/{taskId}/complete

Requires authorization

Arguments:

  • organizationKey: required string
  • taskId: required string
  • fields: required array FormInstanceField
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: TaskDetail
  • resp: Http response

Task updateTaskFormField

Represents call to: PUT /{organizationKey}/tasks/{taskId}/form/fields/{fieldId}

Requires authorization

Arguments:

  • organizationKey: required string
  • taskId: required string
  • fieldId: required string
  • formInstanceField: required object FormInstanceField
  • callback: required function - function(err, body, resp)

Callback:

Task getTaskMail

Represents call to: GET /{organizationKey}/tasks/{taskId}/mails/{mailId}

Requires authorization

Arguments:

  • organizationKey: required string
  • taskId: required string
  • mailId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Email
  • resp: Http response

Task reopenTask

Represents call to: POST /{organizationKey}/tasks/{taskId}/reopen

Requires authorization

Arguments:

  • organizationKey: required string
  • taskId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: TaskDetail
  • resp: Http response

Workflow

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

Workflow getUserInstance

Workflow proxy

Workflow getTemplates

Represents call to: GET /{organizationKey}/templates

Requires authorization

Arguments:

  • organizationKey: required string
  • category: string
  • callback: required function - function(err, body, resp)

Workflow getWorkflows

Represents call to: GET /{organizationKey}/workflows

Requires authorization

Arguments:

  • organizationKey: required string
  • offset: number
  • pagesize: number
  • trigger: string
  • callback: required function - function(err, body, resp)

Workflow createWorkflows

Represents call to: POST /{organizationKey}/workflows

Requires authorization

Arguments:

  • organizationKey: required string
  • newWorkflow: required object NewWorkflow
  • callback: required function - function(err, body, resp)

Callback:

Workflow createWorkflowsImportBpmn

Represents call to: POST /{organizationKey}/workflows/import/bpmn/{fileId}

Requires authorization

Arguments:

  • organizationKey: required string
  • fileId: required string
  • callback: required function - function(err, body, resp)

Callback:

Workflow createWorkflowsImportJson

Represents call to: POST /{organizationKey}/workflows/import/json

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflow: required object EditorWorkflow
  • callback: required function - function(err, body, resp)

Callback:

Workflow deleteWorkflow

Represents call to: DELETE /{organizationKey}/workflows/{editorWorkflowId}

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • cascade: boolean
  • callback: required function - function(err, body, resp)

Workflow getWorkflow

Represents call to: GET /{organizationKey}/workflows/{editorWorkflowId}

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • callback: required function - function(err, body, resp)

Callback:

Workflow updateWorkflow

Represents call to: PUT /{organizationKey}/workflows/{editorWorkflowId}

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • editorWorkflow: required object EditorWorkflow
  • callback: required function - function(err, body, resp)

Callback:

Workflow createWorkflowActivityTest

Represents call to: POST /{organizationKey}/workflows/{editorWorkflowId}/activities/{activityId}/test

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • activityId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: ScriptResult
  • resp: Http response

Workflow createWorkflowCopy

Represents call to: POST /{organizationKey}/workflows/{editorWorkflowId}/copy

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • callback: required function - function(err, body, resp)

Callback:

Workflow getWorkflowExportBpmn

Represents call to: GET /{organizationKey}/workflows/{editorWorkflowId}/export/bpmn/

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • callback: required function - function(err, body, resp)

Workflow getWorkflowExportJson

Represents call to: GET /{organizationKey}/workflows/{editorWorkflowId}/export/json

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • callback: required function - function(err, body, resp)

Callback:

Workflow createWorkflowLock

Represents call to: POST /{organizationKey}/workflows/{editorWorkflowId}/lock

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • callback: required function - function(err, body, resp)

Callback:

Workflow getWorkflowStartForm

Represents call to: GET /{organizationKey}/workflows/{editorWorkflowId}/startForm

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: FormInstance
  • resp: Http response

Workflow createWorkflowUnlock

Represents call to: POST /{organizationKey}/workflows/{editorWorkflowId}/unlock

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • callback: required function - function(err, body, resp)

Workflow updateWorkflowUpdateBpmn

Represents call to: PUT /{organizationKey}/workflows/{editorWorkflowId}/update/bpmn

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • body: required string
  • callback: required function - function(err, body, resp)

Callback:

Workflow getWorkflowVersions

Represents call to: GET /{organizationKey}/workflows/{editorWorkflowId}/versions

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • offset: number
  • pagesize: number
  • callback: required function - function(err, body, resp)

Workflow createWorkflowVersions

Represents call to: POST /{organizationKey}/workflows/{editorWorkflowId}/versions

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • versionRequest: required object VersionRequest
  • callback: required function - function(err, body, resp)

Callback:

Workflow createWorkflowVersionRestore

Represents call to: POST /{organizationKey}/workflows/{editorWorkflowId}/versions/{versionId}/restore

Requires authorization

Arguments:

  • organizationKey: required string
  • editorWorkflowId: required string
  • versionId: required string
  • callback: required function - function(err, body, resp)

Callback:

Workflow createWorkflowVersionPublish

Represents call to: POST /{organizationKey}/workflows/{workflowId}/versions/{versionId}/publish

Requires authorization

Arguments:

  • organizationKey: required string
  • workflowId: required string
  • versionId: required string
  • callback: required function - function(err, body, resp)

Callback:

WorkflowEngine

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

WorkflowEngine getUserInstance

WorkflowEngine proxy

WorkflowEngine createEngineWorkflowInstances

Represents call to: POST /{organizationKey}/engine/workflow/instances

Requires authorization

Arguments:

  • organizationKey: required string
  • triggerInstance: required object TriggerInstance
  • callback: required function - function(err, body, resp)

Callback:

Organization

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

Organization getUserInstance

Organization proxy

Organization create

Represents call to: POST /

Arguments:

  • organization: required object Organization
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Organization
  • resp: Http response

Organization getSystemconfiguration

Represents call to: GET /systemconfiguration

Arguments:

  • callback: required function - function(err, body, resp)

Callback:

Organization delete

Represents call to: DELETE /{organizationKey}

Requires authorization

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Organization get

Represents call to: GET /{organizationKey}

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Organization
  • resp: Http response

Organization update

Represents call to: PUT /{organizationKey}

Requires authorization

Arguments:

  • organizationKey: required string
  • organization: required object Organization
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Organization
  • resp: Http response

Organization getFeatures

Represents call to: GET /{organizationKey}/features

Requires authorization

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Organization getGroups

Represents call to: GET /{organizationKey}/groups/{groupId}

Requires authorization

Arguments:

  • organizationKey: required string
  • groupId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Group
  • resp: Http response

Organization createGroups

Represents call to: POST /{organizationKey}/groups

Requires authorization

Arguments:

  • organizationKey: required string
  • group: required object Group
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Group
  • resp: Http response

Organization deleteGroups

Represents call to: DELETE /{organizationKey}/groups/{groupId}

Requires authorization

Arguments:

  • organizationKey: required string
  • groupId: required string
  • callback: required function - function(err, body, resp)

Organization updateGroups

Represents call to: PUT /{organizationKey}/groups/{groupId}

Requires authorization

Arguments:

  • organizationKey: required string
  • groupId: required string
  • group: required object Group
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Group
  • resp: Http response

Organization getInfoLicenses

Represents call to: GET /{organizationKey}/info/licenses

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Organization deleteInvitations

Represents call to: DELETE /{organizationKey}/invitations/{inviteeMailAddress}

Requires authorization

Arguments:

  • organizationKey: required string
  • inviteeMailAddress: required string
  • callback: required function - function(err, body, resp)

Organization createInvitationsResend

Represents call to: POST /{organizationKey}/invitations/{inviteeMailAddress}/resend

Requires authorization

Arguments:

  • organizationKey: required string
  • inviteeMailAddress: required string
  • callback: required function - function(err, body, resp)

Organization getLdapGroupMembers

Represents call to: GET /{organizationKey}/ldap/groupMembers

Requires authorization

Arguments:

  • organizationKey: required string
  • ldapGroup: required object LdapGroup
  • callback: required function - function(err, body, resp)

Organization getLdapGroups

Represents call to: GET /{organizationKey}/ldap/groups

Requires authorization

Arguments:

  • organizationKey: required string
  • exclude: string
  • callback: required function - function(err, body, resp)

Organization getLdapUsers

Represents call to: GET /{organizationKey}/ldap/users

Requires authorization

Arguments:

  • organizationKey: required string
  • exclude: string
  • callback: required function - function(err, body, resp)

Organization createLicenseProfiles

Represents call to: POST /{organizationKey}/licenseProfiles/{profile}

Requires authorization

Arguments:

  • organizationKey: required string
  • profile: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Organization
  • resp: Http response

Organization getLicenses

Represents call to: GET /{organizationKey}/licenses

Requires authorization

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Organization getLicense

Represents call to: GET /{organizationKey}/licenses/{licenseId}

Requires authorization

Arguments:

  • organizationKey: required string
  • licenseId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: License
  • resp: Http response

Organization updateLicense

Represents call to: PUT /{organizationKey}/licenses/{licenseId}

Requires authorization

Arguments:

  • organizationKey: required string
  • licenseId: required string
  • license: required object License
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: License
  • resp: Http response

Organization getOrganizations

Represents call to: GET /{organizationKey}/organizations

Arguments:

  • name: string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Organization
  • resp: Http response

Organization createPurchase

Represents call to: POST /{organizationKey}/purchase

Arguments:

  • organizationKey: required string
  • purchaseOrder: required object PurchaseOrder
  • callback: required function - function(err, body, resp)

Organization createUsers

Represents call to: POST /{organizationKey}/users

Requires authorization

Arguments:

  • organizationKey: required string
  • newUser: required object NewUser
  • callback: required function - function(err, body, resp)

Organization deleteUser

Represents call to: DELETE /{organizationKey}/users/{userId}

Requires authorization

Arguments:

  • organizationKey: required string
  • userId: required string
  • callback: required function - function(err, body, resp)

Service

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

Service getUserInstance

Service proxy

Service getOauth_callback

Represents call to: GET /oauth_callback

Arguments:

  • state: string
  • code: string
  • error: string
  • callback: required function - function(err, body, resp)

Service getServiceAccounts

Represents call to: GET /{organizationKey}/services/{serviceKey}/accounts

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • excludeOwner: string
  • callback: required function - function(err, body, resp)

Service createServiceAccounts

Represents call to: POST /{organizationKey}/services/{serviceKey}/accounts

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • account: required object Account
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Account
  • resp: Http response

Service getServiceAccount

Represents call to: GET /{organizationKey}/services/{serviceKey}/accounts/{accountId}

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • accountId: required string
  • excludeOwner: string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Account
  • resp: Http response

Service updateServiceAccount

Represents call to: PUT /{organizationKey}/services/{serviceKey}/accounts/{accountId}

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • accountId: required string
  • account: required object Account
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Account
  • resp: Http response

Service getServiceAccountOption

Represents call to: GET /{organizationKey}/services/{serviceKey}/accounts/{accountId}/options/{optionsKey}

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • accountId: required string
  • optionsKey: required string
  • excludeOwner: string
  • callback: required function - function(err, body, resp)

Service getServiceAccountReferences

Represents call to: GET /{organizationKey}/services/{serviceKey}/accounts/{accountId}/references

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • accountId: required string
  • q: string
  • parent: string
  • pathTo: string
  • excludeOwner: string
  • callback: required function - function(err, body, resp)

Service getServiceOption

Represents call to: GET /{organizationKey}/services/{serviceKey}/options/{optionsKey}

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • accountId: required string
  • optionsKey: required string
  • excludeOwner: string
  • callback: required function - function(err, body, resp)

Service getServices

Represents call to: GET /{organizationKey}/services

Requires authorization

Arguments:

  • organizationKey: required string
  • callback: required function - function(err, body, resp)

Service createServicesOauthStart

Represents call to: POST /{organizationKey}/services/oauth/start

Requires authorization

Arguments:

  • organizationKey: required string
  • oauthStartRequest: required object OauthStartRequest
  • callback: required function - function(err, body, resp)

Callback:

Service deleteServiceAccount

Represents call to: DELETE /{organizationKey}/services/{serviceKey}/accounts/{accountId}

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • accountId: required string
  • callback: required function - function(err, body, resp)

Service createServiceActionInstancesLock

Represents call to: POST /{organizationKey}/services/{serviceKey}/actionInstances/lock

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • actionInstance: required object ActionInstance
  • callback: required function - function(err, body, resp)

Callback:

Service createServiceActionInstancesEnd

Represents call to: POST /{organizationKey}/services/{serviceKey}/actionInstances/{actionInstanceId}/end

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • actionInstanceId: required string
  • actionInstanceEnd: required object ActionInstanceEnd
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: EmptyObject
  • resp: Http response

Service getServiceIcon

Represents call to: GET /{organizationKey}/services/{serviceKey}/icon

Requires authorization

Arguments:

  • organizationKey: required string
  • serviceKey: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: FileStream
  • resp: Http response

User

Constructor:

  • options
    • authorization: string - Authorization token, will be set as Authorization http header
    • credentials: object - Default credentials
      • username: string - Username
      • password: string - Password
    • basePath: string - Effektif-api base url, defaults to api endpoint documentation basePath
    • onUnauthorized: function - Excecuted when an unauthorized call was made or authorization token is missing. Receives operation arguments and callback
    • users: object - Users instance
      • login: required function - Login function
    • log: function - Logging function, defaults to console.log
    • baseRequest: function - Default request

User getUserInstance

User proxy

User getAbout

Represents call to: GET /about

Requires authorization

Arguments:

  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: About
  • resp: Http response

User createLogin

Represents call to: POST /login/{providerKey}

Arguments:

  • providerKey: required string
  • serviceLogin: required object ServiceLogin
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: ServiceLogin
  • resp: Http response

User updateLogin

Represents call to: PUT /login/{providerKey}

Arguments:

  • providerKey: required string
  • code: string
  • state: string
  • error: string
  • error_description: string
  • serviceLogin: required object ServiceLogin
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: ServiceLogin
  • resp: Http response

User createRegistrations

Represents call to: POST /registrations

Arguments:

  • registrationRequest: required object RegistrationRequest
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: EmptyObject
  • resp: Http response

User getRegistration

Represents call to: GET /registrations/{code}

Arguments:

  • code: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: Registration
  • resp: Http response

User activateRegistration

Represents call to: POST /registrations/{code}/activate

Arguments:

  • code: required string
  • registrationRequest: required object RegistrationRequest
  • callback: required function - function(err, body, resp)

Callback:

User getRegistrationPicture

Represents call to: GET /registrations/{code}/picture

Arguments:

  • code: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: FileStream
  • resp: Http response

User createRegistrationPicture

Represents call to: POST /registrations/{code}/picture

Arguments:

  • code: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: EmptyObject
  • resp: Http response

User createRegistrationPictureiframe

Represents call to: POST /registrations/{code}/pictureiframe

Arguments:

  • code: required string
  • callback: required function - function(err, body, resp)

User createUsersConfirm

Represents call to: POST /users/confirm

Arguments:

  • passwordResetConfirmation: required object PasswordResetConfirmation
  • callback: required function - function(err, body, resp)

Callback:

User createUsersLogin

Represents call to: POST /users/login

Arguments:

  • loginRequest: required object LoginRequest
  • callback: required function - function(err, body, resp)

User createUsersLoginHandover

Represents call to: POST /users/login/handover

Arguments:

  • handoverLogin: required object HandoverLogin
  • callback: required function - function(err, body, resp)

Callback:

User createUsersReset

Represents call to: POST /users/reset

Arguments:

  • userMailAddress: required object UserMailAddress
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: EmptyObject
  • resp: Http response

User getUser

Represents call to: GET /{organizationKey}/users/{userId}

Requires authorization

Arguments:

  • organizationKey: required string
  • userId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: User
  • resp: Http response

User updateUser

Represents call to: PUT /{organizationKey}/users/{userId}

Arguments:

  • userId: required string
  • user: required object User
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: User
  • resp: Http response

User createUserPicture

Represents call to: POST /{organizationKey}/users/{userId}/picture

Arguments:

  • userId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: EmptyObject
  • resp: Http response

User createUserPictureiframe

Represents call to: POST /{organizationKey}/users/{userId}/pictureiframe

Arguments:

  • userId: required string
  • callback: required function - function(err, body, resp)

User getUsers

Represents call to: GET /{organizationKey}/users

Arguments:

  • organizationKey: required string
  • emailAddress: string
  • name: string
  • offset: number
  • pagesize: number
  • callback: required function - function(err, body, resp)

User createUserHandover

Represents call to: POST /{organizationKey}/users/{userId}/handover

Requires authorization

Arguments:

  • organizationKey: required string
  • userId: required string
  • handoverLogin: required object HandoverLogin
  • callback: required function - function(err, body, resp)

Callback:

User createUserLeave

Represents call to: POST /{organizationKey}/users/{userId}/leave

Requires authorization

Arguments:

  • organizationKey: required string
  • userId: required string
  • leaveRequest: required object LeaveRequest
  • callback: required function - function(err, body, resp)

User getUserPicture

Represents call to: GET /{organizationKey}/users/{userId}/picture

Arguments:

  • organizationKey: required string
  • userId: required string
  • callback: required function - function(err, body, resp)

Callback:

  • error: Error or null
  • body: FileStream
  • resp: Http response

User updateUserPreferences

Represents call to: PUT /{workspaceKey}/users/{userId}/preferences

Requires authorization

Arguments:

  • put any json in here: string
  • callback: required function - function(err, body, resp)

Models

Model File

  • contentType: string
  • created: date
  • name: string
  • id: string
  • mailId: string
  • organizationId: string
  • ownerId: string
  • pictureRegistrationId: string
  • sizeInBytes: number
  • caseId: string
  • userId: string

Used by: File.createFiles File.getFile Case.createCaseFiles Case.createCaseFile

Model FileStream

  • inputStream: binary
  • contentType: string
  • contentDispositionInlineFileName: string
  • cacheControlMaxAgeInMillis: number

Used by: File.getFileStream Service.getServiceIcon User.getRegistrationPicture User.getUserPicture

Model NewCase

  • properties: any api type Map
  • id: string
  • organizationId: string
  • name: string
  • nameLower: string
  • description: string
  • access: any api type AccessControlList
  • creatorId: string
  • createTime: date
  • dueDate: date
  • hasDueDate: boolean
  • priority: number
  • hasPriority: boolean
  • participantIds: array string
  • taskIds: array string
  • lastUpdated: date
  • canceled: boolean
  • closed: boolean
  • workflowInstanceId: any api type WorkflowInstanceId
  • sourceWorkflowId: string
  • workflowId: string
  • triggerInstance: object
    • data: any api type Map
    • workflowInstanceId: any api type WorkflowInstanceId
    • workflowId: any api type WorkflowId
    • sourceWorkflowId: string
    • startActivityIds: array string
    • businessKey: string
    • callerWorkflowInstanceId: any api type WorkflowInstanceId
    • callerActivityInstanceId: string

Used by: Case.createCases

Model CaseDetail

  • properties: any api type Map
  • id: string
  • organizationId: string
  • name: string
  • nameLower: string
  • description: string
  • access: any api type AccessControlList
  • creatorId: string
  • createTime: date
  • dueDate: date
  • hasDueDate: boolean
  • priority: number
  • hasPriority: boolean
  • participantIds: array string
  • taskIds: array string
  • lastUpdated: date
  • canceled: boolean
  • closed: boolean
  • workflowInstanceId: any api type WorkflowInstanceId
  • sourceWorkflowId: string
  • workflowId: string
  • creator: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • tasks: array TaskDetail
  • events: array Event
  • participants: array User
  • sourceWorkflow: object
    • properties: any api type Map
    • name: string
    • description: string
    • bpmn: any api type XmlElement
    • activities: array any api type Activity
    • transitions: array any api type Transition
    • variables: array any api type Variable
    • timers: array any api type Timer
    • id: any api type WorkflowId
    • trigger: any api type Trigger
    • enableCases: boolean
    • diagram: any api type Diagram
    • ownerId: string
    • editorId: string
    • editorLock: date
    • lastUpdated: date
    • category: string
    • changed: boolean
    • latestVersion: string
    • caseColumns: array any api type CaseColumn
    • template: boolean
    • templateId: string
    • nameLower: string

Used by: Case.createCases Case.getCase Case.updateCase Case.cancel Case.close

Model Case

  • properties: any api type Map
  • id: string
  • organizationId: string
  • name: string
  • nameLower: string
  • description: string
  • access: any api type AccessControlList
  • creatorId: string
  • createTime: date
  • dueDate: date
  • hasDueDate: boolean
  • priority: number
  • hasPriority: boolean
  • participantIds: array string
  • taskIds: array string
  • lastUpdated: date
  • canceled: boolean
  • closed: boolean
  • workflowInstanceId: any api type WorkflowInstanceId
  • sourceWorkflowId: string
  • workflowId: string

Used by: Case.updateCase

Model Event

  • id: string
  • caseId: string
  • name: string
  • task: object
    • properties: any api type Map
    • id: string
    • organizationId: string
    • name: string
    • nameLower: string
    • description: string
    • access: any api type AccessControlList
    • creatorId: string
    • createTime: date
    • assigneeId: string
    • candidateIds: array string
    • candidateGroupIds: array string
    • caseId: string
    • parentId: string
    • subtaskIds: array string
    • dueDate: date
    • lastUpdated: date
    • canceled: boolean
    • completed: boolean
    • activityId: string
    • activityInstanceId: string
    • activityInstanceMessage: boolean
    • hasForm: boolean
    • workflowInstanceId: any api type WorkflowInstanceId
    • sourceWorkflowId: string
    • workflowId: any api type WorkflowId
    • roleVariableId: string
    • form: object
  • taskId: string
  • time: date
  • user: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • userId: string

Used by: Case.createCaseEvents

Model NewTask

  • properties: any api type Map
  • id: string
  • organizationId: string
  • name: string
  • nameLower: string
  • description: string
  • access: any api type AccessControlList
  • creatorId: string
  • createTime: date
  • assigneeId: string
  • candidateIds: array string
  • candidateGroupIds: array string
  • caseId: string
  • parentId: string
  • subtaskIds: array string
  • dueDate: date
  • lastUpdated: date
  • canceled: boolean
  • completed: boolean
  • activityId: string
  • activityInstanceId: string
  • activityInstanceMessage: boolean
  • hasForm: boolean
  • workflowInstanceId: any api type WorkflowInstanceId
  • sourceWorkflowId: string
  • workflowId: any api type WorkflowId
  • roleVariableId: string
  • form: object

Used by: Task.createTasks

Model TaskDetail

  • properties: any api type Map
  • id: string
  • organizationId: string
  • name: string
  • nameLower: string
  • description: string
  • access: any api type AccessControlList
  • creatorId: string
  • createTime: date
  • assigneeId: string
  • candidateIds: array string
  • candidateGroupIds: array string
  • caseId: string
  • parentId: string
  • subtaskIds: array string
  • dueDate: date
  • lastUpdated: date
  • canceled: boolean
  • completed: boolean
  • activityId: string
  • activityInstanceId: string
  • activityInstanceMessage: boolean
  • hasForm: boolean
  • workflowInstanceId: any api type WorkflowInstanceId
  • sourceWorkflowId: string
  • workflowId: any api type WorkflowId
  • roleVariableId: string
  • form: object
  • creator: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • assignee: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • candidates: array User
  • candidateGroups: array Group
  • subtasks: array TaskDetail

Used by: Task.createTasks Task.getTask Task.updateTask Task.completeTask Task.reopenTask

Model Task

  • properties: any api type Map
  • id: string
  • organizationId: string
  • name: string
  • nameLower: string
  • description: string
  • access: any api type AccessControlList
  • creatorId: string
  • createTime: date
  • assigneeId: string
  • candidateIds: array string
  • candidateGroupIds: array string
  • caseId: string
  • parentId: string
  • subtaskIds: array string
  • dueDate: date
  • lastUpdated: date
  • canceled: boolean
  • completed: boolean
  • activityId: string
  • activityInstanceId: string
  • activityInstanceMessage: boolean
  • hasForm: boolean
  • workflowInstanceId: any api type WorkflowInstanceId
  • sourceWorkflowId: string
  • workflowId: any api type WorkflowId
  • roleVariableId: string
  • form: object

Used by: Task.updateTask

Model FormInstanceField

  • properties: any api type Map
  • id: string
  • key: string
  • name: string
  • description: string
  • type: any api type DataType
  • readOnly: boolean
  • required: boolean
  • asButtons: boolean
  • value: any api type Object

Used by: Task.completeTask Task.updateTaskFormField

Model Email

  • id: string
  • headers: any api type Map
  • attachmentIds: array string
  • bcc: array string
  • bodyText: string
  • bodyHtml: string
  • cc: array string
  • from: array string
  • fromName: string
  • organizationId: string
  • preview: string
  • replyTo: array string
  • source: string
  • subject: string
  • sendDate: date
  • to: array string

Used by: Task.getTaskMail

Model NewWorkflow

  • properties: any api type Map
  • name: string
  • description: string
  • bpmn: any api type XmlElement
  • activities: array any api type Activity
  • transitions: array any api type Transition
  • variables: array any api type Variable
  • timers: array any api type Timer
  • id: any api type WorkflowId
  • trigger: any api type Trigger
  • enableCases: boolean
  • diagram: any api type Diagram
  • ownerId: string
  • editorId: string
  • editorLock: date
  • lastUpdated: date
  • category: string
  • changed: boolean
  • latestVersion: string
  • caseColumns: array any api type CaseColumn
  • template: boolean
  • templateId: string
  • nameLower: string
  • isPrivate: boolean

Used by: Workflow.createWorkflows

Model EditorWorkflowDetail

  • properties: any api type Map
  • name: string
  • description: string
  • bpmn: any api type XmlElement
  • activities: array any api type Activity
  • transitions: array any api type Transition
  • variables: array any api type Variable
  • timers: array any api type Timer
  • id: any api type WorkflowId
  • trigger: any api type Trigger
  • enableCases: boolean
  • diagram: any api type Diagram
  • ownerId: string
  • editorId: string
  • editorLock: date
  • lastUpdated: date
  • category: string
  • changed: boolean
  • latestVersion: string
  • caseColumns: array any api type CaseColumn
  • template: boolean
  • templateId: string
  • nameLower: string
  • editor: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • owner: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean

Used by: Workflow.createWorkflows Workflow.getWorkflow Workflow.updateWorkflow Workflow.createWorkflowCopy Workflow.createWorkflowVersionRestore

Model AbstractWorkflow

  • properties: any api type Map
  • name: string
  • description: string
  • bpmn: any api type XmlElement
  • activities: array any api type Activity
  • transitions: array any api type Transition
  • variables: array any api type Variable
  • timers: array any api type Timer
  • id: any api type WorkflowId
  • trigger: any api type Trigger
  • enableCases: boolean
  • diagram: any api type Diagram

Used by: Workflow.createWorkflowsImportBpmn

Model EditorWorkflow

  • properties: any api type Map
  • name: string
  • description: string
  • bpmn: any api type XmlElement
  • activities: array any api type Activity
  • transitions: array any api type Transition
  • variables: array any api type Variable
  • timers: array any api type Timer
  • id: any api type WorkflowId
  • trigger: any api type Trigger
  • enableCases: boolean
  • diagram: any api type Diagram
  • ownerId: string
  • editorId: string
  • editorLock: date
  • lastUpdated: date
  • category: string
  • changed: boolean
  • latestVersion: string
  • caseColumns: array any api type CaseColumn
  • template: boolean
  • templateId: string
  • nameLower: string

Used by: Workflow.createWorkflowsImportJson Workflow.updateWorkflow Workflow.getWorkflowExportJson Workflow.createWorkflowLock Workflow.updateWorkflowUpdateBpmn

Model ScriptResult

  • result: any api type Object
  • error: string
  • log: string
  • variableUpdates: any api type Map

Used by: Workflow.createWorkflowActivityTest

Model FormInstance

Used by: Workflow.getWorkflowStartForm

Model VersionRequest

  • commitMessage: string

Used by: Workflow.createWorkflowVersions

Model ExecutableWorkflow

  • properties: any api type Map
  • name: string
  • description: string
  • bpmn: any api type XmlElement
  • activities: array any api type Activity
  • transitions: array any api type Transition
  • variables: array any api type Variable
  • timers: array any api type Timer
  • id: any api type WorkflowId
  • trigger: any api type Trigger
  • enableCases: boolean
  • diagram: any api type Diagram
  • sourceWorkflowId: string
  • createTime: date
  • creatorId: string

Used by: Workflow.createWorkflowVersions Workflow.createWorkflowVersionPublish

Model TriggerInstance

  • data: any api type Map
  • workflowInstanceId: any api type WorkflowInstanceId
  • workflowId: any api type WorkflowId
  • sourceWorkflowId: string
  • startActivityIds: array string
  • businessKey: string
  • callerWorkflowInstanceId: any api type WorkflowInstanceId
  • callerActivityInstanceId: string

Used by: WorkflowEngine.createEngineWorkflowInstances

Model WorkflowInstance

  • properties: any api type Map
  • start: date
  • end: date
  • endState: string
  • duration: number
  • activityInstances: array any api type ActivityInstance
  • variableInstances: array any api type VariableInstance
  • timerInstances: array any api type TimerInstance
  • id: any api type WorkflowInstanceId
  • workflowId: any api type WorkflowId
  • businessKey: string
  • creatorId: string
  • callerWorkflowInstanceId: any api type WorkflowInstanceId
  • callerActivityInstanceId: string
  • caseId: string

Used by: WorkflowEngine.createEngineWorkflowInstances

Model Organization

  • id: string
  • key: string
  • name: string
  • createdBy: string
  • customCSS: string
  • disabled: boolean
  • licenseProfileIds: array string
  • licenseRequired: boolean
  • licenseType: string
  • admin: boolean
  • adminIds: array string
  • admins: array User
  • memberIds: array string
  • systemUserIds: array string
  • systemUsers: array User
  • invitations: array string
  • ldapConnector: any api type LdapConnector
  • timeZone: string

Used by: Organization.create Organization.get Organization.update Organization.createLicenseProfiles Organization.getOrganizations

Model SystemConfiguration

  • registrationEnabled: boolean
  • authenticationProviders: array string
  • licenseTypes: array any api type LicenseType

Used by: Organization.getSystemconfiguration

Model Group

  • id: string
  • ldapDn: string
  • name: string
  • organizationId: string
  • userIds: array string

Used by: Organization.getGroups Organization.createGroups Organization.updateGroups

Model LdapGroup

  • name: string
  • memberCount: any api type Integer
  • dn: string

Used by: Organization.getLdapGroupMembers

Model License

  • id: string
  • creationDate: date
  • expirationDate: date
  • generatedById: string
  • invitee: string
  • organizationId: string
  • organization: object
    • id: string
    • key: string
    • name: string
    • createdBy: string
    • customCSS: string
    • disabled: boolean
    • licenseProfileIds: array string
    • licenseRequired: boolean
    • licenseType: string
    • admin: boolean
    • adminIds: array string
    • admins: array User
    • memberIds: array string
    • systemUserIds: array string
    • systemUsers: array User
    • invitations: array string
    • ldapConnector: any api type LdapConnector
    • timeZone: string
  • packages: array string
  • type: string
  • userId: string
  • user: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean

Used by: Organization.getLicense Organization.updateLicense

Model PurchaseOrder

  • id: string
  • billingType: string
  • completed: boolean
  • completedById: string
  • completedBy: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • count: number
  • created: date
  • generatorIds: array string
  • licenseIds: array string
  • licenseType: string
  • message: string
  • muted: boolean
  • orderedById: string
  • orderedBy: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • organizationId: string
  • organization: object
    • id: string
    • key: string
    • name: string
    • createdBy: string
    • customCSS: string
    • disabled: boolean
    • licenseProfileIds: array string
    • licenseRequired: boolean
    • licenseType: string
    • admin: boolean
    • adminIds: array string
    • admins: array User
    • memberIds: array string
    • systemUserIds: array string
    • systemUsers: array User
    • invitations: array string
    • ldapConnector: any api type LdapConnector
    • timeZone: string

Used by: Organization.createPurchase

Model NewUser

  • emailAddress: string
  • password: string
  • firstName: string
  • lastName: string
  • color: string
  • systemUser: boolean
  • external: boolean
  • token: string
  • organizationIds: array string
  • license: string
  • licenseInfo: string

Used by: Organization.createUsers

Model Account

  • id: string
  • serviceKey: string
  • userId: string
  • access: any api type AccessControlList
  • restricted: boolean

Used by: Service.createServiceAccounts Service.getServiceAccount Service.updateServiceAccount

Model OauthStartRequest

  • path: string
  • serviceKey: string
  • accountId: string

Used by: Service.createServicesOauthStart

Model OauthStartResponse

  • authorizationUrl: string

Used by: Service.createServicesOauthStart

Model ActionInstance

  • id: string
  • organizationId: string
  • serviceKey: string
  • actionKey: string
  • editorWorkflowId: string
  • caseId: string
  • workflowInstanceId: string
  • activityInstanceId: string
  • configuration: any api type Map
  • inputValues: any api type Map
  • lock: date

Used by: Service.createServiceActionInstancesLock

Model ActionInstanceEnd

  • outputValues: any api type Map

Used by: Service.createServiceActionInstancesEnd

Model EmptyObject

Used by: Service.createServiceActionInstancesEnd User.createRegistrations User.createRegistrationPicture User.createUsersReset User.createUserPicture

Model About

  • version: string
  • buildDate: string
  • latestCommits: array string

Used by: User.getAbout

Model ServiceLogin

  • stateReference: string
  • authenticationUrl: string
  • token: string
  • redirectTo: string
  • hostname: string

Used by: User.createLogin User.updateLogin

Model RegistrationRequest

  • emailAddress: string
  • password: string
  • firstName: string
  • lastName: string
  • phone: string
  • organizationName: string
  • color: string
  • newsletter: boolean
  • country: string
  • language: string
  • edition: string
  • timeZone: string

Used by: User.createRegistrations User.activateRegistration

Model Registration

  • id: string
  • code: string
  • created: date
  • edition: string
  • newsletter: boolean
  • organization: object
    • id: string
    • key: string
    • name: string
    • createdBy: string
    • customCSS: string
    • disabled: boolean
    • licenseProfileIds: array string
    • licenseRequired: boolean
    • licenseType: string
    • admin: boolean
    • adminIds: array string
    • admins: array User
    • memberIds: array string
    • systemUserIds: array string
    • systemUsers: array User
    • invitations: array string
    • ldapConnector: any api type LdapConnector
    • timeZone: string
  • organizationId: string
  • token: string
  • user: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean

Used by: User.getRegistration

Model LoginResponse

  • token: string
  • user: object
    • id: string
    • admin: boolean
    • color: string
    • country: string
    • created: date
    • disabled: boolean
    • external: boolean
    • firstName: string
    • groupIds: array string
    • lastName: string
    • ldapDn: string
    • emailAddress: string
    • licenses: array License
    • organizationIds: array string
    • organizations: array Organization
    • password: string
    • phone: string
    • preferences: any api type Map
    • systemAdmin: boolean
    • systemUser: boolean
  • organizations: array Organization

Used by: User.activateRegistration User.createUsersConfirm

Model PasswordResetConfirmation

  • code: string
  • password: string

Used by: User.createUsersConfirm

Model LoginRequest

  • emailAddress: string
  • password: string
  • token: string
  • hostname: string
  • path: string
  • organizationKey: string

Used by: User.createUsersLogin

Model HandoverLogin

  • reference: string
  • token: string
  • redirectTo: string
  • organizationKey: string

Used by: User.createUsersLoginHandover User.createUserHandover

Model UserMailAddress

  • emailAddress: string

Used by: User.createUsersReset

Model User

  • id: string
  • admin: boolean
  • color: string
  • country: string
  • created: date
  • disabled: boolean
  • external: boolean
  • firstName: string
  • groupIds: array string
  • lastName: string
  • ldapDn: string
  • emailAddress: string
  • licenses: array License
  • organizationIds: array string
  • organizations: array Organization
  • password: string
  • phone: string
  • preferences: any api type Map
  • systemAdmin: boolean
  • systemUser: boolean

Used by: User.getUser User.updateUser

Model LeaveRequest

  • organizationId: string

Used by: User.createUserLeave