flowground für Geschäftskunden

Technische Spezifikationen

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

private_account

Account information for token/personal token

OnInit
./lib/actions/private_account.js
OnStartup
-
OnClose
-

Attributes

-

private_articles_list

Get Own Articles

OnInit
./lib/actions/private_articles_list.js
OnStartup
-
OnClose
-

Attributes

-

private_article_create

Create a new Article by sending article information

OnInit
./lib/actions/private_article_create.js
OnStartup
-
OnClose
-

Attributes

-

private_articles_search

Returns a list of private articles filtered by the search parameters

OnInit
./lib/actions/private_articles_search.js
OnStartup
-
OnClose
-

Attributes

-

private_article_delete

Delete an article

OnInit
./lib/actions/private_article_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_details

View a private article

OnInit
./lib/actions/private_article_details.js
OnStartup
-
OnClose
-

Attributes

-

private_article_update

Updating an article by passing body parameters

OnInit
./lib/actions/private_article_update.js
OnStartup
-
OnClose
-

Attributes

-

private_article_authors_list

List article authors

OnInit
./lib/actions/private_article_authors_list.js
OnStartup
-
OnClose
-

Attributes

-

private_article_authors_add

Associate new authors with the article. This will add new authors to the list of already associated authors

OnInit
./lib/actions/private_article_authors_add.js
OnStartup
-
OnClose
-

Attributes

-

private_article_authors_replace

Associate new authors with the article. This will remove all already associated authors and add these new ones

OnInit
./lib/actions/private_article_authors_replace.js
OnStartup
-
OnClose
-

Attributes

-

private_article_author_delete

De-associate author from article

OnInit
./lib/actions/private_article_author_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_categories_list

List article categories

OnInit
./lib/actions/private_article_categories_list.js
OnStartup
-
OnClose
-

Attributes

-

private_article_categories_add

Associate new categories with the article. This will add new categories to the list of already associated categories

OnInit
./lib/actions/private_article_categories_add.js
OnStartup
-
OnClose
-

Attributes

-

private_article_categories_replace

Associate new categories with the article. This will remove all already associated categories and add these new ones

OnInit
./lib/actions/private_article_categories_replace.js
OnStartup
-
OnClose
-

Attributes

-

private_article_category_delete

De-associate category from article

OnInit
./lib/actions/private_article_category_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_confidentiality_delete

Delete confidentiality settings

OnInit
./lib/actions/private_article_confidentiality_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_confidentiality_details

View confidentiality settings

OnInit
./lib/actions/private_article_confidentiality_details.js
OnStartup
-
OnClose
-

Attributes

-

private_article_confidentiality_update

Update confidentiality settings

OnInit
./lib/actions/private_article_confidentiality_update.js
OnStartup
-
OnClose
-

Attributes

-

private_article_embargo_delete

Will lift the embargo for the specified article

OnInit
./lib/actions/private_article_embargo_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_embargo_details

View a private article embargo details

OnInit
./lib/actions/private_article_embargo_details.js
OnStartup
-
OnClose
-

Attributes

-

private_article_embargo_update

Note: setting an article under whole embargo does not imply that the article will be published when the embargo will expire. You must explicitly call the publish endpoint to enable this functionality.

OnInit
./lib/actions/private_article_embargo_update.js
OnStartup
-
OnClose
-

Attributes

-

private_article_files_list

List private files

OnInit
./lib/actions/private_article_files_list.js
OnStartup
-
OnClose
-

Attributes

-

private_article_upload_initiate

Initiate new file upload within the article. Either use link to provide only an existing file that will not be uploaded on figshare or use the other 3 parameters(md5, name, size)

OnInit
./lib/actions/private_article_upload_initiate.js
OnStartup
-
OnClose
-

Attributes

-

private_article_file_delete

Complete file upload

OnInit
./lib/actions/private_article_file_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_file

View details of file for specified article

OnInit
./lib/actions/private_article_file.js
OnStartup
-
OnClose
-

Attributes

-

private_article_upload_complete

Complete file upload

OnInit
./lib/actions/private_article_upload_complete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_private_link

List private links

OnInit
./lib/actions/private_article_private_link.js
OnStartup
-
OnClose
-

Attributes

-

private_article_private_link_create

Create new private link for this article

OnInit
./lib/actions/private_article_private_link_create.js
OnStartup
-
OnClose
-

Attributes

-

private_article_private_link_delete

Disable/delete private link for this article

OnInit
./lib/actions/private_article_private_link_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_article_private_link_update

Update existing private link for this article

OnInit
./lib/actions/private_article_private_link_update.js
OnStartup
-
OnClose
-

Attributes

-

private_article_publish

- If the whole article is under embargo, it will not be published immediatly, but when the embargo expires or is lifted. - When an article is published, a new public version will be generated. Any further updates to the article will affect the private article data. In order to make these changes publicly visible, an explicit publish operation is needed.

OnInit
./lib/actions/private_article_publish.js
OnStartup
-
OnClose
-

Attributes

-

private_article_reserve_doi

Reserve DOI for article

OnInit
./lib/actions/private_article_reserve_doi.js
OnStartup
-
OnClose
-

Attributes

-

private_authors_search

Search for authors

OnInit
./lib/actions/private_authors_search.js
OnStartup
-
OnClose
-

Attributes

-

private_author_details

View author details

OnInit
./lib/actions/private_author_details.js
OnStartup
-
OnClose
-

Attributes

-

private_categories_list

List institution categories (including parent Categories)

OnInit
./lib/actions/private_categories_list.js
OnStartup
-
OnClose
-

Attributes

-

private_collections_list

List private collections

OnInit
./lib/actions/private_collections_list.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_create

Create a new Collection by sending collection information

OnInit
./lib/actions/private_collection_create.js
OnStartup
-
OnClose
-

Attributes

-

private_collections_search

Returns a list of private Collections

OnInit
./lib/actions/private_collections_search.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_delete

Delete n collection

OnInit
./lib/actions/private_collection_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_details

View a collection

OnInit
./lib/actions/private_collection_details.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_update

Update collection details

OnInit
./lib/actions/private_collection_update.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_articles_list

List collection articles

OnInit
./lib/actions/private_collection_articles_list.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_articles_add

Associate new articles with the collection. This will add new articles to the list of already associated articles

OnInit
./lib/actions/private_collection_articles_add.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_articles_replace

Associate new articles with the collection. This will remove all already associated articles and add these new ones

OnInit
./lib/actions/private_collection_articles_replace.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_article_delete

De-associate article from collection

OnInit
./lib/actions/private_collection_article_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_authors_list

List collection authors

OnInit
./lib/actions/private_collection_authors_list.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_authors_add

Associate new authors with the collection. This will add new authors to the list of already associated authors

OnInit
./lib/actions/private_collection_authors_add.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_authors_replace

Associate new authors with the collection. This will remove all already associated authors and add these new ones

OnInit
./lib/actions/private_collection_authors_replace.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_author_delete

Delete collection author

OnInit
./lib/actions/private_collection_author_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_categories_list

List collection categories

OnInit
./lib/actions/private_collection_categories_list.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_categories_add

Associate new categories with the collection. This will add new categories to the list of already associated categories

OnInit
./lib/actions/private_collection_categories_add.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_categories_replace

Associate new categories with the collection. This will remove all already associated categories and add these new ones

OnInit
./lib/actions/private_collection_categories_replace.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_category_delete

De-associate category from collection

OnInit
./lib/actions/private_collection_category_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_private_links_list

List article private links

OnInit
./lib/actions/private_collection_private_links_list.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_private_link_create

Create new private link

OnInit
./lib/actions/private_collection_private_link_create.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_private_link_delete

Disable/delete private link for this collection

OnInit
./lib/actions/private_collection_private_link_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_private_link_update

Update existing private link for this collection

OnInit
./lib/actions/private_collection_private_link_update.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_publish

When a collection is published, a new public version will be generated. Any further updates to the collection will affect the private collection data. In order to make these changes publicly visible, an explicit publish operation is needed.

OnInit
./lib/actions/private_collection_publish.js
OnStartup
-
OnClose
-

Attributes

-

private_collection_reserve_doi

Reserve DOI for collection

OnInit
./lib/actions/private_collection_reserve_doi.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_details

Account institution details

OnInit
./lib/actions/private_institution_details.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_accounts_list

Returns the accounts for which the account has administrative privileges (assigned and inherited).

OnInit
./lib/actions/private_institution_accounts_list.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_accounts_create

Create a new Account by sending account information

OnInit
./lib/actions/private_institution_accounts_create.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_accounts_search

Returns the accounts for which the account has administrative privileges (assigned and inherited).

OnInit
./lib/actions/private_institution_accounts_search.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_accounts_update

Update Institution Account

OnInit
./lib/actions/private_institution_accounts_update.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_articles

Get Articles from own institution. User must be administrator of the institution

OnInit
./lib/actions/private_institution_articles.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_groups_list

Returns the groups for which the account has administrative privileges (assigned and inherited).

OnInit
./lib/actions/private_institution_groups_list.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_roles_list

Returns the roles available for groups and the institution group.

OnInit
./lib/actions/private_institution_roles_list.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_account_group_roles

List Institution Account Group Roles

OnInit
./lib/actions/private_institution_account_group_roles.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_account_group_roles_create

Add Institution Account Group Roles

OnInit
./lib/actions/private_institution_account_group_roles_create.js
OnStartup
-
OnClose
-

Attributes

-

private_institution_account_group_role_delete

Delete Institution Account Group Role

OnInit
./lib/actions/private_institution_account_group_role_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_account_institution_user

Retrieve institution user information using the account_id

OnInit
./lib/actions/private_account_institution_user.js
OnStartup
-
OnClose
-

Attributes

-

private_licenses_list

This is a private endpoint that requires OAuth. It will return a list with figshare public licenses AND licenses defined for account's institution.

OnInit
./lib/actions/private_licenses_list.js
OnStartup
-
OnClose
-

Attributes

-

private_projects_list

List private projects

OnInit
./lib/actions/private_projects_list.js
OnStartup
-
OnClose
-

Attributes

-

private_project_create

Create a new project

OnInit
./lib/actions/private_project_create.js
OnStartup
-
OnClose
-

Attributes

-

private_projects_search

Search inside the private projects

OnInit
./lib/actions/private_projects_search.js
OnStartup
-
OnClose
-

Attributes

-

private_project_delete

A project can be deleted only if: - it is not public - it does not have public articles. When an individual project is deleted, all the articles are moved to my data of each owner. When a group project is deleted, all the articles and files are deleted as well. Only project owner, group admin and above can delete a project.

OnInit
./lib/actions/private_project_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_project_details

View a private project

OnInit
./lib/actions/private_project_details.js
OnStartup
-
OnClose
-

Attributes

-

private_project_update

Updating an project by passing body parameters

OnInit
./lib/actions/private_project_update.js
OnStartup
-
OnClose
-

Attributes

-

private_project_articles_list

List project articles

OnInit
./lib/actions/private_project_articles_list.js
OnStartup
-
OnClose
-

Attributes

-

private_project_articles_create

Create a new Article and associate it with this project

OnInit
./lib/actions/private_project_articles_create.js
OnStartup
-
OnClose
-

Attributes

-

private_project_article_delete

Delete project article

OnInit
./lib/actions/private_project_article_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_project_article_details

Project article details

OnInit
./lib/actions/private_project_article_details.js
OnStartup
-
OnClose
-

Attributes

-

private_project_article_files

List article files

OnInit
./lib/actions/private_project_article_files.js
OnStartup
-
OnClose
-

Attributes

-

private_project_article_file

Project article file details

OnInit
./lib/actions/private_project_article_file.js
OnStartup
-
OnClose
-

Attributes

-

private_project_collaborators_list

List Project collaborators and invited users

OnInit
./lib/actions/private_project_collaborators_list.js
OnStartup
-
OnClose
-

Attributes

-

private_project_collaborators_invite

Invite users to collaborate on project or view the project

OnInit
./lib/actions/private_project_collaborators_invite.js
OnStartup
-
OnClose
-

Attributes

-

private_project_collaborator__Delete

Remove project collaborator

OnInit
./lib/actions/private_project_collaborator__Delete.js
OnStartup
-
OnClose
-

Attributes

-

private_project_leave

Please note: project's owner cannot leave the project.

OnInit
./lib/actions/private_project_leave.js
OnStartup
-
OnClose
-

Attributes

-

private_project_notes_list

List project notes

OnInit
./lib/actions/private_project_notes_list.js
OnStartup
-
OnClose
-

Attributes

-

private_project_notes_create

Create a new project note

OnInit
./lib/actions/private_project_notes_create.js
OnStartup
-
OnClose
-

Attributes

-

private_project_note_delete

OnInit
./lib/actions/private_project_note_delete.js
OnStartup
-
OnClose
-

Attributes

-

private_project_note

OnInit
./lib/actions/private_project_note.js
OnStartup
-
OnClose
-

Attributes

-

private_project_note_update

OnInit
./lib/actions/private_project_note_update.js
OnStartup
-
OnClose
-

Attributes

-

private_project_publish

Publish a project. Possible after all items inside it are public

OnInit
./lib/actions/private_project_publish.js
OnStartup
-
OnClose
-

Attributes

-

articles_list

Returns a list of public articles

OnInit
./lib/actions/articles_list.js
OnStartup
-
OnClose
-

Attributes

-

articles_search

Returns a list of public articles, filtered by the search parameters

OnInit
./lib/actions/articles_search.js
OnStartup
-
OnClose
-

Attributes

-

article_details

View an article

OnInit
./lib/actions/article_details.js
OnStartup
-
OnClose
-

Attributes

-

article_files

Files list for article

OnInit
./lib/actions/article_files.js
OnStartup
-
OnClose
-

Attributes

-

article_file_details

File by id

OnInit
./lib/actions/article_file_details.js
OnStartup
-
OnClose
-

Attributes

-

article_versions

List public article versions

OnInit
./lib/actions/article_versions.js
OnStartup
-
OnClose
-

Attributes

-

article_version_details

Article with specified version

OnInit
./lib/actions/article_version_details.js
OnStartup
-
OnClose
-

Attributes

-

article_version_confidentiality

Confidentiality for article version

OnInit
./lib/actions/article_version_confidentiality.js
OnStartup
-
OnClose
-

Attributes

-

article_version_embargo

Embargo for article version

OnInit
./lib/actions/article_version_embargo.js
OnStartup
-
OnClose
-

Attributes

-

categories_list

Returns a list of public categories

OnInit
./lib/actions/categories_list.js
OnStartup
-
OnClose
-

Attributes

-

collections_list

Returns a list of public collections

OnInit
./lib/actions/collections_list.js
OnStartup
-
OnClose
-

Attributes

-

collections_search

Returns a list of public collections

OnInit
./lib/actions/collections_search.js
OnStartup
-
OnClose
-

Attributes

-

collection_details

View a collection

OnInit
./lib/actions/collection_details.js
OnStartup
-
OnClose
-

Attributes

-

collection_articles

Returns a list of public collection articles

OnInit
./lib/actions/collection_articles.js
OnStartup
-
OnClose
-

Attributes

-

collection_versions

Returns a list of public collection Versions

OnInit
./lib/actions/collection_versions.js
OnStartup
-
OnClose
-

Attributes

-

collection_version_details

View details for a certain version of a collection

OnInit
./lib/actions/collection_version_details.js
OnStartup
-
OnClose
-

Attributes

-

file_download

Starts the download of a file

OnInit
./lib/actions/file_download.js
OnStartup
-
OnClose
-

Attributes

-

institution_hrfeed_upload

More info in the HR Feed section

OnInit
./lib/actions/institution_hrfeed_upload.js
OnStartup
-
OnClose
-

Attributes

-

institution_articles

Returns a list of articles belonging to the institution

OnInit
./lib/actions/institution_articles.js
OnStartup
-
OnClose
-

Attributes

-

licenses_list

Returns a list of public licenses

OnInit
./lib/actions/licenses_list.js
OnStartup
-
OnClose
-

Attributes

-

projects_list

Returns a list of public projects

OnInit
./lib/actions/projects_list.js
OnStartup
-
OnClose
-

Attributes

-

projects_search

Returns a list of public articles

OnInit
./lib/actions/projects_search.js
OnStartup
-
OnClose
-

Attributes

-

project_details

View a project

OnInit
./lib/actions/project_details.js
OnStartup
-
OnClose
-

Attributes

-

project_articles

List articles in project

OnInit
./lib/actions/project_articles.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-