K4 API Documentation

http://localhost:8080/K4/services/AdminBasic

addUserToSection1
(
- long publicationID,
- long userID,
- long sectionID,
- long userCategoryID
)
createSection1
(
- long publicationID,
- string name
)
getUserCategoriesByPublicationID1
(
- long publicationID
)
getUsersInSections1
(
- long publicationID,
- long userID?,
- long sectionID?,
- long userCategoryID?
)
isUserActive1
(
- long publicationID,
- long userID
)
removeUserFromSection1
(
- long publicationID,
- long userID,
- long sectionID,
- long userCategoryID
)
setUserActive1
(
- long publicationID,
- long userID,
- boolean active
)

http://localhost:8080/K4/services/k4object/CollectionBasic

beginDeleteCollection1
(
- long publicationID,
- long collectionID,
- boolean allowUI
)
beginDeleteCollectionItem1
(
- long publicationID,
- long collectionItemID,
- boolean allowUI
)
beginNewCollection1
(
- k4CollectionData1 k4CollectionData1
)
beginNewCollectionFileBasic1
(
- long publicationID,
- long collectionID
)
beginNewTextNoteBasic1
(
- long publicationID,
- long collectionID,
- string name,
- string textNote
)
beginNewURLNoteBasic1
(
- long publicationID,
- long collectionID,
- string name,
- string url,
- boolean useURLAsName
)
beginWithdrawFor1
(
- long publicationID,
- long collectionOrItemID,
- boolean collection,
- boolean allowUI
)
endDeleteCollection1
(
- int useCaseInstanceID
)
endDeleteCollectionItem1
(
- int useCaseInstanceID
)
endNewCollection1
(
- int useCaseInstanceID
)
endNewCollectionFileBasic1
(
- int useCaseInstanceID,
- list([collectionItemNameUploadIDs, …])
)
endNewTextNoteBasic1
(
- int useCaseInstanceID
)
endNewURLNoteBasic1
(
- int useCaseInstanceID
)
endWithdrawFor1
(
- int useCaseInstanceID
)
getAdditionalInfoForCollection1
(
- long publicationID,
- list([long collectionID, …]?)
)
getAdditionalInfoForCollectionItem1
(
- long publicationID,
- list([long collectionItemID, …]?)
)
getCollectionByName1
(
- long publicationID,
- string collectionName,
- boolean ownerOnly
)
getCollectionItemFileContent1
(
- long publicationID,
- long collectionItemID
)
getCollectionItemTextContent1
(
- long publicationID,
- long collectionItemID
)
getCollectionItemURLFileContent1
(
- long publicationID,
- long collectionItemID
)
getCollectionsByIDs1
(
- long publicationID,
- list([long collectionID, …]?)
)
getPreviewsByCollectionItemIDs1
(
- long publicationID,
- list([long collectionItemIDs, …]?)
)
getThumbnailsByCollectionItemIDs1
(
- long publicationID,
- list([long collectionItemIDs, …]?)
)
handleDialog1
(
- int useCaseInstanceID,
- string clientResponseXML
)
handleMessage1
(
- int useCaseInstanceID,
- int buttonID
)
logEventCopyCollectionItemContent1
(
- long publicationID,
- long collectionItemID
)
logEventExportCollectionItemContent1
(
- long publicationID,
- long collectionItemID
)

http://localhost:8080/K4/services/k4object/CollectionUI

beginEditCollection1
(
- long publicationID,
- long collectionID
)
beginEditCollectionItem1
(
- long publicationID,
- long collectionItemID
)
beginNewCollection1
(
- long publicationID,
- long objectID,
- int objectType
)
beginNewCollectionFile1
(
- long publicationID,
- long collectionID,
- list([string names, …])
)
beginNewTextNote1
(
- long publicationID,
- long collectionID
)
beginNewURLNote1
(
- long publicationID,
- long collectionID
)
beginViewCollectionItemTextNote1
(
- long publicationID,
- long collectionItemID
)
endEditCollection1
(
- int useCaseInstanceID
)
endEditCollectionItem1
(
- int useCaseInstanceID
)
endNewCollection1
(
- int useCaseInstanceID
)
endNewCollectionFile1
(
- int useCaseInstanceID,
- list([collectionItemNameUploadIDs, …])
)
endNewTextNote1
(
- int useCaseInstanceID
)
endNewURLNote1
(
- int useCaseInstanceID
)
endViewCollectionItemTextNote1
(
- int useCaseInstanceID
)
handleDialog1
(
- int useCaseInstanceID,
- string clientResponseXML
)
handleMessage1
(
- int useCaseInstanceID,
- int buttonID
)

http://localhost:8080/K4/services/CommonBasic

checkCompatibility
(
- list([apiVersion, …]?)
)
initialize1
(
- clientInitializeData1 clientInitializeData1
)
setClientPrefs1
(
- clientPrefs1 clientPrefs1
)

http://localhost:8080/K4/services/K4ObjectBasic

beginSetPreferredDesign1
(
- long publicationID,
- long wfObjectVariantID
)
endSetPreferredDesign1
(
- int useCaseInstanceID
)
getAllPagePicsByLayouts1
(
- long publicationID,
- list([long k4ObjectVariantIDs, …]?),
- int previewType,
- int previewVersionType,
- boolean firstVariant
)
getAllPagePicsWithTypesByLayouts1
(
- long publicationID,
- list([long k4ObjectVariantIDs, …]?),
- long VariantID,
- boolean followDefaultChain
)
getAssetsFoldersByPublicationID1
(
- long publicationID
)
getGeoInfos1
(
- long publicationID,
- list([long k4ObjectVariantIDs, …]?)
)
getPagePicsByLayouts1
(
- long publicationID,
- list([long k4ObjectVariantIDs, …]?),
- long previewVariantID,
- int previewType,
- int previewVersionType,
- boolean followDefaultChain
)
getPagePicsByPages1
(
- long publicationID,
- list([long pageID, …]?)
)
getPagePicsBySpread1
(
- long publicationID,
- long k4ObjectVariantID,
- long previewVariantID,
- int spreadIndex,
- int previewType,
- int previewVersionType,
- boolean followDefaultChain
)
getPagePicsContents1
(
- long publicationID,
- list([long pagePicsContentIDs, …]?)
)
getParents1
(
- long publicationID,
- list([long k4ObjectVariantIDs, …]?),
- list([long collectionIDs, …]?),
- list([long collectionItemIDs, …]?),
- boolean withNames
)
getRegisteredCollectionFileUploadURL1
(
- int useCaseInstanceID,
- string extension,
- string contentVersion
)
getRegisteredContentUploadURL1
(
- int useCaseInstanceID,
- string extension,
- string contentVersion
)
getRegisteredPreviewUploadURL1
(
- int useCaseInstanceID,
- string extension
)
getRegisteredThumbnailUploadURL1
(
- int useCaseInstanceID,
- string extension
)
getVariantsByPublicationID1
(
- long publicationID
)
logEventGeometryConversion1
(
- long publicationID,
- long objectVariantID,
- long geometryPSFileID,
- string newContentVersion
)
logEventObjectVariantConversion1
(
- long publicationID,
- long objectVariantID,
- string newContentVersion
)

http://localhost:8080/K4/services/PublicationBasic

addToWatchlist1
(
- int watchlistID,
- list([long objectIDs, …]?)
)
createGeneralWatchlist1
(
- long publicationID,
- int type
)
createSpecificWatchlist1
(
- long publicationID,
- int type,
- list([long objectIDs, …]?)
)
deleteWatchlist1
(
- int watchlistID
)
getChangedWatchlists1
()
getCustomTerminologyByPublication1
(
- long publicationID
)
getIssuesByPublicationID1
(
- long publicationID
)
getMetaDataDefsByPublicationID1
(
- long publicationID
)
getPublication1
(
- long publicationID
)
getPublicationIDs1
()
getPublicationSettingsByPublicationID1
(
- long publicationID
)
getRenditionsByPublicationID1
(
- long publicationID
)
getSectionsByPublicationID1
(
- long publicationID
)
getWatchlistChanges1
(
- int watchlistID
)
removeFromWatchlist1
(
- int watchlistID,
- list([long objectIDs, …]?)
)
resetWatchlistChanges1
(
- int watchlistID
)

http://localhost:8080/K4/services/QueryBasic

beginCSVExport1
(
- long publicationID,
- int queryResultID,
- list([csvExpandedObjects, …]),
- string columnSettingContent,
- boolean expandChildrens,
- boolean expandTasks
)
beginDeleteQuery1
(
- long publicationID,
- long queryID,
- boolean allowUI
)
continueCSVExport1
(
- int useCaseInstanceID
)
createQueryResult1
(
- long publicationID,
- long queryID,
- string queryFilter,
- string fullTextSearchQuery,
- list([int returnTypes, …]?),
- boolean withCollections,
- int withMetaData,
- string sortCriteria,
- int resultStartIndex,
- int resultEndIndex,
- list([anchorItems, …]?),
- list([long expandedWFObjectIDs, …]?),
- list([long expandedCollectionIDs, …]?)
)
createSimpleQueryResult1
(
- long publicationID,
- long issueID,
- long sectionID,
- long wfDefinitionOriginalID,
- long outputChannelOriginalID,
- long statusOriginalID,
- string name,
- string queryFilter,
- string fullTextSearchQuery,
- list([int returnTypes, …]?),
- boolean withCollections,
- int withMetaData,
- string sortCriteria,
- int resultStartIndex,
- int resultEndIndex,
- list([anchorItems, …]?),
- list([long expandedWFObjectIDs, …]?),
- list([long expandedCollectionIDs, …]?)
)
deleteQueryResult1
(
- int querytResultID
)
endCSVExport1
(
- int useCaseInstanceID
)
endDeleteQuery1
(
- int useCaseInstanceID
)
getCollectionItems1
(
- long publicationID,
- long collectionID
)
getQueriesByPublicationID1
(
- long publicationID
)
getQueryAllPublicationsObjects1
(
- string queryName,
- string queryFilter,
- string fullTextSearchQuery,
- list([int returnTypes, …]?),
- boolean withCollections,
- int withMetaData,
- int maxNumberReturnObjects
)
getQueryObjects1
(
- long publicationID,
- long queryID,
- string queryFilter,
- string fullTextSearchQuery,
- list([int returnTypes, …]?),
- boolean withCollections,
- int withMetaData,
- int maxNumberReturnObjects
)
getQueryResult1
(
- int queryResultID,
- int resultStartIndex,
- int resultEndIndex
)
getQueryResultByIDs1
(
- int queryResultID,
- list([long selectedWFObjectVariantIDs, …]?),
- list([long selectedCollectionIDs, …]?)
)
getSimpleQueryObjects1
(
- long publicationID,
- long issueID,
- long sectionID,
- long wfDefinitionOriginalID,
- long outputChannelOriginalID,
- long statusOriginalID,
- string name,
- string queryFilter,
- string fullTextSearchQuery,
- list([int returnTypes, …]?),
- boolean withCollections,
- int withMetaData,
- int maxNumberReturnObjects
)
handleMessage1
(
- int useCaseInstanceID,
- int buttonID
)

http://localhost:8080/K4/services/QueryUI

beginCSVExport1
(
- long publicationID,
- int queryResultID,
- list([csvExpandedObjects, …]),
- string columnSettingContent
)
beginQueryEditor1
(
- long publicationID,
- int operationMode,
- long queryID
)
beginShowContextOfFullTextSearchResult1
(
- long publicationID,
- list([objectIDWithTypes, …]),
- string fullTextSearchQuery
)
continueCSVExport1
(
- int useCaseInstanceID
)
endCSVExport1
(
- int useCaseInstanceID
)
endQueryEditor1
(
- int useCaseInstanceID
)
endShowContextOfFullTextSearchResult1
(
- int useCaseInstanceID
)
handleDialog1
(
- int useCaseInstanceID,
- string clientResponseXML
)
handleMessage1
(
- int useCaseInstanceID,
- int buttonID
)

http://localhost:8080/K4/services/UserBasic

beginChangePassword1
(
- string oldPassword,
- string newPassword
)
beginLogInAllPublications1
(
- string domain,
- string userName,
- string password
)
beginLogInOnePublication1
(
- long publicationID,
- string domain,
- string userName,
- string password
)
cleanupUseCase1
(
- int useCaseInstanceID
)
endChangePassword1
(
- int useCaseInstanceID
)
endLogIn1
(
- int useCaseInstanceID
)
getButtonBar1
(
- long publicationID
)
getColumnSettingsByPublicationID1
(
- long publicationID
)
getGroupsByPublicationID1
(
- long publicationID
)
getLoginData1
(
)
getPasswordRules1
(
)
getUserCustomMetaData1
(
- long publicationID,
- list([long userIDs, …]?)
)
getUsersByPublicationID1
(
- long publicationID
)
getWorkspacesByPublicationID1
(
- long publicationID
)
isLoggedIn1
(
)
log1
(
- long publicationID,
- int logEventType,
- list([string parameters, …])
)
logOutPublication1
(
- long publicationID
)
useLicense1
(
- long publicationID,
- int productType,
- string checkValue
)

http://localhost:8080/K4/services/UserUI

beginChangePasswordDialog1
(
- list([string ruleXMLs, …]?)
)
beginColumnSettingEditor1
(
- long publicationID,
- long columnSettingID,
- int operationMode,
- int usageType,
- string content
)
beginDeleteColumnSetting1
(
- long publicationID,
- long columnSettingID
)
beginDeleteWorkspace1
(
- long publicationID,
- long workspaceID
)
beginLogInDialog1
(
- long publicationID,
- string publicationName,
- boolean useDomain,
- string domain,
- string userName
)
beginSelectPublicationDialog1
(
- list([publicationInformation, …]?)
)
beginUserPreference1
(
- long publicationID
)
beginWorkspaceEditor1
(
- long publicationID,
- long workspaceID,
- int operationMode
)
continueDeleteWorkspace1
(
- int useCaseInstanceID
)
continueWorkspaceEditor1
(
- int useCaseInstanceID
)
endChangePasswordDialog1
(
- int useCaseInstanceID
)
endColumnSettingEditor1
(
- int useCaseInstanceID
)
endDeleteColumnSetting1
(
- int useCaseInstanceID
)
endDeleteWorkspace1
(
- int useCaseInstanceID
)
endLogInDialog1
(
- int useCaseInstanceID
)
endSelectPublicationDialog1
(
- int useCaseInstanceID
)
endUserPreference1
(
- int useCaseInstanceID
)
endWorkspaceEditor1
(
- int useCaseInstanceID,
- string content,
- string contentVersion
)
handleDialog1
(
- int useCaseInstanceID,
- string clientResponseXML
)
handleMessage1
(
- int useCaseInstanceID,
- int buttonID
)

http://localhost:8080/K4/services/WorkflowBasic

addArticleToStartWorkflowBasic1
(
- int useCaseInstanceID
)
addGeometryToStartWorkflow1
(
- int useCaseInstanceID,
- objectFileUploadData1 objectFileUploadData
)
addObjectReferenceToStartWorkflow1
(
- int useCaseInstanceID,
- int k4ObjectType,
- string name,
- long newObjectID,
- long wfObjectVariantTemplateID
)
addObjectToStartWorkflow1
(
- int useCaseInstanceID,
- int k4ObjectType,
- objectFileUploadData1 objectFileUploadData,
- long newObjectID,
- int insertDirection,
- long targetChildObjectID
)
addObjectToStartWorkflowForOtherWFChannel1
(
- int useCaseInstanceID,
- objectFileUploadData1 objectFileUploadData
)
addStickyNote1
(
- long publicationID,
- long wfObjectVariantID,
- double x,
- double y,
- int pointerOrientation,
- int k4PageID,
- int clientID
)
addTextObjectToStartWorkflowForArticleVariant1
(
- int useCaseInstanceID,
- objectFileUploadData1 objectFileUploadData,
- long newObjectID,
- long originTextObjectVariantID
)
appendStickyNoteEntry1
(
- long publicationID,
- long stickyNoteID,
- string text
)
beginAcceptTask1
(
- long publicationID,
- list([long taskInstanceIDs, …]?),
- list([long otherAcceptedTasks, …]?),
- boolean allowUI
)
beginAttachTo1
(
- long publicationID,
- long parentID,
- int parentType,
- long childID,
- int childType,
- int insertDirection,
- long targetChildObjectID,
- int targetChildObjectType,
- boolean allowUI
)
beginCreateMissingVariantOfTextObject1
(
- long publicationID,
- long k4ObjectID,
- long variantID
)
beginDeleteStickyNote1
(
- long publicationID,
- long stickyNoteID,
- boolean allowUI
)
beginDetachFrom1
(
- long publicationID,
- long parentID,
- int parentType,
- long childID,
- int childType,
- boolean allowUI
)
beginFinishTask1
(
- long publicationID,
- list([long taskInstanceIDs, …]?),
- boolean mayAcceptNextViewEditTasks,
- list([objectMetaData, …]?),
- list([objectRuleMatchesData, …]?),
- list([placedObjectData, …]?),
- list([anchorHosts, …]?),
- string comment,
- boolean otherFile
)
beginIDSUpload1
(
- long publicationID
)
beginLinkTextObjectToOtherObject1
(
- long publicationID,
- long objectID,
- long otherObjectID,
- int insertDirection,
- long targetChildObjectID
)
beginMoveTo1
(
- long publicationID,
- long sourceParentID,
- int sourceParentType,
- long targetParentID,
- int targetParentType,
- long childID,
- int childType,
- int insertDirection,
- long targetChildID,
- int targetChildType,
- boolean allowUI
)
beginPagePics1
(
- long publicationID,
- long wfObjectVariantID,
- int fileVersionIndex
)
beginSaveVersion1
(
- long publicationID,
- list([long taskInstanceIDs, …]?),
- list([objectMetaData, …]?),
- list([objectRuleMatchesData, …]?),
- list([placedObjectData, …]?),
- list([anchorHosts, …]?),
- string comment
)
beginStartWorkflowForAdditionalTextObjects1
(
- long publicationID,
- long articleWFObjectVariantID,
- startWorkflowData1 startWorkflowData1,
- list([anchorHosts, …]?)
)
beginStartWorkflowForArticleVariant1
(
- long publicationID,
- long originWFObjectVariantID,
- startWorkflowData1 startWorkflowData
)
beginStartWorkflowForNewDesign1
(
- long publicationID,
- long wfObjectVariantID,
- startWorkflowData1 startWorkflowData1
)
beginStartWorkflowForOtherVariant1
(
- long publicationID,
- long wfObjectVariantID,
- startWorkflowData1 startWorkflowData1
)
beginStartWorkflowForOtherWFChannel1
(
- long publicationID,
- long wfObjectVariantID,
- startWorkflowData1 startWorkflowData1
)
beginStartWorkflowForPlacedObject1
(
- long publicationID,
- long relatedWFObjectVariantID,
- startWorkflowData1 startWorkflowData1,
- list([anchorHosts, …]?)
)
beginStartWorkflowForUnplacedArticleOrLayout1
(
- long publicationID,
- startWorkflowData1 startWorkflowData1,
- list([anchorHosts, …]?)
)
beginStartWorkflowForUnplacedOtherObject1
(
- long publicationID,
- startWorkflowData1 startWorkflowData1
)
beginTriggerIndependentAutomatedTask1
(
- long publicationID,
- list([long taskInstanceIDs, …]?),
- boolean allowUI
)
beginUndoAcceptTask1
(
- long publicationID,
- long wfObjectVariantID,
- list([long taskInstanceIDs, …]?),
- list([long containedTaskInstanceIDs, …]?),
- boolean allowUI
)
beginUnlinkTextObjectOfOtherObject1
(
- long publicationID,
- long objectID,
- long otherObjectID,
- int insertDirection,
- long targetChildObjectID
)
beginView1
(
- long publicationID,
- long wfObjectVariantID,
- boolean allowUI
)
beginWithdrawTask1
(
- long publicationID,
- long wfObjectVariantID,
- list([long taskInstanceIDs, …]?),
- boolean allowUI
)
beginXMLExporter1
(
- long publicationID
)
continueAcceptTask1
(
- int useCaseInstanceID
)
continueFinishTask1
(
- int useCaseInstanceID
)
continueSaveVersion1
(
- int useCaseInstanceID
)
continueStartWorkflow1
(
- int useCaseInstanceID
)
continueStartWorkflowForArticleVariant1
(
- int useCaseInstanceID
)
continueStartWorkflowForNewDesign1
(
- int useCaseInstanceID
)
continueStartWorkflowForOtherVariant1
(
- int useCaseInstanceID
)
continueStartWorkflowForOtherWFChannel1
(
- int useCaseInstanceID
)
continueView1
(
- int useCaseInstanceID
)
continueXMLExporter1
(
- int useCaseInstanceID
)
createFileNameForWFObjectVariant1
(
- long publicationID,
- long wfObjectVariantID,
- long fileOrObjectVersionIndex
)
deleteObjectRule1
(
- long publicationID,
- long wfObjectVariantID,
- int type,
- long destWFObjectVariantID
)
endAcceptTask1
(
- int useCaseInstanceID
)
endAttachTo1
(
- int useCaseInstanceID
)
endCreateMissingVariantOfTextObject1
(
- int useCaseInstanceID
)
endDeleteStickyNote1
(
- int useCaseInstanceID
)
endDetachFrom1
(
- int useCaseInstanceID
)
endFinishTask1
(
- int useCaseInstanceID
)
endIDSUpload1
(
- int useCaseInstanceID
)
endLinkTextObjectToOtherObject1
(
- int useCaseInstanceID
)
endMoveTo1
(
- int useCaseInstanceID
)
endPagePics1
(
- int useCaseInstanceID
)
endSaveVersion1
(
- int useCaseInstanceID
)
endStartWorkflow1
(
- int useCaseInstanceID
)
endStartWorkflowForArticleVariant1
(
- int useCaseInstanceID
)
endStartWorkflowForNewDesign1
(
- int useCaseInstanceID
)
endStartWorkflowForOtherVariant1
(
- int useCaseInstanceID
)
endStartWorkflowForOtherWFChannel1
(
- int useCaseInstanceID
)
endTriggerIndependentAutomatedTask1
(
- int useCaseInstanceID
)
endUndoAcceptTask1
(
- int useCaseInstanceID
)
endUnlinkTextObjectOfOtherObject1
(
- int useCaseInstanceID
)
endView1
(
- int useCaseInstanceID
)
endWithdrawTask1
(
- int useCaseInstanceID
)
endXMLExporter1
(
- int useCaseInstanceID
)
getAcceptTaskTokenInfo1
(
- long publicationID,
- string acceptTaskToken
)
getAcceptableIndependentTaskInstances1
(
- long publicationID,
- long wfObjectVariantID
)
getAdditionalInfoForWFObjectVariant1
(
- long publicationID,
- list([long wfObjectVariantID, …]?)
)
getAllParentLayoutsOfPlacedInObject1
(
- long publicationID,
- long wfObjectVariantID,
- int withMetaData
)
getAvailableInfoForWFObjectVariants1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?),
- int withMetaData
)
getCaptionTemplates1
(
- long publicationID
)
getChangeRightsForTaskInstances1
(
- long publicationID,
- list([long taskInstanceIDs, …]?)
)
getChangedStickyNoteIDs1
(
- long publicationID,
- long wfObjectVariantID
)
getChildren1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?),
- list([long collectionIDs, …]?),
- int withMetaData
)
getChildrenAsNodes1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?),
- list([long collectionIDs, …]?),
- int withMetaData
)
getContentVersion1
(
- long publicationID,
- long wfObjectVariantID
)
getCreditTemplates1
(
- long publicationID
)
getCurrentLoadableWFObjectVariantFile1
(
- long publicationID,
- long wfObjectVariantID,
- int clientFileVersion
)
getExistingVariantsOfK4Objects1
(
- long publicationID,
- list([long k4ObjectIDs, …]?)
)
getFileInfo1
(
- long publicationID,
- long wfObjectVariantID,
- int fileVersionIndex
)
getInitializableWorkflowsByFileExtension1
(
- long publicationID,
- string fileExtension
)
getLayoutStickyNotes1
(
- long publicationID,
- long wfObjectVariantID
)
getLayoutsStickyNotes1
(
- long publicationID,
- list([long wfObjectVariantID, …]?)
)
getLoadableWFObjectVariantFile1
(
- long publicationID,
- long wfObjectVariantID,
- int version
)
getNewAssignedObjects1
(
- long publicationID
)
getObjectRuleData1
(
- long publicationID,
- long wfObjectVariantID,
- int type,
- long destWFObjectVariantID
)
getObjectRules1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?)
)
getObjectsIsAttachtedTo1
(
- long publicationID,
- long k4ObjectID
)
getOtherWFChannelsForStartWFBasic1
(
- long publicationID,
- long wfDefinitionID,
- long wfChannelID
)
getOutputChannelsByPublicationID1
(
- long publicationID
)
getPlacedWFObjectVariantFile1
(
- long publicationID,
- long parentWFObjectVariantID,
- long placedWFObjectVariantID,
- int placedVersion
)
getPreviewsByWFObjectVariantIDs1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?),
- boolean preferPagePic
)
getStartWFAndTemplateRights1
(
- long publicationID,
- boolean allowLayout,
- list([string allowArticleExtensions, …]?),
- boolean allowOther
)
getStatusesByPublicationID1
(
- long publicationID
)
getStickyNote1
(
- long publicationID,
- long stickyNoteID
)
getTaskDocEditRight1
(
- long publicationID,
- long taskID
)
getTaskInstancesByIDs1
(
- long publicationID,
- list([long taskInstanceID, …]?)
)
getTaskInstancesByWFObjectVariantIDs1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?)
)
getTaskMetaDataUsages1
(
- long publicationID,
- long taskID
)
getTasksByAcceptTaskToken1
(
- long publicationID,
- string acceptTaskToken
)
getTasksByPublicationID1
(
- long publicationID
)
getThumbnailsByWFObjectVariantIDs1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?)
)
getUniqueName1
(
- long publicationID,
- long wfDefinitionID,
- startWorkflowData1 StartWorkflowData
)
getWFChannelsByPublicationID1
(
- long publicationID
)
getWFDefinitionsByPublicationID1
(
- long publicationID
)
getWFObjectVariantByID1
(
- long publicationID,
- long wfObjectVariantID,
- int withMetaData
)
getWFObjectVariantByTaskInstanceID1
(
- long publicationID,
- long taskInstanceID,
- int withMetaData
)
getWFObjectVariantGeometryFile1
(
- long publicationID,
- long wfObjectVariantID,
- long layoutID,
- int clientFileVersion
)
getWFObjectVariantParents1
(
- long publicationID,
- long wfObjectVariantID,
- int withMetaData
)
getWFObjectVariantsByIDs1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?),
- int withMetaData
)
getWFObjectVariantsByK4ObjectIDs1
(
- long publicationID,
- long variantID,
- list([long k4ObjectIDs, …]?),
- int withMetaData,
- boolean followDefaultChain
)
handleMessage1
(
- int useCaseInstanceID,
- int buttonID
)
hasStartWFRight1
(
- long publicationID,
- long wfChannelID
)
isAllowedToStartWorkflow1
(
- long publicationID,
- long wfChannelID,
- long sectionID
)
isMustCleanupPSFile1
(
- long publicationID,
- long wfObjectVariantID
)
setAllGeoInfoForFinishTask1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- int numSpreads,
- int numPages,
- list([pages, …]?),
- list([frames, …]?),
- boolean rightToLeft
)
setAllGeoInfoForPagePic1
(
- int useCaseInstanceID,
- int numSpreads,
- int numPages,
- list([pages, …]?),
- list([frames, …]?),
- boolean rightToLeft
)
setAllGeoInfoForSaveVersion1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- int numSpreads,
- int numPages,
- list([pages, …]?),
- list([frames, …]?),
- boolean rightToLeft
)
setAllGeoInfoForStartWorkflow1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- int numSpreads,
- int numPages,
- list([pages, …]?),
- list([frames, …]?),
- boolean rightToLeft
)
setDesignNameForFinishTask1
(
- int useCaseInstanceID,
- string designName
)
setFileForFinishTask1
(
- int useCaseInstanceID,
- string filepath
)
setIssueForFinishTask1
(
- int useCaseInstanceID,
- string name
)
setLayoutPagePicDone1
(
- int useCaseInstanceID
)
setNameForFinishTask1
(
- int useCaseInstanceID,
- string name
)
setNoteForFinishTask1
(
- int useCaseInstanceID,
- string note
)
setObjectMetaDataForLayout1
(
- int useCaseInstanceID,
- list([objectMetaData, …]?)
)
setObjectRule1
(
- long publicationID,
- long wfObjectVariantID,
- int type,
- int handlerID,
- long destK4ObjectVariantID,
- string data,
- string description,
- boolean matches
)
setPagePicContentOfLayout1
(
- int useCaseInstanceID,
- long variantID,
- base64Binary content,
- int height,
- int width,
- int dpi,
- int previewVersionType
)
setPagePicContentOfPage1
(
- int useCaseInstanceID,
- int k4PageID,
- int previewType,
- long variantID,
- base64Binary content,
- int height,
- int width,
- int dpi,
- int previewVersionType
)
setPredictionPagePicDone1
(
- int useCaseInstanceID,
- int PredictionState
)
setSectionForFinishTask1
(
- int useCaseInstanceID,
- string name
)
setStickyNotePositionAttributes1
(
- long publicationID,
- long stickyNoteID,
- double x,
- double y,
- int pointerOrientation,
- int k4PageID
)
setVariantForFinishTask1
(
- int useCaseInstanceID,
- string name
)
setXMP1
(
- int useCaseInstanceID,
- xmpData1 xmpData
)
storeObjectForFinishTask1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- objectFileUploadData1 objectFileUploadData
)
storeObjectForIDSUpload1
(
- int useCaseInstanceID,
- objectFileUploadData1 objectFileUploadData,
- string type
)
storeObjectForSaveVersion1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- objectFileUploadData1 objectFileUploadData
)
updateFTMetaData1
(
- int useCaseInstanceID,
- list([MetaData1s, …]?)
)
updateFTNextTask1
(
- int useCaseInstanceID,
- finishTaskResult1 finishTaskResult1
)
updateSWFMetaData1
(
- int useCaseInstanceID,
- list([MetaData1s, …]?)
)
updateSWFNextTask1
(
- int useCaseInstanceID,
- list([nextTaskResult1, …]?)
)
useGeometry1
(
- long publicationID,
- long psFileID,
- list([long taskInstanceIDs, …]?)
)

http://localhost:8080/K4/services/WorkflowUI

addArticleToStartWorkflow1
(
- int useCaseInstanceID
)
addGeometryToStartWorkflow1
(
- int useCaseInstanceID,
- objectFileUploadData1 objectFileUploadData
)
addObjectToStartWorkflow1
(
- int useCaseInstanceID,
- int k4ObjectType,
- objectFileUploadData1 objectFileUploadData,
- long newObjectID,
- int insertDirection,
- long targetChildObjectID
)
addObjectToStartWorkflowForOtherWFChannel1
(
- int useCaseInstanceID,
- objectFileUploadData1 objectFileUploadData
)
beginAcceptTaskForToken1
(
- long publicationID,
- string acceptTaskToken,
- string userName,
- int allowedDocTypes
)
beginBatchAcceptIndependentTasks1
(
- long publicationID,
- list([wfObjectVariantIDsWithOtherAcceptedTaskInstanceIDs, …]),
- list([int clientCapabilities, …]?),
- boolean extended
)
beginControlTasks1
(
- long publicationID,
- long wfObjectVariantID
)
beginFinishTask1
(
- long publicationID,
- list([long finishTaskInstanceIDs, …]?),
- list([long continueTaskInstanceIDs, …]?),
- boolean mayAcceptNextViewEditTasks,
- list([objectMetaData, …]?),
- list([objectRuleMatchesData, …]?),
- list([placedObjectData, …]?),
- list([anchorHosts, …]?),
- boolean cancelUndoAcceptTask,
- string comment
)
beginFinishTaskForSimpleUI1
(
- long publicationID,
- list([long finishTaskInstanceIDs, …]?),
- list([long workLaterTaskInstances, …]?),
- boolean mayAcceptNextViewEditTasks,
- list([objectMetaData, …]?),
- list([objectRuleMatchesData, …]?),
- list([placedObjectData, …]?),
- list([anchorHosts, …]?),
- boolean cancelUndoAcceptTask,
- string comment
)
beginHistory1
(
- long publicationID,
- long wfObjectVariantID,
- int revisionManagerAvailableMode,
- boolean allowView
)
beginIndividualValuesDialog1
(
- int useCaseInstanceID,
- int elementID
)
beginNewFromTemplate1
(
- long publicationID,
- boolean allowLayouts,
- list([string allowArticleExtentions, …]?),
- boolean allowOthers
)
beginPreview1
(
- long publicationID,
- list([long wfObjectVariantIDs, …]?),
- list([long collectionItemIDs, …]?)
)
beginSaveVersion1
(
- long publicationID,
- list([long taskInstanceIDs, …]?),
- list([objectMetaData, …]?),
- list([objectRuleMatchesData, …]?),
- list([placedObjectData, …]?),
- list([anchorHosts, …]?),
- string comment
)
beginSelectGeometry1
(
- long publicationID,
- long wfObjectVariantID,
- long objectVersionIndex,
- int selectGeometryMode
)
beginSelectTemplateForObject1
(
- long publicationID,
- long wfObjectVariantID
)
beginShowVersionNotes1
(
- long publicationID,
- long wfObjectVariantID
)
beginStartWorkflowForAdditionalTextObjects1
(
- long publicationID,
- long articleWFObjectVariantID,
- list([objectMetaData, …]?),
- list([anchorHosts, …]?)
)
beginStartWorkflowForCollectionItem1
(
- long publicationID,
- list([long collectionItemIDs, …]?)
)
beginStartWorkflowForNewDesign1
(
- long publicationID,
- long wfObjectVariantID
)
beginStartWorkflowForOtherVariant1
(
- long publicationID,
- long wfObjectVariantID
)
beginStartWorkflowForOtherWFChannel1
(
- long publicationID,
- long wfObjectVariantID
)
beginStartWorkflowForPlacedObject1
(
- long publicationID,
- string objectName,
- string fileExtension,
- long relatedWFObjectVariantID,
- list([objectMetaData, …]?),
- list([anchorHosts, …]?)
)
beginStartWorkflowForUnplacedArticleOrLayout1
(
- long publicationID,
- string objectName,
- string fileExtension,
- list([objectMetaData, …]?),
- list([anchorHosts, …]?)
)
beginStartWorkflowForUnplacedOtherObject1
(
- long publicationID
)
beginSwitchGeometry1
(
- long publicationID,
- long wfObjectVariantID,
- long objectVersionIndex,
- long geometryID,
- int selectGeometryMode
)
beginSwitchVariantForAllObjects1
(
- long publicationID
)
beginSwitchVariantForK4Object1
(
- long publicationID,
- long k4ObjectID
)
beginSwitchVariantForWFObjectVariant1
(
- long publicationID,
- long k4ObjectVariantID
)
continueBatchAcceptIndependentTasks1
(
- int useCaseInstanceID
)
continueFinishTask1
(
- int useCaseInstanceID
)
continueHistory1
(
- int useCaseInstanceID
)
continueIndividualValuesDialog1
(
- int useCaseInstanceID
)
continueSaveVersion1
(
- int useCaseInstanceID
)
continueStartWorkflow1
(
- int useCaseInstanceID
)
continueStartWorkflowForNewDesign1
(
- int useCaseInstanceID
)
continueStartWorkflowForOtherWFChannel1
(
- int useCaseInstanceID
)
endAcceptTaskForToken1
(
- int useCaseInstanceID
)
endBatchAcceptIndependentTasks1
(
- int useCaseInstanceID
)
endControlTasks1
(
- int useCaseInstanceID
)
endFinishTask1
(
- int useCaseInstanceID
)
endHistory1
(
- int useCaseInstanceID
)
endIndividualValuesDialog1
(
- int useCaseInstanceID
)
endNewFromTemplate1
(
- int useCaseInstanceID
)
endPreview1
(
- int useCaseInstanceID
)
endSaveVersion1
(
- int useCaseInstanceID
)
endSelectGeometry1
(
- int useCaseInstanceID
)
endSelectTemplateForObject1
(
- int useCaseInstanceID
)
endShowVersionNotes1
(
- int useCaseInstanceID
)
endStartWorkflow1
(
- int useCaseInstanceID
)
endStartWorkflowForCollectionItem1
(
- int useCaseInstanceID
)
endStartWorkflowForNewDesign1
(
- int useCaseInstanceID
)
endStartWorkflowForOtherVariant1
(
- int useCaseInstanceID
)
endStartWorkflowForOtherWFChannel1
(
- int useCaseInstanceID
)
endSwitchGeometry1
(
- int useCaseInstanceID
)
endSwitchVariantForAllObjects1
(
- int useCaseInstanceID
)
endSwitchVariantForK4Object1
(
- int useCaseInstanceID
)
endSwitchVariantForWFObjectVariant1
(
- int useCaseInstanceID
)
handleDialog1
(
- int useCaseInstanceID,
- string clientResponseXML
)
handleMessage1
(
- int useCaseInstanceID,
- int buttonID
)
setAllGeoInfoForFinishTask1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- int numSpreads,
- int numPages,
- list([pages, …]?),
- list([frames, …]?),
- boolean rightToLeft
)
setAllGeoInfoForSaveVersion1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- int numSpreads,
- int numPages,
- list([pages, …]?),
- list([frames, …]?),
- boolean rightToLeft
)
setAllGeoInfoForStartWorkflow1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- int numSpreads,
- int numPages,
- list([pages, …]?),
- list([frames, …]?),
- boolean rightToLeft
)
setXMPForUI1
(
- int useCaseInstanceID,
- list([xmpData, …]?)
)
storeObjectForFinishTask1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- objectFileUploadData1 objectFileUploadData
)
storeObjectForSaveVersion1
(
- int useCaseInstanceID,
- long wfObjectVariantID,
- objectFileUploadData1 objectFileUploadData
)

AdminBasicAPI

CollectionBasicAPI

CollectionUIAPI

CommonBasicAPI

K4ObjectAPI

PublicationAPI

QueryBasicAPI

QueryUIAPI

UserBasicAPI

UserUIAPI

WorkflowBasicAPI

WorkflowUIAPI