Condividi tramite

Almanac (Independent Publisher) (Preview)

  • Reference

Almanac is building collaborative infrastructure to serve human creativity. Using the fastest wiki and workflow tool, consolidate your docs in a beautiful, organized single source of truth.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://almanac.io/
Privacy policy https://almanac.io/privacy-policy
Categories Collaboration;Content and Files

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Workspace ID string The workspace ID for this API. True
Access Token (in the form 'Bearer yourAccessToken') securestring The Access Token (in the form 'Bearer yourAccessToken') for this API. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add document access

Add access to document.
Add document property

Add a custom property to a document.
Create document property

Create a document property on workspace level.
Create folder

Create a folder.
Create handbook item

Add an item to handbook.
Delete document custom property

Delete a document custom property on workspace level.
Delete document property

Remove a custom property from a document.
Delete workbook item

Delete item from handbook.
Get document accesses

List document accesses.
Get document info

Retrieve meta information of a document.
Get document properties

List document custom properties on workspace level.
Get document properties

List document custom properties on document level.
Get documents

Retrieve meta information of all docs in workspace.
Get folder info

Retrieve a list of folder meta information.
Get folders

Retrieve a list of all folders.
Get groups

Retrieve user groups.
Get handbook items

Retrieve a list of handbook items.
Get handbooks

Retrieve a list of workspace handbooks.
Get import

Retrieve information about an existing import.
Get users

Retrieve a list of users.
Get users in group

Retrieve all users of a user group.
Import document

Import a document from an external source.
Move files

Move files (docs and/or folders) to a specific folder (in same or different workspace).
Remove document access

Remove access from document.
Replace document access

Replace access to a document.
Replace document info

Update meta information of a doc.
Replace folder info

Replace a folder meta information.
Update document access

Update access to a document.
Update document info

Update meta information of a document.
Update folder info

Update a folder meta information.

Add document access

Operation ID:
PostDocsDocIdAccesses

Add access to document.

Parameters

Name Key Required Type Description
Permission
 access[permission] True string

The permission.
Accessor Type
 access[accessor_type] True string

The accessor type.
Accessor ID
 access[accessor_id] True integer

The accessor identifier.
Doc ID
 doc_id True integer

The document identifier.

Returns

Doc Access Model
DocAccess

Add document property

Operation ID:
PostDocsDocIdProperties

Add a custom property to a document.

Parameters

Name Key Required Type Description
Property ID
 property_id True integer

The property identifier.
Value
 value string

Type of value param depends on property type: 'text', 'date', 'number', 'link' => String 'single_select' => { 'selected_item_id': Integer }, the PropertyValue#ID 'multi_select' => { 'selected_item_ids': Array[Integer] }, the selected PropertyValue#IDs 'checkbox' => { 'checked': Boolean } 'document' => { 'doc_id': Integer }, the Document#ID 'person' => { 'user_ids': Array[Integer] }, the User#IDs.
Doc ID
 doc_id True integer

The document identifier.

Returns

Doc Property Model
DocProperty

Create document property

Operation ID:
PostProperties

Create a document property on workspace level.

Parameters

Name Key Required Type Description
Property Name
 property[name] True string

The property name, which must be unique per workspace.
Property Type
 property[type] True string

The property type.
Default for Articles
 property[default_for_articles] boolean

Automatically add this property to new articles? Default is false.
Data Format
 property[meta][date_format] string

Optional for properties of type date.
Number Format
 property[meta][number_format] string

Optional for properties of type number.
Allow Mentioning Multiple People
 property[meta][allow_mentioning_multiple_people] boolean

Optional for properties of type person.
Notify Person
 property[meta][notify_person] boolean

Optional for properties of type person.
Property Values
 property[property_values][][value] True array

The property values.
Color
 property[property_values][][meta][color] array

The color.

Returns

Property Model
Property

Create folder

Operation ID:
PostFolders

Create a folder.

Parameters

Name Key Required Type Description
Folder Title
 folder[title] True string

The folder title.
Parent Folder ID
 folder[parent_folder_id] integer

ID of parent folder. Will be created at workspace root if not provided.

Returns

Folder Model
Folder

Create handbook item

Operation ID:
PostHandbooksHandbookIdItems

Add an item to handbook.

Parameters

Name Key Required Type Description
Item Type
 handbook_item[type] True string

The handbook item type.
Item Position
 handbook_item[position] integer

Appends item as last position if not provided.
Parent Item ID
 handbook_item[parent_item_id] integer

Parent Item ID for nesting purposes.
Doc ID
 handbook_item[doc_id] True integer

Only required for doc items.
Item Title
 handbook_item[title] True string

Only required for section & link items.
Item URL
 handbook_item[url] True string

Only required for link items.
Handbook ID
 handbook_id True integer

The handbook identifier.

Returns

HandbookItem Model
HandbookItem

Delete document custom property

Operation ID:
DeletePropertiesId

Delete a document custom property on workspace level.

Parameters

Name Key Required Type Description
ID
 id True integer

The identifier.

Delete document property

Operation ID:
DeleteDocsDocIdPropertiesId

Remove a custom property from a document.

Parameters

Name Key Required Type Description
Doc ID
 doc_id True integer

The document identifier.
ID
 id True integer

The identifier.

Delete workbook item

Operation ID:
DeleteHandbooksHandbookIdItemsId

Delete item from handbook.

Parameters

Name Key Required Type Description
ID
 id True string

The identifier.
Handbook ID
 handbook_id True integer

The handbook identifier.

Get document accesses

Operation ID:
GetDocsDocIdAccesses

List document accesses.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.
Doc ID
 doc_id True integer

The document identifier.

Returns

response
array of DocAccess

Get document info

Operation ID:
GetDocsId

Retrieve meta information of a document.

Parameters

Name Key Required Type Description
ID
 id True integer

The identifier.

Returns

Doc Model
Doc

Get document properties

Operation ID:
GetProperties

List document custom properties on workspace level.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.

Returns

response
array of Property

Get document properties

Operation ID:
GetDocsDocIdProperties

List document custom properties on document level.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.
Doc ID
 doc_id True integer

The document identifier.

Returns

response
array of DocProperty

Get documents

Operation ID:
GetDocs

Retrieve meta information of all docs in workspace.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.
Folder ID
 folder_id string

Optional filter: only show docs that are at the root of this folder.

Returns

response
array of Doc

Get folder info

Operation ID:
GetFoldersId

Retrieve a list of folder meta information.

Parameters

Name Key Required Type Description
ID
 id True string

The identifier.

Returns

Folder Model
Folder

Get folders

Operation ID:
GetFolders

Retrieve a list of all folders.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.
Parent Folder ID
 parent_folder_id string

Optional filter: only show folders with this parent folder ID.

Returns

response
array of Folder

Get groups

Operation ID:
GetGroups

Retrieve user groups.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.

Returns

response
array of Group

Get handbook items

Operation ID:
GetHandbooksHandbookIdItems

Retrieve a list of handbook items.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.
Handbook ID
 handbook_id True integer

The handbook identifier.

Returns

response
array of HandbookItem

Get handbooks

Operation ID:
GetHandbooks

Retrieve a list of workspace handbooks.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.

Returns

response
array of Handbook

Get import

Operation ID:
GetImportsId

Retrieve information about an existing import.

Parameters

Name Key Required Type Description
ID
 id True integer

The identifier.

Returns

Import Model
Import

Get users

Operation ID:
GetUsers

Retrieve a list of users.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.

Returns

response
array of User

Get users in group

Operation ID:
GetGroupsGroupIdUsers

Retrieve all users of a user group.

Parameters

Name Key Required Type Description
Page
 page integer

Page offset to fetch.
Items
 items integer

Number of items to return per page.
Group ID
 group_id True integer

The group identifier.

Returns

response
array of User

Import document

Operation ID:
PostImports

Import a document from an external source.

Parameters

Name Key Required Type Description
File
 import[file] True file

The file to import.
Source
 import[source] True string

The source of the file.

Returns

Import Model
Import

Move files

Operation ID:
PostFilesMove

Move files (docs and/or folders) to a specific folder (in same or different workspace).

Parameters

Name Key Required Type Description
Folder IDs
 folder_ids[] array

The folder identifiers.
Doc IDs
 doc_ids[] array

The doc identifiers.
Destination Folder ID
 destination_folder_id integer

The destination folder identifier.
Destination Workspace ID
 destination_workspace_id integer

The destination workspace identifier.

Remove document access

Operation ID:
DeleteDocsDocIdAccessesId

Remove access from document.

Parameters

Name Key Required Type Description
Doc ID
 doc_id True integer

The document identifier.
ID
 id True integer

The identifier.

Replace document access

Operation ID:
PutDocsDocIdAccessesId

Replace access to a document.

Parameters

Name Key Required Type Description
Permission
 access[permission] True string

The permission.
Doc ID
 doc_id True integer

The document identifier.
ID
 id True integer

The identifier.

Returns

Doc Access Model
DocAccess

Replace document info

Operation ID:
PutDocsId

Update meta information of a doc.

Parameters

Name Key Required Type Description
Title
 doc[title] True string

The title of the document.
ID
 id True integer

The identifier.

Returns

Doc Model
Doc

Replace folder info

Operation ID:
PutFoldersId

Replace a folder meta information.

Parameters

Name Key Required Type Description
Folder Title
 folder[title] True string

The folder title.
ID
 id True integer

The identifier.

Returns

Folder Model
Folder

Update document access

Operation ID:
PatchDocsDocIdAccessesId

Update access to a document.

Parameters

Name Key Required Type Description
Permission
 access[permission] True string

The permission.
Doc ID
 doc_id True integer

The document identifier.
ID
 id True integer

The identifier.

Returns

Doc Access Model
DocAccess

Update document info

Operation ID:
PatchDocsId

Update meta information of a document.

Parameters

Name Key Required Type Description
Title
 doc[title] True string

The title of the document.
ID
 id True integer

The identifier.

Returns

Doc Model
Doc

Update folder info

Operation ID:
PatchFoldersId

Update a folder meta information.

Parameters

Name Key Required Type Description
Folder Title
 folder[title] True string

The folder title.
ID
 id True integer

The identifier.

Returns

Folder Model
Folder

Definitions

User

Name Path Type Description
ID
 id integer

The identifier
First Name
 first_name string

The first name.
Last Name
 last_name string

The last name.

Group

Name Path Type Description
ID
 id integer

The identifier
Name
 name string

The name.
Description
 description string

The description.
Accessibility
 accessibility string

The accessibility.

Property

Name Path Type Description
ID
 id integer

The identifier
Name
 name string

The name.
Type
 type string

The type.
Default for Articles
 default_for_articles boolean

Whether to default for articles.
meta
 meta PropertyMeta
property_values
 property_values array of PropertyValue

PropertyMeta

Name Path Type Description
Number Format
 number_format string

Only returned & relevant for properties of type number.
Date Format
 date_format string

Only returned & relevant for properties of type date
Allow Mentioning Multiple People
 allow_mentioning_multiple_people boolean

Only returned & relevant for properties of type person.
Notify Person
 notify_person boolean

Only returned & relevant for properties of type person.

PropertyValue

Name Path Type Description
ID
 id integer

The identifier
Property ID
 property_id integer

The property identifier.
Value
 value string

The value.
meta
 meta PropertyValueMeta

PropertyValueMeta

Name Path Type Description
Color
 color string

Only returned & relevant for properties of type single_select and multi_select.

HandbookItem

Name Path Type Description
ID
 id integer

The identifier
Handbook ID
 handbook_id integer

The handbook identifier.
Type
 type string

The type.
Position
 position integer

The position.
Title
 title string

Only relevant for section & link items.
URL
 url string

Only relevant for link items.
Parent Item ID
 parent_item_id integer

Non-null if item is nested.
Doc ID
 doc_id integer

Only relevant for doc items.

Handbook

Name Path Type Description
ID
 id integer

The identifier
Name
 name string

The name.

Folder

Name Path Type Description
ID
 id integer

The identifier
Title
 title string

The title.
Workspace ID
 workspace_id integer

The workspace identifier.
Parent Folder ID
 parent_folder_id integer

The parent folder identifier.

DocAccess

Name Path Type Description
ID
 id integer

The identifier
Doc ID
 doc_id integer

The document identifier.
Permission
 permission string

The permission.
Accessor Type
 accessor_type string

The accessor type.
Accessor ID
 accessor_id integer

The accessor identifier.
Inherited
 inherited boolean

Whether inherited.

DocProperty

Name Path Type Description
ID
 id integer

The identifier
Property Model
 property Property
Value
 value string

Type of value depends on property type: 'text', 'date', 'number', 'link' => String 'single_select' => { 'selected_item_id': Integer }, the PropertyValue#ID 'multi_select' => { 'selected_item_ids': Array[Integer] }, the selected PropertyValue#IDs 'checkbox' => { 'checked': Boolean } 'document' => { 'doc_id': Integer }, the Document#ID 'person' => { 'user_ids': Array[Integer] }, the User#IDs.

Doc

Name Path Type Description
ID
 id integer

The identifier
Title
 title string

The title.
Workspace ID
 workspace_id integer

The workspace identifier.
Folder ID
 folder_id integer

The folder identifier.
Owner ID
 owner_id integer

User ID of owner of the doc.
Created At
 created_at string

ISO8601 formatted datetime.
Updated At
 updated_at string

ISO8601 formatted datetime.

Import

Name Path Type Description
ID
 id integer

The identifier
status
 status string
Doc Model
 doc Doc