fileee API flowground Connector

Description

A generated flowground connector for the fileee API API (version 2.0.0-SNAPSHOT).

Generated from: https://api.workeee.de/v2
Generated at: 2020-06-02T08:25:15+00:00

API Description

The fileee API contains methods for accessing documents and other data in a fileee user account. API built on 2020-06-02T05:53:03Z.

• Authorization follows the OAuth 2.0 standard, specifically the Authorization Code Grant type.
  
  • Most API calls require the access token in the Authorization HTTP request header as a string of the form Bearer 12345xy (where 12345xy needs to be replaced with the actual access token).
    
  • The authorization endpoint is available at an URL of the form https://my.workeee.de/oauth/authorize?response_type=code with the following additional request parameters: client_id= your unique client ID (REQUIRED), redirect_uri= the URI where the client should be redirected after authorization (REQUIRED), scope= the space separated list of requested scopes (OPTIONAL), state= will be passed back to the redirect endpoint unmodified (RECOMMENDED).
    
• All unique IDs are strings in the format of BSON ObjectIds.
  

Authorization

Supported authorization schemes:

• OAuth2 - Normal fileee access token-based authorization.

For OAuth 2.0 you need to specify OAuth Client credentials as environment variables in the connector repository:

• OAUTH_CLIENT_ID - your OAuth client id
• OAUTH_CLIENT_SECRET - your OAuth client secret

Actions

Get the latest quality report of the specified data set from categorization.

Tags: Analysis

Input Parameters

• dataSetUuid - required - Identifier of the data set.
  
• Authorization - required - OAuth access token
  

Add a document to the fileee analysis data.

Tags: Analysis

Input Parameters

• Authorization - required - OAuth access token
  

Get the latest quality report of the specified data set.

Tags: Analysis

Input Parameters

• dataSetUuid - required - Identifier of the data set.
  
• labelUuid - required - Identifier of the label to get quality for.
  
• Authorization - required - OAuth access token
  

Get the latest quality report of the specified data set from extraction.

Tags: Analysis

Input Parameters

• dataSetUuid - required - Identifier of the data set.
  
• Authorization - required - OAuth access token
  

Get the latest quality report of the specified data set.

Tags: Analysis

Input Parameters

• dataSetUuid - required - Identifier of the data set.
  
• Authorization - required - OAuth access token
  

Import model from cockpit and upload to ThinkOwl.

Tags: Analysis

Input Parameters

• datasetUuid - required - Identifier of the dataset.
  
• modelType - optional - Imports and exports the itag or categorizer model of data set based on the value of 'modelType'. If this parameter is not provided then, type will be detected based on dataset snapshots.
  Possible values: ITAG_MODEL, ICAT_MODEL.
• Authorization - required - OAuth access token
  

API to create a special short-time login token.

This API can be called with a valid access token to generate a new specialized token (not following any standard OAuth process) that can be used for a short time to login to the same account on a different device.

Tags: Authorization

Input Parameters

• Authorization - required - OAuth access token
  

API to revoke and invalidate an OAuth token.

Revoke or invalidate a token that is not needed any longer. Returns an empty response. After calling this method, the token (both access and refresh token, regardless of which one you passed) should not be used any longer.

Tags: Authorization

API to get and exchange OAuth tokens.

Exchange an authorization code into access and refresh tokens or (depending on the grant type) get a new access token using the refresh token.

• Depending on what you want to do, exactly one of code or refresh_token is required.
  
• For the authorization_code grant type (i.e. exchanging a code into tokens), you need to specify the code in the code parameter, for the refresh_token grant type (i.e. refreshing an access token) you need to give the refresh token in the refresh_token.
  
• The password grant type is only available for special clients
  

Tags: Authorization

Get own user-information

Can be used to get information (like the participant ID) about the user associated with the supplied token (which needs to be valid).

Tags: Authorization

Input Parameters

• Authorization - required - OAuth access token
  

Lists all available conversation-templates for a company

Tags: ConversationTemplates

Input Parameters

• Authorization - required - OAuth access token
  

Create a new conversation.

Only very specific fields in the conversation can be initially set. The title is the only mandatory field you have to specify (and it must be between 2 and 200 characters in length).

• The messages and participants fields can optionally be used to directly add initial messages and participants to a conversation.
  
• A participants ID is either a company ID in the fileee system (for USER and COMPANY) or an email address (for EXTERNAL participants).
  
• See the add message documentation and the add participant documentation below for details on the messages and participant fields supported.
  
• A conversation has a system of roles and permissions controlling what participants can do in the context of this conversation, e.g. if they're allowed to share documents or to invite other users. Each participant has a role that controls the basic permissions they have. In addition, the conversation also has attributes to give everyone (or just specific participants) some additional permissions on top of those from their role. The following fields control the roles and permissions:
  
  • roles: A map from participant ID to the role of that participant.
    
  • defaultAdditionalPermissions: A set of permissions everyone gets in addition to those from their role.
    
  • additionalPermissions: A map from participant ID to a set of permissions that this specific participant gets in addition to those from their role.
    
• For more details about the permission system, see this document
  

Tags: Conversations

Input Parameters

• Authorization - required - OAuth access token
  

Create a new conversation from an existing template.

Tags: Conversations

Input Parameters

• templateId - required
• Authorization - required - OAuth access token
  

Create a new conversation from an existing template.

Tags: Conversations

Input Parameters

• templateId - required
• extraFields - optional
• Authorization - required - OAuth access token
  

Produces sample of the request body for the call 'createFromTemplate'.

The sample request body will contain all variable keys with sample values from all modules of the given template and a sample participant.If any module contains any tasks, there will also be a sample override for the task identifier, for the tags and for the result of each task.

Tags: Conversations

Input Parameters

• templateId - required
• Authorization - required - OAuth access token
  

Get information about an invitation to a conversation.

Get all the information available about an invitation to a conversation (e.g. what is the conversation about, who invited me, do we need password to accept?).

Tags: Conversations

Input Parameters

• conversationToken - required - External token of an invitation
  

Accepts the invitation to a conversation.

Can be used to accept an invitation to a conversation, thereby importing the full conversation into the users fileee account.

Tags: Conversations

Input Parameters

• conversationToken - required - External token of an invitation
  
• Authorization - required - OAuth access token
  

Rejects the invitation to a conversation.

Can be used to reject an invitation to a conversation, thereby also making the token unusable in the future and removing the invitation object from users fileee account.

Tags: Conversations

Input Parameters

• conversationToken - required - External token of an invitation
  
• Authorization - required - OAuth access token
  

Get existing conversation.

Get the current state of a conversation, including all messages and participants.

Tags: Conversations

Input Parameters

• conversationId - required - ID of an existing conversation
  
• Authorization - required - OAuth access token
  

Delete a conversation.

Can be used to completely remove a conversation for all participants. Please note that you need the right permissions to perform this action.

Tags: Conversations

Input Parameters

• conversationId - required - The ID of an existing conversation
  
• Authorization - required - OAuth access token
  

Get the document state of a conversation.

Get the current state of requested and shared documents in a conversation. The requestedDocuments contain all the shared documents that could be matched to requests with their identifiers and information e.g. about the request state. The unassignedDocuments contain the document IDs of all documents shared in this conversation that were not assigned to one of the requests.

Tags: Conversations

Input Parameters

• conversationId - required - ID of an existing conversation
  
• Authorization - required - OAuth access token
  

Share a document in a conversation

Allows uploading and directly sharing a document in an existing conversation.

Please note that this API method uses a new and simplified document JSON model.

Tags: Conversations

Input Parameters

• conversationId - required - ID of an existing conversation
  
• Authorization - required - OAuth access token
  

Leave a conversation.

Can be used to leave a conversation.

Tags: Conversations

Input Parameters

• conversationId - required - The ID of an existing conversation
  
• Authorization - required - OAuth access token
  

Add a message to a conversation.

This method allows adding a message to an existing conversation.

• The conversationId is required, the conversation with that ID has to exist beforehand and the user from the given access token has to be a participant in it.
  
• Only set the id of the message if you are sure you can reliably generate valid ObjectIDs on the client side. If you leave it blank, an ID will be generated for you.
  
• If the timestamp field is left blank, a timestamp will be generated on the server.
  
• The senderId field refers to the ID of the participant. If you leave this blank, the user from the given access token is assumed to be the sender.
  
• The onlyVisibleFor field can optionally contain a set of participant IDs if you want to limit visibility of the message to specific participants.
  
• Some of the messages (e.g. DOCUMENT) actually trigger the respective action (e.g. sharing a document), so be careful to only add them if you actually want that to happen.
  

The following list describes the message types supported and their respective fields. All of this also applies to the messages that can be directly added using the create conversation API method.

---
`CHAT`: Normal textual chat message.
```
{
"type": "CHAT",
"senderId": "5798835568c0e021ebc6eb48",
"message": "Hello there"
}
```
---
`DOCUMENT`: Share an existing document in this conversation. The document has to be already uploaded to the sending users fileee account. The `identifier` can optionally be set to match this document to one requested by the `REQUEST_DOCUMENTS` message described below. The `remove` flag can optionally be set to `true` to remove an existing document with the given `documentId` from the conversation (if the `identifier` is also given, that identifier is removed from the shared document and the document is only completely removed if that was the only identifier). A document can only be removed by the user that originally shared it.
```
{
"type": "DOCUMENT",
"documentId": "5798835568c0e021ebc6eb3e",
"identifier": "PAY_STATEMENT1",
"remove": false
}
```
---
`STATUS`: Changes the conversation status (e.g. if it is OPEN new messages can be added, if its CLOSED no new messages can be added by the user).
```
{
"type": "STATUS",
"senderId": "5798835568c0e021ebc6eb48",
"status": "CLOSED"
}
```
---
`META_INFORMATION`: Can be used to exchange programmatic meta-information between all participants in a conversations in a generic map with string keys and string values. This message will never be directly shown to the user. The keys and values used are application-dependent and should be agreed upon for each specific scenario. For compatibility-reasons the keys should not contain dots.
```
{
"type": "META_INFORMATION",
"information": {
"action": "NEW_APPLICATION",
"applicationType": "BUILDING_LOAN",
"applicationId": "FOO-BAR-23"
}
}
```
---
`REQUEST_DOCUMENTS`: Requests specific documents to be shared in this conversations (or updates their state). Multiple documents or a single document (defined by the boolean parameter `allowMultipleDocuments`) can be requested or updated with a single message. All requested documents from all previous messages are accumulated (and newer requests with the same `identifier` replace older requests for the same document) over time, unless `clearPrevious` is specified (after which all previous requests not contained in the current message in this conversation are forgotten).

- For the individual documents the `identifier` is a technical ID unique at least for this conversation,
- the `status` can be used to designate a process-specific review state of a document (can be empty/not set for documents not yet submitted, `submitted` for documents that are submitted but not yet reviewed, `accepted` or `rejected` for reviewed documents),
- the `type` can optionally be specified to narrow down the type of document requested,
- the `tags` can optionally contain a set of user-visible textual tags used for grouping multiple requested documents logically,
- the `name` is a short name shown in the list of requested documents and the `description` is a longer plaintext description shown to the user in detail views.

To update the status of a requested document, another request message has to be sent where the `status` field of the document with the right `identifier` is set to the new value.

```
{
"type": "REQUEST_DOCUMENTS",
"message": "Please share the following documents with us",
"clearPrevious": true,
"allowMultipleDocuments": false,
"documents": [
{ "identifier": "PAY_STATEMENT1", "type": "payslip", "status": "submitted", "name": "Pay statement", "description": "Your pay statement for 2015", "tags": ["Loan", "Brookhaven"], "documentEnhancementConfiguration": {"addWatermark":true, "forbidImageEnhancement": true, "allowedColorMode": "GREYSCALE" } },
{ "identifier": "CERT1", "status": "accepted", "name": "Insurance certificate", "description": "Your insurance certificate for the house", "tags": ["Loan", "Jonestown"] },
{ "identifier": "CERT2", "name": "Other certificate", "description": "Your insurance certificate for the other house", "tags": ["Loan", "Brookhaven"] }
]
}
```
---
`REQUEST_ACTION`: Requests the user to provide information or perform other specific actions. The task described by this message consist of one or more parts or sub-tasks (the individual actions), each resulting in one specific piece of information. This can be used to get the user to e.g. fill out a form, submit an application, cash in a voucher or participate in another business process that requires the users interaction. The overall task and message can have the following properties:

- The `identifier` is a technical ID unique at least for this conversation (newer requests with the same `identifier` replace older tasks),
- the `title` is the title for the overall task,
- the `description` is a longer plaintext description shown to the user when completing the task,
- the `status` can optionally be set to update the status of an existing request with the given identifier,
- the `tags` can optionally contain a set of user-visible textual tags used for grouping multiple requests logically,
- the `thankYouMessage` can optionally be set to specify a message that is shown to the user directly after providing the requested information,
- and finally the `actions` are a list of the actual individual steps or pieces of information required, they must not be empty.

The individual actions can have the following fields:

- the `key` identifies this piece of information (e.g. "shippingAddress"). Required and should be unique among the different actions in one request,
- the `actionType` should be one of `VALUE` (request to provide a value) or `DOCUMENT` (request to provide a document as part of a larger process), other types may be added in the future or supported for fileee-internal purposes,
- the `template` is used to specify a template for a requested `VALUE` action, currently supported templates include `text`, `integer`, `double`, `boolean`, `date`, `date_time`, `amount`, `bank_account` and `address`,
- the `templateOptions` can be used to set template-specific options like the maximum value or other constraints,
- the `title` is a title for this specific action,
- the `description` is a description for this specific action,
- the `fieldDescription` is an optional field description that can be shown in or next to the actual field the user has to fill to provide the value,
- the `optional` flag can be set to `true` if this action is not required and providing it can be skipped by the user.

Some examples follow, but a more detailed explanation about using `REQUEST_ACTION` messages to add tasks for the user can be found [in this document](https://docs.google.com/document/d/1LzavoArlwTpbChWFB3QF9DgfnOmkVLGxPRUSS__s3RM/edit?usp=sharing).

This example shows one task where three pieces of information are requested, a document, a textual value and an amount (with a maximum value):
```
{
"type": "REQUEST_ACTION",
"identifier": "request-payout",
"message": "Hi Jane, your line of credit has been granted. You can now request a payout.",
"title": "Request payout",
"description": "You can request a payout here",
"actions": [
{
"actionType": "DOCUMENT",
"title": "Utility bill",
"description": "The bill you want reimbursed",
"key": "billDocument",
"documentEnhancementConfiguration":
{
"addWatermark":true,
"forbidImageEnhancement": true,
"allowedColorMode": "GREYSCALE"
}
},
{
"actionType": "VALUE",
"template": "text",
"title": "Usage",
"description": "For what do you need the money?",
"key": "usage"
},
{
"actionType": "VALUE",
"template": "amount",
"templateOptions": {
"max": 5000
},
"title": "Payout Amount",
"description": "How much money should be disbursed?",
"fieldDescription": "Amount",
"key": "payoutAmount"
}
]
}
```
This is an example how to completely remove an existing 'REQUEST_ACTION' task from the list of current tasks:
```
{
"type": "REQUEST_ACTION",
"identifier": "request-payout",
"status": "removed"
}
```

---
`ACTION_RESULT`: Describes the result returned in response to a `REQUEST_ACTION` message. Should never be added by external partners, but will be generated by the fileee apps and is document here for consistency.
```
{
"type": "ACTION_RESULT",
"id": "58de7f90d57e3ba4125526e7",
"timestamp": "2017-03-31T16:10:56.921Z",
"identifier": "request-payout",
"stepResults": {
"type": "COMPOSED",
"data": {
"billDocument": {
"value": "57fa2f91d573fcb641352a24",
"type": "TEXT"
},
"usage": {
"value": "I need a reimbursement for this utility bill",
"type": "TEXT"
},
"payoutAmount": {
"type": "COMPOSED",
"data": {
"value": {
"value": 23.5,
"type": "DOUBLE"
},
"currency": {
"value": "EURO",
"type": "ENUMERATION"
}
}
}
}
}
}
```
---
`CONTACT_INFORMATION`: Updates the contact information provided to the user. Only the last message of this type is taken into account for display. This gives the user some additional points of contact (e.g. phone numbers) to contact regarding this conversation. The `identifier` is a technical ID unique at least for this conversation.
```
{
"type": "CONTACT_INFORMATION",
"contacts": [
{ "identifier": "54321", "name": "fileee GmbH", "phoneNumber": "+4925132368309", "description": "Your fileee support contact" }
]
}
```
---
`CHANGE_IDENTIFIERS`: Can be used when one or more of the identifiers used to identify requested / shared documents needs to be changed. Both document requests and shared documents will use the provided mapping. Please note that instead of using this, we would strongly advise to use non-changing identifiers throughout one conversation / business process!
```
{
"type": "CHANGE_IDENTIFIERS",
"changedIdentifiers": {
"OLD_IDENTIFIER1": "NEW_IDENTIFIER1",
"OLD_IDENTIFIER2": "NEW_IDENTIFIER2"
}
}
```

Tags: Conversations

Input Parameters

• conversationId - required - The ID of the conversation
  
• Authorization - required - OAuth access token
  

Get a specific message from a conversation.

Can be used if you just need one specific message and already know its ID from other means.

Tags: Conversations

Input Parameters

• conversationId - required - ID of an existing conversation
  
• messageId - required - ID of an existing message in that conversation
  
• Authorization - required - OAuth access token
  

Adds a module to an existing conversation.

Tags: Conversations

Input Parameters

• conversationId - required
• messageBundleId - required
• Authorization - required - OAuth access token
  

Produces sample of the request body for the call 'createFromTemplate'.

The sample request body will contain all variable keys with sample values from this module.If the module contains any tasks, there will also be a sample override for the task identifier, for its tags and for the result of each task.

Tags: Conversations

Input Parameters

• conversationId - required
• messageBundleId - required
• Authorization - required - OAuth access token
  

Add a participant to a conversation.

Can be used to add/invite another participant to a conversation. Please note that adding other users will require special permissions.

When adding EXTERNAL participants, the id needs to a valid email address. An invitation link to the conversation will be sent to that address. You can also set a {{phoneNumber}} for external participants, in which case the user is sent a password via SMS in addition to the link in the email, as a second security factor for accessing this conversation.

Tags: Conversations

Input Parameters

• conversationId - required - The ID of an existing conversation
  
• role - optional - The role of the new participant.
  Possible values: VIEWER, EDITOR, ADMIN.
• resendInvitationEmail - optional - If the invitation mail should be resend when adding this participant and if it already exists in the conversation.
  
• Authorization - required - OAuth access token
  

Remove a participant from a conversation.

Can be used to remove one or more participants from a conversation. Please note that you need the right permissions to perform this action.

Tags: Conversations

Input Parameters

• conversationId - required - The ID of an existing conversation
  
• Authorization - required - OAuth access token
  

Update task status.

Updates the status of a task in the conversation. If the task identifier was changed with a task overwrite the overwrite value has to be used.

Tags: Conversations

Input Parameters

• conversationId - required - The ID of an existing conversation
  
• taskIdentifier - required - The identifier of a task in given conversation
  
• Authorization - required - OAuth access token
  

Get the document state of a conversation.

Get the current state of requested and shared documents in a conversation. The requestedDocuments contain all the shared documents that could be matched to requests with their identifiers and information e.g. about the request state. The unassignedDocuments contain the document IDs of all documents shared in this conversation that were not assigned to one of the requests.

Tags: Conversations

Input Parameters

• conversationId - required - ID of an existing conversation
  
• taskIdentifier - required - The identifier of a task in given conversation
  
• mode - optional - Determines the content-disposition returned
  Possible values: download, print.
• Authorization - required - OAuth access token
  

Get all customer information of a participant in fileee.

It is only possible to get customer information for conversation participants of type USER.

Tags: Customers

Input Parameters

• participantId - required - The ID of a participant.
  
• Authorization - required - OAuth access token
  

Upload a new document

Uploading a document works through a multipart/form-data request with several parts. One of these parts contains the actual binary file to upload, the others can contain additional meta-data.

• You can upload one document consisting of one PDF (with one or more pages) or multiple page images (i.e. JPG, PNG or GIF) at a time.
  
  • If you are uploading multiple page images (e.g. scanned), please use the same file type for all images in one request.
    
  • The order of the parts in the request determines the page order of the document.
    
• After this API call returned, the document will be analyzed, thumbnails images will be generated and OCR will be done (all done asynchronously in the background). Check the status field of the document meta-data and wait until it is CLASSIFIED if you want to get the final version of the analyzed document.
  
• All binary file parts will be used as described above, regardless of their parameter name. Nevertheless, we recommend naming the parameter for a single uploaded document file and for multiple page images page0, page1 etc.
  
• The document parameter uses the general document JSON that is also used for the response. You can use this to provide e.g. an initial title or document type for the document or the ID of the fileeeBox to which this document should directly be added like this:
  

    {  <br/>
      "id": "5798835568c0e021ebc6eb3e",  <br/>
      "documentTypeId": "bill",  <br/>
      "documentInformation": {  <br/>
        "title": "My awesome document",  <br/>
        "fileeeBoxId": "5727934568c2f012eac3ca5f"  <br/>
      }  <br/>
    }  <br/>
```<br/>
  - The currently supported values for documentTypeId are: `bill`, `receipt`, `ticket`, `payslip`, `certificate`, `information`, `letter`, `other`, `contract`, `ad`, `bankstatement`, `identification`, `bankcard`, `membershipcard`<br/>
- The `meta` parameter may contain additional meta information for this upload that is not part of the actual document JSON.   You can use this to cause some specific actions to be done with the uploaded document. One example is directly sharing the  uploaded document in an existing conversation (optionally with an identifier described in the 'Add message' documentation) like this:  <br/>
```<br/>
    {  <br/>
      "conversationInformation": {  <br/>
        "conversationId": "5798835568c0e021ebc6eb3f",  <br/>
        "identifier": "PAY_STATEMENT1"  <br/>
      }  <br/>
    }  <br/>
```<br/>
- Please note that the 'Try it out'-feature of the docs website will not work for this API call because of limitations in   swagger. You have to use other tools like Postman or your own code to try it.<br/>

Tags: Documents

Input Parameters

• Authorization - required - OAuth access token
  

Get metadata for a document.

The meta-data contains information about the type of document and other attributes and properties either found through our automatic analysis or set by the user.

Tags: Documents

Input Parameters

• documentId - required - ID of the document
  
• Authorization - required - OAuth access token
  

Download a document as a PDF.

Always produces a PDF, regardless of the original document format.

Tags: Documents

Input Parameters

• documentId - required - ID of the document
  
• mode - optional - Determines the content-disposition returned
  Possible values: download, print.
• pages - optional - An optional comma-separated list of page IDs to include, defaults to all
  
• max-size - optional - An optional int value for maximum size of the pdf in bytes. The resolution of the single pages will be reduced if original is too big. Decreases download speed.
  
• Authorization - required - OAuth access token
  

createCompany

Tags: Enterprise Editor

diffImport

Tags: Enterprise Editor

exportConfig

Tags: Enterprise Editor

Input Parameters

• mode - optional - Determines the content disposition of the response
  Possible values: download, inline.

exportConfigPost

Tags: Enterprise Editor

Input Parameters

• mode - optional - Determines the content disposition of the response
  Possible values: download, inline.

getExportableEntities

Tags: Enterprise Editor

importConfig

Tags: Enterprise Editor

Connect a service to a customer with given identifier.

Can optionally be connected with verification, in this case the service will not appear in the users account until he or she verified him- or herself.

Tags: Enterprise

Input Parameters

• customerId - required - Identifier of an existing customer.
  
• Authorization - required - OAuth access token
  

Update a service for a customer with given identifier.

Verification can e.g be removed by updating the verification type to NONE.

Tags: Enterprise

Input Parameters

• customerId - required
• serviceInstanceId - required - Identifier of an existing service instance.
  
• Authorization - required - OAuth access token
  

Disconnect a service from a customer with given identifier.

If a disconnect template was configured when connecting this service, the user will receive a conversation instance from that template.

Tags: Enterprise

Input Parameters

• customerId - required - Identifier of an existing customer.
  
• serviceInstanceId - required - Identifier of an existing service instance.
  
• Authorization - required - OAuth access token
  

getBoxList

Tags: Fileeebox

createBox

Tags: Fileeebox

checkORCode

Tags: Fileeebox

Input Parameters

• qrCode - required

deleteBox

Tags: Fileeebox

Activate a fileeeBox for an user.

Tags: Fileeebox

Input Parameters

• qrCode - required
• Authorization - required - OAuth access token
  

Get the user information for a public accessible fileeeBox.

Tags: Fileeebox

Input Parameters

• qrCode - required
• Authorization - required - OAuth access token
  

getBox

Tags: Fileeebox

Input Parameters

• boxId - required

addDocumentToBox

Tags: Fileeebox

Input Parameters

• boxId - required
• documentId - required

removedDocumentFromBox

Tags: Fileeebox

Input Parameters

• boxId - required
• documentId - required

Lists all available modules for a company

Tags: Modules

Input Parameters

• Authorization - required - OAuth access token
  

Lists all available tasks from available modules of a company

Tags: Modules

Input Parameters

• Authorization - required - OAuth access token
  

Gets a sample ActionResultMessage for a RequestActionMessage.

Tags: Modules

Input Parameters

• moduleId - required - ID of an existing message bundle in that conversation template
  
• messageId - required - ID of an existing message in that message bundle
  
• mode - optional - Determines the content-disposition of the response
  Possible values: download, inline.
• Authorization - required - OAuth access token
  

Get all persons.

Either all or a limited amount of persons is returned.

Tags: Persons

Input Parameters

• limit - optional - An optional number of maximum elements that should be returned.
  
• offSet - optional - Starting index in the list of existing persons.
  
• modifiedAfter - optional - An optional date in milliseconds to get only persons which were modified after that date.
  
• Authorization - required - OAuth access token
  

Create a new person.

The person from the request body is created. Addresses, contact data, logo and branding information are stored, if existent.

Tags: Persons

Input Parameters

• Authorization - required - OAuth access token
  

Checks if the logo can be processed.

Tags: Persons

Get a person with specified identifier.

The returned person object includes existing contact data and addresses as well as branding information.

Tags: Persons

Input Parameters

• id - required - Identifier of an existing person.
  
• Authorization - required - OAuth access token
  

Update an existing person with specified identifier.

If the person with the given ID exists, will be updated with person values from request body.

Tags: Persons

Input Parameters

• id - required - Identifier of the person that should be updated.
  
• Authorization - required - OAuth access token
  

Delete the person with given identifier.

Tags: Persons

Input Parameters

• id - required - Identifier of the person that should be deleted.
  
• Authorization - required - OAuth access token
  

Get the logo of the person with specified identifier.

Returns the image data in format PNG.

Tags: Persons

Input Parameters

• id - required - ID of an existing Person.
  
• Authorization - required - OAuth access token
  

Create a new logo for a Person with given identifier.

Tags: Persons

Input Parameters

• id - required - ID of an existing Person.
  
• Authorization - required - OAuth access token
  

Delete the logo of the person with specified identifier.

Tags: Persons

Input Parameters

• id - required - ID of an existing Person.
  
• Authorization - required - OAuth access token
  

Create a PostBox for a user.

Creates a PostBox into which documents can be uploaded for a user. The user does not have to have an existing fileee account.

Tags: PostBox

Input Parameters

• testPhone - optional
• Authorization - required - OAuth access token
  

Activates a Postbox Request

When a user requests a postbox from fileee. This api can be used to approve the request

Tags: PostBox

Input Parameters

• requestId - required
• Authorization - required - OAuth access token
  

Activates a Postbox Request

When a user requests a postbox from fileee. This api can be used to approve the request

Tags: PostBox

Input Parameters

• requestId - required
• Authorization - required - OAuth access token
  

Get the status of a PostBox.

Tags: PostBox

Input Parameters

• customerId - required
• Authorization - required - OAuth access token
  

Send a document to a user

Allows companies to send documents via fileee to the postbox of a user. This virtual postbox can take several different forms, e.g. either one folder or shared space that receives all the documents from one company for a user or several individual conversations for specific documents. The user does not have to have an existing fileee account, they will be notified via email when you first want to share a document with them.

• Uploading a document works through a multipart/form-data request with several parts. One of these parts contains the actual binary file to upload, another contains required information about the target user, the document and how it should be presented to the user.
  
• The file form-part should contain the document file to send to the user. We strongly recommend PDF as a format, although some image types are also supported.
  
• The request form-part must contain all the required information to deliver the document to a target user and can contain additionalmeta-data properties of the document, like a title or issue date that will be shown to the user. The content-type must be application/json.
  
• Please note: The 'Try it out'-feature of the docs website will not work for this API call because of limitations in swagger. You have to use other tools like Postman or your own code to try it.
  

---
The `request` form-part describes the details of the request:

- The `externalId` can optionally be set to an arbitrary value that helps you identify the request in your own systems, it is not used by fileee.
- The `recipient` describes which user should receive this document. This field is required.
- The `configuration` describes how the document should be delivered and presented to the user. This field is required.
- The `document` describes the document-related meta-data, most of which is directly shown to the user in fileee. This field (but not all parts of it) is required.

A very minimal request could look like this:

```
{
"recipient": {
"email": "[email protected]",
},
"configuration": {
"type": "TEMPLATE",
"templateName": "our-template"
},
"document": {
"title": "Our awesome document"
}
}
```

---
The `recipient` field in the request identifies the target user that should receive the document. The minimum we need here is an email address, but a name should be given if possible to personalize the conversation. You can optionally also specify a phone number which can be used when sending out security codes to access protected content.

```
{
"email": "[email protected]",
"name": "Some User",
"phoneNumber": "+49123456789",
}
```

---
The `configuration` field in the request controls how the new document is delivered and presented to the user. The most important parameter is the **type**, which also controls which other fields in the configuration need to be set. For the `TEMPLATE` type, you just need to specify the name of a template which in turn defines the attributes, messages etc. of the conversation or shared space for the document:

```
{
"type": "TEMPLATE",
"templateName": "awesome-invoice-template23"
}
```
For the `CUSTOM` type, you can specify all the details of the created conversation yourself:

```
{
"type": "CUSTOM",
"conversation": {
"kind": "new_loan_application",
"title": "Your new loan application was received",
"companyId": "5798835568c0e021ebc6eb44",
// ...
}
}
```
You should always only set the parameters relevant for the specific type, so e.g. only set the `templateName` if the `type` is `TEMPLATE` and only set the `conversation` when the `type` is `CUSTOM`.

---
The `document` field in the request should contain attributes of the document that is created. This controls the title of the document that is shown to the user in fileee, but can also contain other attributes like an issue date or the sender of the document:

```
{
"title": "Your invoice for August 2017",
"issueDate": "2017-08-23",
"sender": {
"contactId": "50ac222b0cf2f924c9ccb919"
},
"receiver": {
"name": "Awesome Fruit GmbH",
"street": "Superstr. 23",
"postalCode": "48143",
"city": "Munster"
}
}
```
A contact (sender or receiver) should _either_ contain a `contactId` _or_ the postal address fields, never both. If the receiver is not specified, we assume the document to be addressed to the fileee user in question.

Tags: PostBox

Input Parameters

• Authorization - required - OAuth access token
  

Activates the postbox for a user

This can be used to activate a postbox for a user.
One reason can be that he handed in the required information personally so that he is no longer required to finish the task.
Limitations here are:

• The invited user must be registered.
  
• Documents send to the postbox before the activation are deleted and WON'T be available to the user
  

Tags: PostBox

Input Parameters

• customerId - required
• Authorization - required - OAuth access token
  

Connect ThinkOwl Desk

Connect ThinkOwl Desk with fileee account by providing credentials for accessing the desk.

Tags: ThinkOwl

Input Parameters

• Authorization - required - OAuth access token
  

Disconnect ThinkOwl Desk from fileee

Disconnect ThinkOwl Desk from fileee account by providing credentials for accessing desk.

Tags: ThinkOwl

Input Parameters

• Authorization - required - OAuth access token
  

userExists

Tags: ThinkOwl

Input Parameters

• email - optional

Deprecated: Get own user-information

(Deprecated, see /authorization/user-info instead) Can be used to get own participantId

Tags: Users

Input Parameters

• Authorization - required - OAuth access token
  

resendActivationMail

Tags: Users

resendConversationSms

Tags: Users

Input Parameters

• externalToken - required

License

flowground :- Telekom iPaaS / fileee-api-connector
Copyright © 2019, Deutsche Telekom AG
contact: [email protected]

All files of this connector are licensed under the Apache 2.0 License. For details see the file LICENSE on the toplevel directory.