Connectors Reference

Seismic

Seismic is the leading sales enablement platform.  By leveraging Seismic in your flows and power apps you can create rich workflow processes and business applications to increase business productivity and effectiveness.

 

Status: Preview

Tier: Premium

Version: v2

 

Actions:

Name

Summary

GetGenerationResultAsync (string generatedLivedocId)

Get status of LiveDoc generation

GetGeneratedLiveDocContent (string generatedLivedocId, string outputId, [internal]boolean redirect)

Download LiveDoc output

GetPredictiveContentResultSet (string predictiveContentId, string contextId)

Get predictive content

GetTeamsitesAsync ()

Get teamsites

CreateLibraryFile (string teamsiteId, string metadata, file content)

Add a File [Library]

GetItemInformation (string teamsiteId, string libraryContentId)

Get item details [Library]

SubmitLibraryItemToWorkflow (string teamsiteId, string libraryContentId, [Optional]OriginApiClient.Models.LibraryWorkflow.SubmitFileToWorkFlowRequest comment)

Submit a document into workflow [Library]

GetLiveDocInputParams (string teamsiteId, string libraryContentVersionId)

Get list of inputs for LiveDoc

GenerateAsync (string teamsiteId, string libraryContentVersionId, [Optional]GenerateAsyncParameterGenInputReq genInputReq)

Generate a LiveDoc

PublishLibraryItems (string teamsiteId, [Optional]V2.LibraryPublishing.PublishRequest publishRequest)

Publish one or more documents [Library]

GetUserDetails (string userId)

Get user details

CreateFile (string metadata, file content)

Add a File [Workspace]

CreateWorkspaceFolder ([Optional]V2.WorkSpaceContentManager.Models.WsFolderReq folder)

Add a folder [Workspace]

CreateWorkspaceContextualFolder ([Optional]V2.WorkSpaceContentManager.Models.ContextualFolderRequest folder)

Add or get a contextual folder [Workspace]

GetWorkspaceFolderItems (string workspaceFolderId)

Get items in a folder [Workspace]

GetItem (string workspaceContentId)

Get item details [Workspace]

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

file

Content

GenerateAsyncParameterGenInputReq

 

OriginApiClient.Models.LibraryWorkflow.SubmitFileToWorkFlowRequest

 

Seismic.PublicIntegrationApi.OriginApiClient.Models.ContentManager.ContentCustomProperties

 

V2.AdHocInputs

 

V2.Common.CreatedUser

 

V2.Common.Models.DownloadLocationResp

 

V2.Common.ModifiedUser

 

V2.LibraryContentManagement.Models.AssignedToProfile

 

V2.LibraryContentManagement.Models.ContentExperts

 

V2.LibraryContentManagement.Models.CustomProperties

 

V2.LibraryContentManagement.Models.FileResponse

 

V2.LibraryContentManagement.Models.ItemResponse

 

V2.LibraryContentManagement.Models.UrlInfo

 

V2.LibraryPublishing.ErrorPublishResponseStatus

 

V2.LibraryPublishing.PublishContentItem

 

V2.LibraryPublishing.PublishRequest

 

V2.LibraryPublishing.PublishResponse

 

V2.LibraryPublishing.WarningPublishResponseStatus

 

V2.LibraryWorkflow.LibraryContent

 

V2.LiveDocs.Models.ResponseModels.AdhocInputResp

 

V2.LiveDocs.Models.ResponseModels.AdhocInputRespItems

 

V2.LiveDocs.Models.ResponseModels.LiveDocGenOutputResultResp

 

V2.LiveDocs.Models.ResponseModels.LiveDocGenResultResp

 

V2.LiveDocs.Models.ResponseModels.LiveDocGenSuccinctResultResp

 

V2.LiveDocs.Models.ResponseModels.LiveDocVersionResp

 

V2.PredictiveContent.Models.PredictiveContentHierarchy

 

V2.PredictiveContent.Models.PredictiveContentResponse

 

V2.PredictiveContent.Models.PredictiveContentScore

 

V2.Teamsites.TeamsiteResponse

 

V2.Users.UserResponse

 

V2.Workspace.ApplicationUrl

 

V2.Workspace.CreatedUser

 

V2.Workspace.DeliveryOption

 

V2.Workspace.ModifiedUser

 

V2.WorkSpaceContentManager.Models.ContextualFolderRequest

 

V2.WorkSpaceContentManager.Models.Items.Of.V2.WorkSpaceContentManager.Models.WsItemResp

 

V2.WorkSpaceContentManager.Models.WsFileResp

 

V2.WorkSpaceContentManager.Models.WsFolderReq

 

V2.WorkSpaceContentManager.Models.WsFolderResp

 

V2.WorkSpaceContentManager.Models.WsItemResp

 

V2.WorkSpaceContentManager.Models.WsUrlInfoResp

 

 

Actions:

GetGenerationResultAsync

Summary: Get status of LiveDoc generation

Description: This is where you get the status for a generation process, it will give you the overall status for all underlying steps, but will also provide             a breakdown for the readiness of the underlying assets. For example if you just want the PPTX, you may be able to download that before the PDF is done rendering.

 

Syntax:

Seismic.GetGenerationResultAsync (string generatedLivedocId)

 

Parameters:

Name

Type

Summary

Required

Related Action

generatedLivedocId

string

(GeneratedLiveDocId)

The id of the Generated Live Doc

True

 

Returns:

          Type:V2.LiveDocs.Models.ResponseModels.LiveDocGenResultResp

 

GetGeneratedLiveDocContent

Summary: Download LiveDoc output

Description: This is where you can download a particular generated output such as a PPTX, DOCX, PDF, or XLSX. This endpoint also supports the   special keywords of "pptx", "docx", "pdf" as special aliases of the generatedOutputId such that you do not need to first get the generatedOutputId             in order to use this endpoint.

 

Syntax:

Seismic.GetGeneratedLiveDocContent (string generatedLivedocId, string outputId, [internal]boolean redirect)

 

Parameters:

Name

Type

Summary

Required

Related Action

generatedLivedocId

string

(generatedLiveDocId)

The id of the generated Live Doc

True

outputId

string

(outputId)

The id of the specfic output file you wish to download.

True

redirect

boolean

(redirect)

This needs to be set to false in order to get the download url in response body.

True

 

Returns:

          Type:V2.Common.Models.DownloadLocationResp

 

GetPredictiveContentResultSet

Summary: Get predictive content

Description: Gets the list of predictive content for a given predictive content setting for the currently authenticated user. In the case of predictive content which is dynamically grouped or inherits its hierarchy from the parent DocCenter folder, the hierarchy is provided in the hierarchy object with levels represented sequentially in the array. It is up to the UI to render the hierarchy.

 

Syntax:

Seismic.GetPredictiveContentResultSet (string predictiveContentId, string contextId)

 

Parameters:

Name

Type

Summary

Required

Related Action

predictiveContentId

string

(Predictive Content Id or Title)

Predictive Content Setting Id or Title

True

contextId

string

(Context Id)

ContextId of content from SalesForce, Sugar, Dynamics, Etc.

True

 

Returns:

          Type:array of (V2.PredictiveContent.Models.PredictiveContentResponse)

 

GetTeamsitesAsync

Summary: Get teamsites

Description: Provides the full list of teamsites in a tenant, regardless of user access.

 

Syntax:

Seismic.GetTeamsitesAsync ()

 

Returns:

          Type:array of (V2.Teamsites.TeamsiteResponse)

 

CreateLibraryFile

Summary: Add a File [Library]

Description: Adds a new file using a `multipart/form-data` POST containing the file's metadata and the file contents. The metadata part includes required properties such as the name, format, and parentFolderId, but can also include any properties documented in the `PATCH` /files/:libraryContentId operation. Use the special keyword "root" to add files to the root folder of a teamsite. The content part includes the file's binary content to be uploaded.

 

Syntax:

Seismic.CreateLibraryFile (string teamsiteId, string metadata, file content)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamsiteId

string

(Teamsite Id)

Teamsite Id

True

GetTeamsitesAsync

metadata

string

(Metadata)

Json Object with 'name', 'parentFolderId' and 'format' like 'ppt' or 'doc'. Example: {"name" : "Big Presentation", "parentFolderId" : "root", "format": "ppt"}

True

content

file

(Content)

File content bytes. Use a Content-Disposition that includes a 'filename' parameter to indicate this is file data. The specific filename value is ignored in favor of metadata.name.

True

 

Returns:

          Type:V2.LibraryContentManagement.Models.FileResponse

 

GetItemInformation

Summary: Get item details [Library]

Description: Get details for any item type in Library

 

Syntax:

Seismic.GetItemInformation (string teamsiteId, string libraryContentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamsiteId

string

(Teamsite Id)

The teamsite id the item belongs to

True

libraryContentId

string

(Library Content Id)

The id of the item

True

 

Returns:

          Type:V2.LibraryContentManagement.Models.ItemResponse

 

SubmitLibraryItemToWorkflow

Summary: Submit a document into workflow [Library]

Description: Submit a document into workflow

 

Syntax:

Seismic.SubmitLibraryItemToWorkflow (string teamsiteId, string libraryContentId, [Optional]OriginApiClient.Models.LibraryWorkflow.SubmitFileToWorkFlowRequest comment)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamsiteId

string

(Teamsite Id)

The id of the teamsite

True

GetTeamsitesAsync

libraryContentId

string

(The id of library content)

Library Content Id

True

comment

OriginApiClient.Models.LibraryWorkflow.SubmitFileToWorkFlowRequest

 

 

False

 

Returns:

 

GetLiveDocInputParams

Summary: Get list of inputs for LiveDoc

Description: Gets the list of adHoc inputs required to generate a LiveDoc. Each input has a name and type in the following format: `{"name": "variable_name_here", "type": "string"}`

 

Syntax:

Seismic.GetLiveDocInputParams (string teamsiteId, string libraryContentVersionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamsiteId

string

(Teamsite Id)

The id of the teamsite

True

GetTeamsitesAsync

libraryContentVersionId

string

(Library Content Version Id)

The library content version id

True

 

Returns:

          Type:V2.LiveDocs.Models.ResponseModels.LiveDocVersionResp

 

GenerateAsync

Summary: Generate a LiveDoc

Description: This is where you start a generation, with all the necessary options. Each of the desired outputs must be specified in the "outputs" array. If you do not specify any outputs, this endpoint will return a 4xx error. *Note: Generated outputs are only available for download for 24 hours from time of generation*  ### BODY PARAMETER DEFINITIONS #### ADHOCINPUTS  Single variables are represented as an object such as: >{"name" : "field name here", "value" : "the value to pass in"}  Adhoc tables are represented as an object with columns and a set of rows such as: >{ "name": "adhoc_4", "value": { "columns": ["StrCol", "IntCol"], "rows": [["hello", 1], ["goodbye", 2]] } #### OUTPUTS * imageDpi for PPT and DOC can be set to 0, 96, 120, 144, 200, 300, 400. When set to 0, we will use placeholders rather than rasterized images in place of dynamic images. * layout for PDF can be set to Full Page Slides or Notes Pages to produce slides or note pages * openPassword specifies the password required to open the PDF, if not provided, it will default to no password * ownerPassword specifies the password required to open the PDF as an edit mode owner, if not provided, it will default to no password

 

Syntax:

Seismic.GenerateAsync (string teamsiteId, string libraryContentVersionId, [Optional]GenerateAsyncParameterGenInputReq genInputReq)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamsiteId

string

(Teamsite Id)

The id of the teamsite

True

GetTeamsitesAsync

libraryContentVersionId

string

(Library Content Version Id)

The library content version id

True

genInputReq

GenerateAsyncParameterGenInputReq

 

 

False

 

Returns:

          Type:V2.LiveDocs.Models.ResponseModels.LiveDocGenSuccinctResultResp

 

PublishLibraryItems

Summary: Publish one or more documents [Library]

Description: This endpoint can be used to immediately promote and publish content, or schedule publish of content for a future date for any number of unpublished documents.             The content list is a list of library content. The publish endpoint will always publish the latest version of the document, taking it from a draft to a published document.

 

Syntax:

Seismic.PublishLibraryItems (string teamsiteId, [Optional]V2.LibraryPublishing.PublishRequest publishRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

teamsiteId

string

(Teamsite Id)

The id of the teamsite

True

GetTeamsitesAsync

publishRequest

V2.LibraryPublishing.PublishRequest

 

 

False

 

Returns:

          Type:V2.LibraryPublishing.PublishResponse

 

GetUserDetails

Summary: Get user details

Description: Get the user details for the specified id

 

Syntax:

Seismic.GetUserDetails (string userId)

 

Parameters:

Name

Type

Summary

Required

Related Action

userId

string

(User Id)

The id of the user

True

 

Returns:

          Type:V2.Users.UserResponse

 

CreateFile

Summary: Add a File [Workspace]

Description: Adds a new file using a multi-part POST containing the file's metadata and the file contents. Using a `multipart/form-data` body, send body parts named 'metadata' and 'content'. The metadata should be a JSON object. The content part should contain the bytes of the file.

 

Syntax:

Seismic.CreateFile (string metadata, file content)

 

Parameters:

Name

Type

Summary

Required

Related Action

metadata

string

(Form Data)

Json Object with 'name', 'parentFolderId' and 'format' like 'ppt' or 'doc'. Example: {"name" : "Big Presentation", "parentFolderId" : "root", "format": "ppt"}

True

content

file

(File Contents)

File content bytes. Use a Content-Disposition that includes a 'filename' parameter to indicate this is file data. The specific filename value is ignored in favor of metadata.name.

True

 

Returns:

          Type:V2.WorkSpaceContentManager.Models.WsFileResp

 

CreateWorkspaceFolder

Summary: Add a folder [Workspace]

Description: Adds a new workspace folder inside a given folder. Use the special keywork "root" as the parentFolderId to create a new folder in the user's root.

 

Syntax:

Seismic.CreateWorkspaceFolder ([Optional]V2.WorkSpaceContentManager.Models.WsFolderReq folder)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

V2.WorkSpaceContentManager.Models.WsFolderReq

 

 

False

 

Returns:

          Type:V2.WorkSpaceContentManager.Models.WsFolderResp

 

CreateWorkspaceContextualFolder

Summary: Add or get a contextual folder [Workspace]

Description: Creates a contextual folder or gets the workspaceContentId for a contextual folder if it already exists. These contextual folders are identified by the combination of systemType, contextType, contextTypePlural, and contextId. >Caution: Folders Cannot be Deleted! > >Any folders created with this API cannot be deleted including the folder for the systemType, contextTypePlural, and contextId, so take extreme caution when using this endpoint.  Any typo in any of these fields will yield invalid non-removable folders.  Each of the values is case sensitive.

 

Syntax:

Seismic.CreateWorkspaceContextualFolder ([Optional]V2.WorkSpaceContentManager.Models.ContextualFolderRequest folder)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

V2.WorkSpaceContentManager.Models.ContextualFolderRequest

 

 

False

 

Returns:

          Type:V2.WorkSpaceContentManager.Models.WsFolderResp

 

GetWorkspaceFolderItems

Summary: Get items in a folder [Workspace]

Description: Gets a list of items (file, folder, url, etc) in a parent folder.

 

Syntax:

Seismic.GetWorkspaceFolderItems (string workspaceFolderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspaceFolderId

string

(Workspace Folder Id)

Id of the folder. Use "root" for the root folder.

True

 

Returns:

Type:V2.WorkSpaceContentManager.Models.Items.Of.V2.WorkSpaceContentManager.Models.WsItemResp

 

GetItem

Summary: Get item details [Workspace]

Description: Get details for any item type in Workspace

 

Syntax:

Seismic.GetItem (string workspaceContentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspaceContentId

string

(Workspace Content Id)

The id of the workspace content

True

 

Returns:

          Type:V2.WorkSpaceContentManager.Models.WsItemResp

 


 

file

Summary: Content

Description: File content bytes. Use a Content-Disposition that includes a 'filename' parameter to indicate this is file data. The specific filename value is ignored in favor of metadata.name.

 

          Properties:

Name

Type

Summary


 

GenerateAsyncParameterGenInputReq

Summary:

Description:

 

          Properties:

Name

Type

Summary

adHocInputs

array of (V2.AdHocInputs)

 

 

outputs

array of (OutputsItem)

 

 

 

OutputsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

docxOptions

DocxOptions

 

 

format

string

 

Values: [PPTX, DOCX, PDF, XLSX]

name

string

 

 

pdfOptions

PdfOptions

 

 

pptxOptions

PptxOptions

 

 

xlsxOptions

XlsxOptions

 

 

 

DocxOptions

Summary:

Description:

 

          Properties:

Name

Type

Summary

imageDpi

integer

 

Values: [, , , , , , ]

 

PdfOptions

Summary:

Description:

 

          Properties:

Name

Type

Summary

compatibility

string

 

Values: [Acrobat 5.0, Acrobat 7.0, Acrobat 9.0]

layout

string

 

Values: [Full Page Slides, Note Pages]

openPassword

string

 

 

ownerOptions

string

 

 

ownerPassword

string

 

 

 

PptxOptions

Summary:

Description:

 

          Properties:

Name

Type

Summary

clearNotes

boolean

 

 

imageDpi

integer

 

Values: [, , , , , , ]

 

XlsxOptions

Summary:

Description:

 

          Properties:

Name

Type

Summary

datasource

string

 

 

 


 

OriginApiClient.Models.LibraryWorkflow.SubmitFileToWorkFlowRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

comments

string

 

A comment for the submission


 

Seismic.PublicIntegrationApi.OriginApiClient.Models.ContentManager.ContentCustomProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

values

array of (string)

 

 


 

V2.AdHocInputs

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

Ad Hoc Input Name

value

string

 

The value of the ad hoc input field


 

V2.Common.CreatedUser

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Creator User Id


 

V2.Common.Models.DownloadLocationResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

downloadUrl

string

 

 


 

V2.Common.ModifiedUser

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Modifier User Id


 

V2.LibraryContentManagement.Models.AssignedToProfile

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The content profile id that the library content is assigned to.

name

string

 

The assigned to profile's name.

type

string

 

The profile type (user/group)


 

V2.LibraryContentManagement.Models.ContentExperts

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Content Expert Id

type

string

 

User or group


 

V2.LibraryContentManagement.Models.CustomProperties

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Custom Property Id

name

string

 

Custom Property Name

values

array of (string)

 

 


 

V2.LibraryContentManagement.Models.FileResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

assignedToProfiles

array of (V2.LibraryContentManagement.Models.AssignedToProfile)

 

 

createdAt

string(date-time)

 

 

createdBy

V2.Common.CreatedUser

 

 

description

string

 

The description for the item.

experts

array of (V2.LibraryContentManagement.Models.ContentExperts)

 

A list of experts for this item. A user expert would be in the form `{"type":"user", "id":"the users id"}`. A group expert would be in the form `{"type":"group", "id":"the group id"}`.

expiresAt

string(date-time)

 

The date the item expires which can only be set to the future. This date does not accept the time component, so should be specified as a UTC YYYY-MM-DD.

externalConnectionId

string

 

The external system linked to this document, if applicable

externalId

string

 

The id of the document in the external system, if applicable

format

string

 

The file format of the library content

id

string

 

The id of the library content

modifiedAt

string(date-time)

 

 

modifiedBy

V2.Common.ModifiedUser

 

 

name

string

 

The name of the item.

ownerId

string

 

The userId of the owner of the item.

parentFolderId

string

 

The GUID of the item's parent folder. Changing this value will move the item from one folder to another. Use "root" to place items in the root folder of the teamsite.

properties

array of (V2.LibraryContentManagement.Models.CustomProperties)

 

An array of properties and their values where each property is identified by its id such as `{"id": "the property id","values": ["Value A", "Value B"]}`. The property name can be included, but will be ignored.

repository

string

 

 

size

integer(int64)

 

 

type

string

 

The type of content (file, folder, url, livedoc, etc)  Values: [unknown, file, folder, url, youtube, vimeo, datasource, livedoc, article, livecomponent]

version

string

 

 

versionId

string

 

The id of the current version of the library content


 

V2.LibraryContentManagement.Models.ItemResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

assignedToProfiles

array of (V2.LibraryContentManagement.Models.AssignedToProfile)

 

 

createdAt

string(date-time)

 

 

createdBy

V2.Common.CreatedUser

 

 

description

string

 

The description for the item.

experts

array of (V2.LibraryContentManagement.Models.ContentExperts)

 

A list of experts for this item. A user expert would be in the form `{"type":"user", "id":"the users id"}`. A group expert would be in the form `{"type":"group", "id":"the group id"}`.

expiresAt

string(date-time)

 

The date the item expires which can only be set to the future. This date does not accept the time component, so should be specified as a UTC YYYY-MM-DD.

externalConnectionId

string

 

 

externalId

string

 

 

format

string

 

 

id

string

 

 

modifiedAt

string(date-time)

 

 

modifiedBy

V2.Common.ModifiedUser

 

 

name

string

 

The name of the item.

ownerId

string

 

The userId of the owner of the item.

parentFolderId

string

 

The GUID of the item's parent folder. Changing this value will move the item from one folder to another. Use "root" to place items in the root folder of the teamsite.

properties

array of (V2.LibraryContentManagement.Models.CustomProperties)

 

An array of properties and their values where each property is identified by its id such as `{"id": "the property id","values": ["Value A", "Value B"]}`. The property name can be included, but will be ignored.

repository

string

 

 

size

integer(int64)

 

 

type

string

 

Values: [unknown, file, folder, url, youtube, vimeo, datasource, livedoc, article, livecomponent]

url

V2.LibraryContentManagement.Models.UrlInfo

 

 

version

string

 

 

versionId

string

 

 


 

V2.LibraryContentManagement.Models.UrlInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

openInNewWindow

boolean

 

 

url

string

 

 


 

V2.LibraryPublishing.ErrorPublishResponseStatus

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the content that errored

message

string

 

The error message


 

V2.LibraryPublishing.PublishContentItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the content to publish.


 

V2.LibraryPublishing.PublishRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

comment

string

 

A note about the publish action

content

array of (V2.LibraryPublishing.PublishContentItem)

 

 

publishAt

string

 

The date and time to publish the content.  This is required if publishing 10 or more documents.


 

V2.LibraryPublishing.PublishResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

errors

array of (V2.LibraryPublishing.ErrorPublishResponseStatus)

 

 

totalErrors

integer(int32)

 

The number of errors

totalRequests

integer(int32)

 

The total requests recieved

totalSucceeded

integer(int32)

 

The number successful

totalWarnings

integer(int32)

 

The total number of warnings

warnings

array of (V2.LibraryPublishing.WarningPublishResponseStatus)

 

 


 

V2.LibraryPublishing.WarningPublishResponseStatus

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the content with a warning

message

string

 

The warning message


 

V2.LibraryWorkflow.LibraryContent

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

versionId

string

 

 


 

V2.LiveDocs.Models.ResponseModels.AdhocInputResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

columns

array of (V2.LiveDocs.Models.ResponseModels.AdhocInputRespItems)

 

 

name

string

 

The name of the ad hoc input field

type

string

 

The type of the adhoc input field (date, string, integer, table, etc)


 

V2.LiveDocs.Models.ResponseModels.AdhocInputRespItems

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

The name of the ad hoc input field

type

string

 

The type of the adhoc input field (date, string, integer, etc)


 

V2.LiveDocs.Models.ResponseModels.LiveDocGenOutputResultResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

format

string

 

The file format of the output document (pdf, pptx, docx, etc)

id

string

 

The id of the LiveDoc output.

name

string

 

The name of the output file.

status

string

 

The completion status of the LiveDoc (Queued, Generating, Completed, Failed)  Values: [Queued, Generating, Completed, Failed]


 

V2.LiveDocs.Models.ResponseModels.LiveDocGenResultResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the generated LiveDoc

outputs

array of (V2.LiveDocs.Models.ResponseModels.LiveDocGenOutputResultResp)

 

 


 

V2.LiveDocs.Models.ResponseModels.LiveDocGenSuccinctResultResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

generatedLivedocId

string

 

The id of the generated LiveDoc


 

V2.LiveDocs.Models.ResponseModels.LiveDocVersionResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

adhocInputs

array of (V2.LiveDocs.Models.ResponseModels.AdhocInputResp)

 

 


 

V2.PredictiveContent.Models.PredictiveContentHierarchy

Summary:

Description:

 

          Properties:

Name

Type

Summary

label

string

 

 

type

string

 

"group" or "folder"


 

V2.PredictiveContent.Models.PredictiveContentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

applicationUrls

array of (V2.Workspace.ApplicationUrl)

 

 

contentProfileId

string

 

 

deliveryOptions

array of (V2.Workspace.DeliveryOption)

 

 

format

string

 

The format of the document (pptx, docx, etc)

hierarchy

array of (V2.PredictiveContent.Models.PredictiveContentHierarchy)

 

 

id

string

 

The DocCenter id of the predictive content.

libraryContent

V2.LibraryWorkflow.LibraryContent

 

 

name

string

 

The name of the predictive content.

properties

array of (Seismic.PublicIntegrationApi.OriginApiClient.Models.ContentManager.ContentCustomProperties)

 

 

repository

string

 

The repository (always DocCenter).

score

V2.PredictiveContent.Models.PredictiveContentScore

 

 

type

string

 

The content type

url

V2.LibraryContentManagement.Models.UrlInfo

 

 


 

V2.PredictiveContent.Models.PredictiveContentScore

Summary:

Description:

 

          Properties:

Name

Type

Summary

points

number(double)

 

 

rank

number(double)

 

 


 

V2.Teamsites.TeamsiteResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the teamsite.

name

string

 

The name of the teamsite.


 

V2.Users.UserResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

 

The address of the user.

biography

string

 

The biography of the user

createdAt

string(date-time)

 

The timestamp that the user was created.

defaultContentProfileId

string

 

The content profile id of the user

email

string

 

The email of the user

firstName

string

 

The first name of the user

fullName

string

 

The full name of the user

id

string

 

The id of the user.

isDeleted

boolean

 

Is this user deleted?

lastName

string

 

The last name of the user

licenseType

string

 

The license type of the user (business, premium, partner)  Values: [business, premium, partner]

organization

string

 

The organization of the user

phoneNumber

string

 

The phone number of the user

ssoId

string

 

The external SSO id of the user

thumbnailId

string

 

The id of the user's thumbnail.

title

string

 

The title of the user

username

string

 

The username of the user


 

V2.Workspace.ApplicationUrl

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

 

url

string

 

 


 

V2.Workspace.CreatedUser

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the user who created the item


 

V2.Workspace.DeliveryOption

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Delivery Option Id


 

V2.Workspace.ModifiedUser

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

The id of the user who modified the item


 

V2.WorkSpaceContentManager.Models.ContextualFolderRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

contextId

string

 

The ID of the record in the external system.  For Salesforce we use 18 character record IDs such as 00646000009eMGLAA2.  For Dynamics we use the record GUID such as 2DDE7B3B-2CAA-E811-A96A-000D3A1C5096.  For Oracle we use the record number such as 3002 . For Sugar we use the record ID such as ecba9f86-4a4a-def6-359c-505a5b33f014.

contextType

string

 

This is the singular form of the context such as "Opportunity" or "Account"

contextTypePlural

string

 

This is the plural form of the context such as "Opportunities" or "Accounts"

name

string

 

The name of the folder you would like to create.  Often the name of the record in the external system.  This name can be updated at any time as the folder is identified by the systemType+contextType+contextId.

systemType

string

 

This is typically one of the following: Salesforce, MicrosoftDynamicCRM, Sugar, Oracle.   But there are no restrictions and any string can be used to specify a new system type for custom applications.


 

V2.WorkSpaceContentManager.Models.Items.Of.V2.WorkSpaceContentManager.Models.WsItemResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

itemCount

integer(int64)

 

The count of items in the folder

items

array of (V2.WorkSpaceContentManager.Models.WsItemResp)

 

 


 

V2.WorkSpaceContentManager.Models.WsFileResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

applicationUrls

array of (V2.Workspace.ApplicationUrl)

 

 

createdAt

string(date-time)

 

The timestamp that the content was created

createdBy

V2.Workspace.CreatedUser

 

 

deliveryOptions

array of (V2.Workspace.DeliveryOption)

 

 

format

string

 

The file format of the workspace content (docx, pdf, pptx, etc)

iconUrl

string

 

Url of the icon of the workspace content

id

string

 

 

isContextualContent

boolean

 

Is this contextual content

modifiedAt

string(date-time)

 

The timestamp that the content was modified

modifiedBy

V2.Workspace.ModifiedUser

 

 

name

string

 

Name of the workspace content

parentFolderId

string

 

The parent folder of the workspace content

repository

string

 

 

resourceUrl

string

 

The url of the content

size

integer(int64)

 

The size of the file

type

string

 

The content type (folder, url, file)  Values: [folder, url, file]

versionId

string

 

The current version id


 

V2.WorkSpaceContentManager.Models.WsFolderReq

Summary:

Description:

 

          Properties:

Name

Type

Summary

format

string

 

 

name

string

 

The name of the workspace folder

parentFolderId

string

 

The id of the parent folder.


 

V2.WorkSpaceContentManager.Models.WsFolderResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

applicationUrls

array of (V2.Workspace.ApplicationUrl)

 

 

createdAt

string(date-time)

 

 

createdBy

V2.Workspace.CreatedUser

 

 

deliveryOptions

array of (V2.Workspace.DeliveryOption)

 

 

format

string

 

 

iconUrl

string

 

The icon url of the workspace folder

id

string

 

 

isContextualContent

boolean

 

 

modifiedAt

string(date-time)

 

 

modifiedBy

V2.Workspace.ModifiedUser

 

 

name

string

 

 

parentFolderId

string

 

 

repository

string

 

 

resourceUrl

string

 

 

size

integer(int64)

 

 

type

string

 

Values: [folder, url, file]

versionId

string

 

 


 

V2.WorkSpaceContentManager.Models.WsItemResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

applicationUrls

array of (V2.Workspace.ApplicationUrl)

 

The url of the workspace content

createdAt

string(date-time)

 

The time the content was created.

createdBy

V2.Workspace.CreatedUser

 

 

deliveryOptions

array of (V2.Workspace.DeliveryOption)

 

 

format

string

 

The file format of the item (docx, pptx, etc).

iconUrl

string

 

The url of the workspace content's icon.

id

string

 

The id of the content in the requested folder

isContextualContent

boolean

 

Is this contextual content.

modifiedAt

string(date-time)

 

The time the content was modified.

modifiedBy

V2.Workspace.ModifiedUser

 

 

name

string

 

The name of the item.

parentFolderId

string

 

The parent folder of the workspace content.

repository

string

 

The repository the item is in (Library, Workspace, DocCenter, ContentManager)

resourceUrl

string

 

The Url to access the workspace content via API.

size

integer(int64)

 

The file's size.

type

string

 

The content type (folder, url, file)  Values: [folder, url, file]

url

V2.WorkSpaceContentManager.Models.WsUrlInfoResp

 

 

versionId

string

 

The current version id of the workspace content


 

V2.WorkSpaceContentManager.Models.WsUrlInfoResp

Summary:

Description:

 

          Properties:

Name

Type

Summary

url

string