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.
Status: Preview |
Tier: Premium |
Version: 1.0.2 |
Name |
Summary |
Get participants |
|
Add or update participant |
|
Delete participant |
|
List workspaces |
|
Get workspace |
|
List shared documents |
|
Create document |
|
UploadDocumentContent (string assetUuid, string shareUuid, file file) |
Upload document content |
Get document content |
|
GetDocumentVersionContent (string assetUuid, integer contentVersion, string shareUuid) |
Get document version content |
List document versions |
|
GetDocumentVersion (string assetUuid, string shareUuid, integer version) |
Get document version |
Get user |
|
CreateWorkspace (string userUuid, [internal]string Content-Type, ShareCreateRequest body) |
Create workspace |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
File content |
|
|
|
|
|
|
|
|
|
|
Summary: Get participants
Description: Get workspace participants
Syntax:
ObjectiveConnect.GetParticipants ([internal]boolean noContentReplacesSeeOther, [Optional]string userUuid, [internal]string accept)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
noContentReplacesSeeOther |
boolean
|
|
True |
|
userUuid |
string (User) |
User UUID |
False |
|
accept |
string
|
|
True |
Returns:
Type:array of (GetParticipantsResponseItem)
Summary: Add or update participant
Description: Invite new participant or edit assigned roles
Syntax:
ObjectiveConnect.AddParticipant ([internal]boolean noContentReplacesSeeOther, [internal]string Accept, [internal]string Content-Type, AddParticipantParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
noContentReplacesSeeOther |
boolean
|
|
True |
|
Accept |
string
|
|
True |
|
Content-Type |
string
|
|
True |
|
body |
|
|
True |
Returns:
Type:array of (AddParticipantResponseItem)
Summary: Delete participant
Description: Removes participant from the workspace
Syntax:
ObjectiveConnect.DeleteParticipant (string uuid, [internal]boolean noContentReplacesSeeOther, [internal]string Accept)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
uuid |
string (User) |
User UUID |
True |
|
noContentReplacesSeeOther |
boolean
|
|
True |
|
Accept |
string
|
|
True |
Returns:
Type:DeleteParticipantResponse
Summary: List workspaces
Description: Get a list of Shares which the requesting user has privilege to see
Syntax:
ObjectiveConnect.ListWorkspaces ([advanced][Optional]integer length, [advanced][Optional]integer offset, [Optional]string ownerUuid, [Optional]string participantUuid, [advanced][Optional]string query, [advanced][Optional]string sort, [Optional]string workgroupUuid)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
length |
integer(int32) (Length) |
Maximum number of results to retrieve |
False |
|
offset |
integer(int32) (Offset) |
Result at which returned values start (defaults to 0) |
False |
|
ownerUuid |
string (Owner) |
User UUID of the owner. If provided the results will be restricted to shares that are owned by this user |
False |
|
participantUuid |
string (Participant) |
User UUID of the participant. If provided the results will be restricted to shares where this user is a participant |
False |
|
query |
string (Query) |
Search query string. If provided the results will be restricted to shares with name containing the given query value |
False |
|
sort |
string (Sort) |
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. |
False |
|
workgroupUuid |
string (Workgroup) |
Workgroup UUID. If provided the results will be restricted to shares that belong to the workgroup |
False |
Returns:
Type:array of (ShareResponse)
Summary: Get workspace
Description: Get workspace by ID
Syntax:
ObjectiveConnect.GetWorkspace (string shareUuid)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
shareUuid |
string (Workspace) |
The uuid of the Workspace to retrieve |
True |
Returns:
Type:ShareResponse
Summary: List shared documents
Description: Get a list of Assets by Workspace UUID
Syntax:
ObjectiveConnect.ListDocuments (string shareUuid, [advanced][Optional]integer length, [advanced][Optional]integer offset, [Optional]string parentUuid, [advanced][Optional]string query, [advanced][Optional]string sort)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
shareUuid |
string (Workspace) |
Workspace UUID |
True |
|
length |
integer(int32) (Length) |
Maximum number of results to retrieve |
False |
|
offset |
integer(int32) (Offset) |
Result at which returned values start (defaults to 0) |
False |
|
parentUuid |
string (Parent UUID) |
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. |
False |
|
query |
string (Query) |
The search query string. If provided the results will be restricted to assets with name starting with the given query value. |
False |
|
sort |
string (Sort) |
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 |
False |
Returns:
Type:array of (ListDocumentsResponseItem)
Summary: Create document
Description: 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.
Syntax:
ObjectiveConnect.CreateDocument (string shareUuid, file file, string name, [Optional]string parentUuid, [Optional]string summary)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
shareUuid |
string (Workspace UUID) |
The share uuid from the path |
True |
|
file |
(File content) |
The file content to upload |
True |
|
name |
string (File name) |
The file name |
True |
|
parentUuid |
string (Parent UUID) |
(Optional) |
False |
|
summary |
string (Summary) |
(Optional) |
False |
Returns:
Type:AssetReturnDocumentResponse
Summary: Upload document content
Description: Upload content for a Document
Syntax:
ObjectiveConnect.UploadDocumentContent (string assetUuid, string shareUuid, file file)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
assetUuid |
string (Document) |
Document UUID |
True |
|
shareUuid |
string (Workspace) |
Workspace UUID |
True |
|
file |
(File content) |
The file content to upload |
True |
Returns:
Summary: Get document content
Description: Returns the contents of a document
Syntax:
ObjectiveConnect.GetDocumentContent (string assetUuid, string shareUuid)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
assetUuid |
string (Document) |
UUID |
True |
|
shareUuid |
string (Workspace) |
UUID |
True |
Returns:
Summary: Get document version content
Description: Returns the contents of a Document version
Syntax:
ObjectiveConnect.GetDocumentVersionContent (string assetUuid, integer contentVersion, string shareUuid)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
assetUuid |
string (Document) |
UUID |
True |
|
contentVersion |
integer(int32) (Content version) |
The version number of the document |
True |
|
shareUuid |
string (Workspace) |
UUID |
True |
Returns:
Summary: List document versions
Description: Get a list of Asset versions
Syntax:
ObjectiveConnect.ListDocumentVersions (string assetUuid, string shareUuid, [advanced][Optional]integer length, [advanced][Optional]integer offset)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
assetUuid |
string (Document) |
Document UUID |
True |
|
shareUuid |
string (Workspace) |
Workspace UUID |
True |
|
length |
integer(int32) (Length) |
The maximum number of results to retrieve |
False |
|
offset |
integer(int32) (Offset) |
The result at which to start (defaults to 0). |
False |
Returns:
Type:array of (DocumentVersion)
Summary: Get document version
Description: Get an asset version
Syntax:
ObjectiveConnect.GetDocumentVersion (string assetUuid, string shareUuid, integer version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
assetUuid |
string (Document) |
UUID |
True |
|
shareUuid |
string (Workspace) |
UUID |
True |
|
version |
integer(int32) (Version) |
The version number of the document |
True |
Returns:
Type:DocumentVersion
Summary: Get user
Description: Get users
Syntax:
ObjectiveConnect.GetUser ([internal]string accept, [Optional]string emailAddress, [advanced][Optional]integer length, [advanced][Optional]integer offset, [Optional]string orgUuid, [advanced][Optional]string sort, [Optional]array uuids)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
accept |
string
|
|
True |
|
emailAddress |
string (Email) |
The email address to search for |
False |
|
length |
integer(int32) (Length) |
The number of results to return. Only used if offset is used. |
False |
|
offset |
integer(int32) (Offset) |
Return the results after this position |
False |
|
orgUuid |
string (Organisation) |
The UUID of the organisation to search for |
False |
|
sort |
string (Sort) |
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 |
False |
|
uuids |
array of (string) (User UUIDs) |
The list of user uuids |
False |
Returns:
Type:array of (UserResponse)
Summary: Create workspace
Description: Create workspace
Syntax:
ObjectiveConnect.CreateWorkspace (string userUuid, [internal]string Content-Type, ShareCreateRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
userUuid |
string (User UUID) |
User UUID |
True |
|
Content-Type |
string
|
|
True |
|
body |
|
|
True |
Returns:
Type:ShareResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
emails |
array of (string)
|
emails |
message |
string
|
Invitation message |
roles |
array of (string)
|
roles |
shareUuid |
string
|
UUID |
type |
string
|
STANDARD - visible to other participants. BCC - participant will be hidden from others Values: [STANDARD, BCC] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
accepted |
boolean
|
accepted |
|
string
|
|
isOwner |
boolean
|
isOwner |
model |
string
|
model |
roles |
array of (string)
|
roles |
shareUuid |
string
|
shareUuid |
type |
string
|
type |
uuid |
string
|
uuid |
Summary:
Description:
Properties:
Name |
Type |
Summary |
commentCount |
integer(int32)
|
|
contentVersion |
integer(int32)
|
|
createdDate |
string
|
|
extension |
string
|
|
fileSize |
integer(int32)
|
|
locked |
boolean
|
|
model |
string
|
|
modifiedByUuid |
string
|
|
modifiedDate |
string
|
|
name |
string
|
|
parentUuid |
string
|
|
previewPageCount |
integer(int32)
|
|
previewstatus |
string
|
Values: [COMPLETED, FAILED, NEW, PROCESSING, UNSUPPORTED] |
status |
string
|
Values: [COMPLETE, ERROR, SAVED, SAVING, SCANNED, SCANNING, UNDEFINED, UPLOADING, VIRUS_DETECTED, WAITING_FOR_UPLOAD] |
summary |
string
|
|
type |
string
|
Values: [DOCUMENT] |
uuid |
string
|
|
wopiRestricted |
boolean
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
createdDate |
string
|
|
extension |
string
|
|
fileSize |
integer(int32)
|
|
model |
string
|
|
status |
string
|
Values: [COMPLETE, ERROR, SAVED, SAVING, SCANNED, SCANNING, UNDEFINED, UPLOADING, VIRUS_DETECTED, WAITING_FOR_UPLOAD] |
uuid |
string
|
|
version |
integer(int32)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
present |
boolean
|
|
value |
string
|
|
Summary: File content
Description: The file content to upload
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
accepted |
boolean
|
accepted |
|
string
|
|
isOwner |
boolean
|
isOwner |
joinedDate |
string
|
joinedDate |
model |
string
|
model |
name |
string
|
name |
roles |
array of (string)
|
roles |
shareUuid |
string
|
shareUuid |
type |
string
|
type |
uuid |
string
|
uuid |
Summary:
Description:
Properties:
Name |
Type |
Summary |
annotationsCount |
integer(int32)
|
annotationsCount |
commentCount |
integer(int32)
|
commentCount |
contentVersion |
integer(int32)
|
contentVersion |
createdDate |
string
|
createdDate |
extension |
string
|
extension |
fileSize |
integer(int32)
|
fileSize |
locked |
boolean
|
locked |
model |
string
|
model |
modifiedByUuid |
string
|
modifiedByUuid |
modifiedDate |
string
|
modifiedDate |
name |
string
|
name |
pdfPreviewstatus |
string
|
pdfPreviewstatus |
previewPageCount |
integer(int32)
|
previewPageCount |
previewstatus |
string
|
previewstatus |
status |
string
|
status |
type |
string
|
type |
uuid |
string
|
uuid |
wopiRestricted |
boolean
|
wopiRestricted |
Summary:
Description:
Properties:
Name |
Type |
Summary |
access |
string
|
Values: [READ, READ_ADD] |
agentShareToken |
string Agent |
Agent token |
name |
string Name |
Name |
organisationUuid |
string Organization |
Organisation UUID |
ownerUuid |
string Owner |
Owner UUID |
summary |
string Summary |
Summary |
uuid |
string UUID |
UUID |
Summary:
Description:
Properties:
Name |
Type |
Summary |
access |
string
|
Values: [READ, READ_ADD] |
connections |
integer(int32)
|
|
createdDate |
string
|
|
endOnDateOptionalValue |
|
|
model |
string
|
|
modifiedDate |
string
|
|
name |
string
|
|
organisationUuid |
string
|
|
ownerUuid |
string
|
|
secure |
boolean
|
|
shareStatus |
string
|
Values: [ACTIVE, TRANSFERRING] |
status |
string
|
Values: [COMPLETE, ERROR, SAVED, SAVING, SCANNED, SCANNING, UNDEFINED, UPLOADING, VIRUS_DETECTED, WAITING_FOR_UPLOAD] |
synchStatus |
string
|
Values: [COMPLETE, ERROR, SAVED, SAVING, SCANNED, SCANNING, UNDEFINED, UPLOADING, VIRUS_DETECTED, WAITING_FOR_UPLOAD] |
uuid |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
disabled |
boolean
|
|
|
string
|
|
firstName |
string
|
|
hideEmailAddress |
boolean
|
|
lastName |
string
|
|
model |
string
|
|
notificationPreferences |
array of (string)
|
|
organisationUuid |
string
|
|
roles |
array of (string)
|
|
status |
string
|
Values: [ACTIVE, INVITED] |
timezone |
string
|
|
uuid |
string
|
|