Objective Connect (Preview)

Objective Connect is the trusted file sharing platform which allows organisation to share sensitive documents with external parties. Users can create private workspaces and invite participants in the Cloud in a matter of seconds. The collaboration, reporting, security and compliance features allow governments and regulated industries the ability to work externally while having peace of mind.

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)
Connector Metadata
Publisher Objective Corporation

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
Password securestring The password for this api True
Server region. (UK - secure.objectiveconnect.co.uk, ANZ - secure.objectiveconnect.com) string Specify Objective Connect server. True
Username securestring The username for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add or update participant

Invite new participant or edit assigned roles

Create document

If Request is application:hal+json, it creates metadata only. If Request is multipart:form-data, it creates document with content in one single call.

Create workspace

Create workspace

Delete participant

Removes participant from the workspace

Get document content

Returns the contents of a document

Get document version

Get an asset version

Get document version content

Returns the contents of a Document version

Get participants

Get workspace participants

Get user

Get users

Get workspace

Get workspace by ID

List document versions

Get a list of Asset versions

List shared documents

Get a list of Assets by Workspace UUID

List workspaces

Get a list of Shares which the requesting user has privilege to see

Upload document content

Upload content for a Document

Add or update participant

Invite new participant or edit assigned roles

Parameters

Name Key Required Type Description
Email
emails string

Invite participant or edit roles

Message
message string

Invitation message

Roles assigned to participant
roles string

Add privilege

Workspace UUID
shareUuid True string

UUID

Participant visibility
type string

STANDARD - visible to other participants. BCC - participant will be hidden from others

Returns

Name Path Type Description
array of object
accepted
accepted boolean

accepted

email
email string

email

isOwner
isOwner boolean

isOwner

model
model string

model

roles
roles array of string

roles

shareUuid
shareUuid string

shareUuid

type
type string

type

uuid
uuid string

uuid

Create document

If Request is application:hal+json, it creates metadata only. If Request is multipart:form-data, it creates document with content in one single call.

Parameters

Name Key Required Type Description
Workspace UUID
shareUuid True string

The share uuid from the path

File content
file True file

The file content to upload

File name
name True string

The file name

Parent UUID
parentUuid string

(Optional)

Summary
summary string

(Optional)

Returns

Create workspace

Create workspace

Parameters

Name Key Required Type Description
User UUID
userUuid True string

User UUID

Access
access string
Agent
agentShareToken string

Agent token

Name
name True string

Name

Organization
organisationUuid string

Organisation UUID

Owner
ownerUuid string

Owner UUID

Summary
summary string

Summary

UUID
uuid string

UUID

Returns

Delete participant

Removes participant from the workspace

Parameters

Name Key Required Type Description
User
uuid True string

User UUID

Returns

Get document content

Returns the contents of a document

Parameters

Name Key Required Type Description
Document
assetUuid True string

UUID

Workspace
shareUuid True string

UUID

Get document version

Get an asset version

Parameters

Name Key Required Type Description
Document
assetUuid True string

UUID

Workspace
shareUuid True string

UUID

Version
version True integer

The version number of the document

Returns

Get document version content

Returns the contents of a Document version

Parameters

Name Key Required Type Description
Document
assetUuid True string

UUID

Content version
contentVersion True integer

The version number of the document

Workspace
shareUuid True string

UUID

Get participants

Get workspace participants

Parameters

Name Key Required Type Description
User
userUuid string

User UUID

Returns

Name Path Type Description
array of object
accepted
accepted boolean

accepted

email
email string

email

isOwner
isOwner boolean

isOwner

joinedDate
joinedDate string

joinedDate

model
model string

model

name
name string

name

roles
roles array of string

roles

shareUuid
shareUuid string

shareUuid

type
type string

type

uuid
uuid string

uuid

Get user

Get users

Parameters

Name Key Required Type Description
Email
emailAddress string

The email address to search for

Length
length integer

The number of results to return. Only used if offset is used.

Offset
offset integer

Return the results after this position

Organisation
orgUuid string

The UUID of the organisation to search for

Sort
sort string

The param - sort should be of the format a word indicating the sort field an optional ":desc" tag, if not present ascending is assumed. Bad or empty requests default to ascending name. Available sorts are - firstName, lastName, email

User UUIDs
uuids array

The list of user uuids

Returns

Get workspace

Get workspace by ID

Parameters

Name Key Required Type Description
Workspace
shareUuid True string

The uuid of the Workspace to retrieve

Returns

List document versions

Get a list of Asset versions

Parameters

Name Key Required Type Description
Document
assetUuid True string

Document UUID

Workspace
shareUuid True string

Workspace UUID

Length
length integer

The maximum number of results to retrieve

Offset
offset integer

The result at which to start (defaults to 0).

Returns

List shared documents

Get a list of Assets by Workspace UUID

Parameters

Name Key Required Type Description
Workspace
shareUuid True string

Workspace UUID

Length
length integer

Maximum number of results to retrieve

Offset
offset integer

Result at which returned values start (defaults to 0)

Parent UUID
parentUuid string

The UUID of the share or parent asset. If provided the results will be restricted to immediate children of the share or asset. If invalid, the response will be 200 with an empty list.

Query
query string

The search query string. If provided the results will be restricted to assets with name starting with the given query value.

Sort
sort string

Sort order criteria string. Acceptable values are

  • name
  • createdDate
  • modifiedDate
  • size The sort criteria can optionally be followed by ":desc" to indicate that sorting should be in descending order. If no sortInfo is provided, or it contains invalid values, the list will be sorted by ascending Asset name

Returns

Name Path Type Description
array of object
annotationsCount
annotationsCount integer

annotationsCount

commentCount
commentCount integer

commentCount

contentVersion
contentVersion integer

contentVersion

createdDate
createdDate string

createdDate

extension
extension string

extension

fileSize
fileSize integer

fileSize

locked
locked boolean

locked

model
model string

model

modifiedByUuid
modifiedByUuid string

modifiedByUuid

modifiedDate
modifiedDate string

modifiedDate

name
name string

name

pdfPreviewstatus
pdfPreviewstatus string

pdfPreviewstatus

previewPageCount
previewPageCount integer

previewPageCount

previewstatus
previewstatus string

previewstatus

status
status string

status

type
type string

type

uuid
uuid string

uuid

wopiRestricted
wopiRestricted boolean

wopiRestricted

List workspaces

Get a list of Shares which the requesting user has privilege to see

Parameters

Name Key Required Type Description
Length
length integer

Maximum number of results to retrieve

Offset
offset integer

Result at which returned values start (defaults to 0)

Owner
ownerUuid string

User UUID of the owner. If provided the results will be restricted to shares that are owned by this user

Participant
participantUuid string

User UUID of the participant. If provided the results will be restricted to shares where this user is a participant

Query
query string

Search query string. If provided the results will be restricted to shares with name containing the given query value

Sort
sort string

Sort order criteria string. Acceptable values are

  • name
  • createdDate
  • modifiedDate
  • joined
  • shareOrder
  • organisation The sort criteria can optionally be followed by ":desc" to indicate that sorting should be in descending order. If no sortInfo is provided, or it contains invalid values, the list will be sorted by ascending Share name.
Workgroup
workgroupUuid string

Workgroup UUID. If provided the results will be restricted to shares that belong to the workgroup

Returns

Upload document content

Upload content for a Document

Parameters

Name Key Required Type Description
Document
assetUuid True string

Document UUID

Workspace
shareUuid True string

Workspace UUID

File content
file True file

The file content to upload

Definitions

Access

Access
string

AssetReturnDocumentResponse

Name Path Type Description
commentCount
commentCount integer
contentVersion
contentVersion integer
createdDate
createdDate string
extension
extension string
fileSize
fileSize integer
locked
locked boolean
model
model string
modifiedByUuid
modifiedByUuid string
modifiedDate
modifiedDate string
name
name string
parentUuid
parentUuid string
previewPageCount
previewPageCount integer
previewstatus
previewstatus PreviewStatus
status
status AssetStatus
summary
summary string
type
type AssetType
uuid
uuid string
wopiRestricted
wopiRestricted boolean

AssetStatus

AssetType

DocumentVersion

Name Path Type Description
createdDate
createdDate string
extension
extension string
fileSize
fileSize integer
model
model string
status
status AssetStatus
uuid
uuid string
version
version integer

EndOnDateOptionalValue

Name Path Type Description
present
present boolean
value
value string

NotificationPreference

NotificationPreference
string

PreviewStatus

ShareResponse

Name Path Type Description
Access
access Access
connections
connections integer
createdDate
createdDate string
EndOnDateOptionalValue
endOnDateOptionalValue EndOnDateOptionalValue
model
model string
modifiedDate
modifiedDate string
name
name string
organisationUuid
organisationUuid string
ownerUuid
ownerUuid string
secure
secure boolean
ShareStatus
shareStatus ShareStatus
status
status AssetStatus
SynchStatus
synchStatus SynchStatus
uuid
uuid string

ShareStatus

ShareStatus
string

SynchStatus

SynchStatus
string

UserResponse

Name Path Type Description
disabled
disabled boolean
email
email string
firstName
firstName string
hideEmailAddress
hideEmailAddress boolean
lastName
lastName string
model
model string
notificationPreferences
notificationPreferences array of NotificationPreference
organisationUuid
organisationUuid string
roles
roles array of string
UserStatus
status UserStatus
timezone
timezone string
uuid
uuid string

UserStatus

UserStatus
string