1/20
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
What's New in This Guide
New and Changed Features for 11
g
Release 1 (11.1.1.8.0)
New and Changed Features for 11
g
Release 1 (11.1.1.7.0)
1
Introduction to Oracle WebCenter Content Services
1.1
Contents
1.2
Oracle WebCenter Content Terminology
2
Using Services
2.1
Overview of Services
2.1.1
Service Requests and Responses
2.1.1.1
Internal Service Requests
2.1.1.2
External Service Requests
2.1.1.3
Request Parameters
2.1.1.4
Date and Time Formatting
2.1.1.5
Case Sensitivity Considerations
2.1.2
Page Retrieval
2.1.3
Search Services
2.1.4
Integration Methods
2.1.5
Calling Services Using Persistent URLs
2.1.6
Customizing Locale Parameters
2.1.7
Forcing Authentication Challenges
2.2
Custom Application Example
2.2.1
Services Called
2.2.2
Private Functions
2.2.3
Sample Code
2.3
Redirecting Template Page for Response Output
2.3.1
Basic Concepts
2.3.2
Creating a HCST Page
2.3.3
Reformatting the Search Results Page
2.3.4
Additional Options
3
Customizing Services
3.1
Service Structure Overview
3.1.1
Name
3.1.2
Attributes
3.1.2.1
Service Class
3.1.2.2
Access Level
3.1.2.3
Template Page
3.1.2.4
Service Type
3.1.2.5
Subjects Notified
3.1.2.6
Error Message
3.1.3
Actions
3.1.3.1
Action Type
3.1.3.2
Action Name
3.1.3.3
Action Parameters
3.1.3.4
Action Control Mask
3.1.3.5
Action Error Message
3.2
Service Example
3.2.1
DOC_INFO Service Definition
3.2.2
DOC_INFO Attributes
3.2.3
DOC_INFO Actions
3.2.3.1
Action 1 Definition and Description
3.2.3.2
Action 2 Definition and Description
3.2.3.3
Action 3 Definition and Description
3.2.3.4
Action 4 Definition and Description
3.2.3.5
Action 5 Definition and Description
3.2.3.6
Action 6 Definition and Description
3.2.3.7
Action 7 Definition and Description
3.2.3.8
Action 8 Definition and Description
3.2.3.9
Action 9 Definition and Description
3.2.3.10
Action 10 Definition and Description
3.2.4
DOC_INFO Template
3.3
Creating a Service Resource
3.3.1
Creating a Custom Service Manually
3.3.2
Define the service in an HTM file
3.3.2.1
Load the service in the custom component HDA file
3.3.3
Creating a Custom Service using Component Wizard
4
Core Content Server Services
4.1
About Core Content Server Services
4.2
General Services (Core Content Server)
4.2.1
ADD_DOC_ACCOUNT
4.2.2
ADD_DOCEXTENSION
4.2.3
ADD_DOCFORMAT
4.2.4
ADD_DOCTYPE
4.2.5
APPLET_DOCINFO
4.2.6
CONFIG_INFO
4.2.7
DELETE_DOC_ACCOUNT
4.2.8
DELETE_DOCEXTENSION
4.2.9
DELETE_DOCFORMAT
4.2.10
DELETE_DOCTYPE
4.2.11
EDIT_DOCEXTENSION
4.2.12
EDIT_DOCFORMAT
4.2.13
EDIT_DOCTYPE
4.2.14
EDIT_TRACE_OPTIONS
4.2.15
GET_DATARESULTSET
4.2.16
GET_DOCEXTENSIONS
4.2.17
GET_DOCFORMATS
4.2.18
GET_DOCTYPES
4.2.19
GET_FIELD_LENGTHS
4.2.20
GET_FILELIST
4.2.21
GET_METADEFS
4.2.22
GET_RESULT_OPTIONS
4.2.23
GET_SYSTEM_AUDIT_INFO
4.2.24
GET_TABLE
4.2.25
GET_USER_METADEFS
4.2.26
JAVA_PROPERTIES
4.2.27
LM_BUILD_WEB_STRING_FILES
4.2.28
LM_LOAD_LAYOUTS
4.2.29
LM_LOAD_LAYOUTS_SUB
4.2.30
LOAD_DOC_ENVIRONMENT
4.2.31
LOGIN
4.2.32
MERGE_TABLE
4.2.33
PING_SERVER
4.2.34
QUERY_DOC_ACCOUNTS
4.2.35
SOAP_FAULT
4.3
Doc Services (Core Content Server)
4.3.1
ASSIGN_DOCINFO_FORM
4.3.2
CACHE_CHECKIN_NEW
4.3.3
CACHE_CHECKIN_SEL
4.3.4
CACHE_SUBMIT_HTML_FORM
4.3.5
CACHE_WORKFLOW_CHECKIN
4.3.6
CHECKIN_ARCHIVE_NO_NOTIFY
4.3.7
CHECKIN_BYNAME
4.3.8
CHECKIN_CONFIRM_FORM
4.3.9
CHECKIN_LIST
4.3.10
CHECKIN_NEW
4.3.11
CHECKIN_NEW_FORM
4.3.12
CHECKIN_NEW_SUB
4.3.13
CHECKIN_SEL
4.3.14
CHECKIN_SEL_FORM
4.3.15
CHECKIN_SEL_SUB
4.3.16
CHECKIN_SIMILAR_FORM
4.3.17
CHECKIN_UNIVERSAL
4.3.18
CHECKOUT
4.3.19
CHECKOUT_BY_NAME
4.3.20
CHECKOUT_OK
4.3.21
CHECKOUT_SUB
4.3.22
CONTINUE_CHECKIN
4.3.23
CONTINUE_SUBMIT_HTML_FORM
4.3.24
COPY_REVISION
4.3.25
CREATE_SUBSCRIPTION_TYPE
4.3.26
DELETE_BYCLASS
4.3.27
DELETE_BYNAME
4.3.28
DELETE_BYREV
4.3.29
DELETE_BYREV_REVISION
4.3.30
DELETE_CHECKIN_CACHE
4.3.31
DELETE_DOC
4.3.32
DELETE_REV
4.3.33
DELETE_REV_EX
4.3.34
DELETE_SUBSCRIPTION_TYPE
4.3.35
DOC_FORMATS_WIZARD
4.3.36
DOC_INFO
4.3.37
DOC_INFO_BY_NAME
4.3.38
DOC_INFO_LATESTRELEASE
4.3.39
DOC_INFO_SIMPLE
4.3.40
DOC_INFO_SIMPLE_BYREV
4.3.41
DOC_SUBS_LIST
4.3.42
EDIT_DOC_FORMATS
4.3.43
FORM_PROCESS
4.3.44
FORM_SUBMIT
4.3.45
GET_CACHED_CHECKIN_INFO
4.3.46
GET_DOC_CONFIG_INFO
4.3.47
GET_DOC_SUBSCRIBERS
4.3.48
GET_DOCUMENT_HISTORY_REPORT
4.3.49
GET_ENVIRONMENT
4.3.50
GET_EXPIRED
4.3.51
GET_PACKAGE_ENVIRONMENT_PAGE
4.3.52
GET_UPDATE_FORM
4.3.53
NOTIFY_INDEXER
4.3.54
ODMA_DOC_INFO_SIMPLE
4.3.55
PACKAGE_ENVIRONMENT
4.3.56
REMOVE_METAFILE_SUB
4.3.57
REPLACE_METAFILE_SUB
4.3.58
RESTORE_REVISION
4.3.59
RESUBMIT_FOR_CONVERSION
4.3.60
REV_HISTORY
4.3.61
SELECTDOC
4.3.62
SUBMIT_HTML_FORM
4.3.63
SUBSCRIBE
4.3.64
SUBSCRIBE_DOC_USER
4.3.65
SUBSCRIBE_EX
4.3.66
SUBSCRIBE_FORM
4.3.67
SUBSCRIPTION_LIST
4.3.68
UNDO_CHECKOUT
4.3.69
UNDO_CHECKOUT_BY_NAME
4.3.70
UNSUBSCRIBE
4.3.71
UNSUBSCRIBE_FORM
4.3.72
UNSUBSCRIBE_FROM_LIST
4.3.73
UNSUBSCRIBE_FROM_LIST_EX
4.3.74
UPDATE_BYREV
4.3.75
UPDATE_DOCINFO
4.3.76
UPDATE_DOCINFO_BYFORM
4.3.77
UPDATE_DOCINFO_BYREV
4.3.78
UPDATE_DOCINFO_METAFILE_BYREV
4.3.79
UPDATE_DOCINFO_STATUS
4.3.80
UPDATE_DOCINFO_SUB
4.3.81
UPDATE_SUBSCRIPTION_NOTIFY
4.3.82
UPDATE_SUBSCRIPTION_TYPE
4.3.83
UPDATE_SUBSCRIPTION_USED
4.3.84
UPDATE_METADATA
4.3.85
VALIDATE_DOCINFO
4.3.86
WORK_IN_PROGRESS
4.4
Doc Profile Services (Core Content Server)
4.4.1
ADD_DOCPROFILE
4.4.2
ADD_DOCRULE
4.4.3
DELETE_DOCPROFILE
4.4.4
DELETE_DOCRULE
4.4.5
DOCPROFILE_PREVIEW
4.4.6
EDIT_DOCPROFILE
4.4.7
EDIT_DOCPROFILE_TRIGGER
4.4.8
EDIT_DOCRULE
4.4.9
GET_DOCPROFILE
4.4.10
GET_DOCPROFILES
4.4.11
GET_DOCRULE
4.4.12
GET_DOCRULES
4.5
File Services (Core Content Server)
4.5.1
ADD_WEB_APP
4.5.2
APPEND_FILE_CACHING_INFO
4.5.3
GET_DYNAMIC_CONVERSION
4.5.4
GET_DYNAMIC_CONVERSION_SUB
4.5.5
GET_DYNAMIC_URL
4.5.6
GET_TEMPLATE_CONVERSIONS
4.5.7
GET_WEB_APP_STATUS
4.5.8
LOAD_RESOURCE_FILE
4.5.9
REMOVE_WEB_APP
4.5.10
SAVE_TEMPLATE_CONVERSIONS
4.6
Indexer Services (Core Content Server)
4.6.1
CANCEL_SEARCH_INDEX
4.6.2
CONTROL_SEARCH_INDEX
4.6.3
GET_FILE
4.6.4
START_SEARCH_INDEX
4.7
Internal Services (Core Content Server)
4.7.1
CANCEL_COMPONENT_INSTALL
4.7.2
CLEAR_SERVER_OUTPUT
4.7.3
DOWNLOAD_COMPONENT
4.7.4
GET_COMPONENT_CONFIG
4.7.5
GET_COMPONENT_INSTALL_FORM
4.7.6
GET_COMPONENT_INSTALL_PROMPTS_FORM
4.7.7
GET_COMPONENT_INSTALL_SETTINGS'
4.7.8
GET_LOCAL_REGISTRATION_FORM
4.7.9
GET_MANIFEST_INFO
4.7.10
GET_SERVER_OUTPUT
4.7.11
PROXIED_REQUEST
4.7.12
UNINSTALL_COMPONENT
4.7.13
UPDATE_COMPONENT_CONFIG
4.7.14
UPDATE_LICENSE
4.7.15
UPLOAD_NEW_COMPONENT
4.8
Meta Services (Core Content Server)
4.8.1
ADD_METADEF
4.8.2
DEL_METADEF
4.8.3
EDIT_METADEF
4.8.4
GET_ADVANCED_SEARCH_OPTIONS
4.8.5
GET_DISPLAY_FIELDS
4.8.6
GET_DOC_METADATA_INFO
4.8.7
GET_OPTION_LIST
4.8.8
GET_USER_METADATA_INFO
4.8.9
MOVE_METADEF
4.8.10
UPDATE_ADVANCED_SEARCH_OPTIONS
4.8.11
UPDATE_USER_META
4.8.12
UPDATE_USER_META_TABLE
4.8.13
UPDATE_META_TABLE
4.8.14
UPDATE_OPTION_LIST
4.9
Miscellaneous Services (Core Content Server)
4.9.1
CHUNKED_UPLOAD
4.9.2
DOWNLOAD_LISTBOX_ITEMS
4.9.3
LOAD_USER_LOCALIZATION
4.10
Page Handler/Page Request Services (Core Content Server)
4.10.1
DELETE_RESULT_TEMPLATE
4.10.2
GET_ADMIN_PAGE
4.10.3
GET_DOC_PAGE
4.10.4
GET_DYNAMIC_PAGE
4.10.5
GET_PERSONALIZED_JAVASCRIPT
4.10.6
GET_PORTAL_PAGE
4.10.7
GET_SECURE_PAGE
4.10.8
LOAD_GLOBALINCLUDES
4.10.9
PAGE_HANDLER
4.10.10
PNE_SAVE_QUERY
4.10.11
PNE_UPDATE_PERSONAL_URLS
4.10.12
PNE_UPDATE_PORTAL_INFO
4.10.13
SAVE_GLOBALINCLUDES
4.10.14
UPDATE_RESULT_TEMPLATE
4.11
Provider Manager Services (Core Content Server)
4.11.1
ADD_EDIT_PROVIDER
4.11.2
APPEND_DATABASE_AUDIT_INFO
4.11.3
DELETE_PROVIDER
4.11.4
ENABLE_DISABLE_PROVIDER
4.11.5
GET_ADD_EDIT_PROVIDER_FORM
4.11.6
GET_ALL_PROVIDERS
4.11.7
GET_PROVIDER_INFO
4.11.8
NOTIFY_CHANGE
4.11.9
REQUEST_SECURITYINFO
4.11.10
TEST_PROVIDER
4.12
Schema Services (Core Content Server)
4.12.1
ADD_SCHEMA_FIELD
4.12.2
ADD_SCHEMA_RELATION
4.12.3
ADD_SCHEMA_VIEW
4.12.4
ADDOREDIT_SCHEMA_TABLE
4.12.5
CONTROL_SCHEMA
4.12.6
DELETE_SCHEMA_FIELD
4.12.7
DELETE_SCHEMA_RELATION
4.12.8
DELETE_SCHEMA_TABLE
4.12.9
DELETE_SCHEMA_VIEW
4.12.10
EDIT_SCHEMA_FIELD
4.12.11
EDIT_SCHEMA_NODE
4.12.12
EDIT_SCHEMA_RELATION
4.12.13
EDIT_SCHEMA_VIEW
4.12.14
EDIT_SCHEMA_VIEW_VALUES
4.12.15
GET_SCHEMA_FIELD_INFO
4.12.16
GET_SCHEMA_FIELDS
4.12.17
GET_SCHEMA_RELATIONS
4.12.18
GET_SCHEMA_STATS
4.12.19
GET_SCHEMA_TABLE_INFO
4.12.20
GET_SCHEMA_TABLES
4.12.21
GET_SCHEMA_VIEW_EDIT_INFO
4.12.22
GET_SCHEMA_VIEW_FRAGMENT
4.12.23
GET_SCHEMA_VIEW_INFO
4.12.24
GET_SCHEMA_VIEW_VALUES
4.12.25
GET_SCHEMA_VIEWS
4.12.26
PUBLISH_SCHEMA
4.13
Search Services (Core Content Server)
4.13.1
APPEND_SEARCH_AUDIT_INFO
4.13.2
GET_EXTERNAL_DOC_INFO
4.13.3
GET_EXTERNAL_HIGHLIGHT_INFO
4.13.4
GET_EXTERNAL_XML_HIGHLIGHT_INFO
4.13.5
GET_HIGHLIGHT_INFO
4.13.6
GET_SEARCH_RESULTS
4.13.7
GET_SEARCH_RESULTS_FORCELOGIN
4.13.8
GET_XML_HIGHLIGHT_INFO
4.13.9
PNE_GET_SEARCH_RESULTS
4.13.10
VIEW_DOC
4.14
User Services (Core Content Server)
4.14.1
ADD_ALIAS
4.14.2
ADD_GROUP
4.14.3
ADD_ROLE
4.14.4
ADD_USER
4.14.5
CHANGE_USER_AUTH_TYPE
4.14.6
CHECK_USER_CREDENTIALS
4.14.7
DELETE_ALIAS
4.14.8
DELETE_GROUP
4.14.9
DELETE_ROLE
4.14.10
DELETE_USER
4.14.11
EDIT_ALIAS
4.14.12
EDIT_GROUP
4.14.13
EDIT_ROLE
4.14.14
EDIT_USER
4.14.15
EDIT_USER_PROFILE
4.14.16
GET_ALIASES
4.14.17
GET_FILTER_ADMIN_PAGE
4.14.18
GET_SELF_REGISTER_PAGE
4.14.19
GET_USERDOCPROFILES
4.14.20
GET_USER_INFO
4.14.21
GET_USERS
4.14.22
LOAD_PNE_PORTAL
4.14.23
LOAD_USER_TOPIC
4.14.24
QUERY_GROUP
4.14.25
QUERY_USER_ATTRIBUTES
4.14.26
REGISTER_USER
4.14.27
SAVE_USER_TOPICS
4.14.28
UPDATE_FILTER_INFO
4.14.29
UPDATE_USEROPTION_LIST
4.15
Collaboration Services (Core Content Server)
4.15.1
ADD_COLLABORATION
4.15.2
ADD_COLLABORATION_FORM
4.15.3
DELETE_COLLABORATION
4.15.4
EDIT_CLBRA_ACCESS_LIST
4.15.5
EDIT_CLBRA_ACCESS_LIST_FORM
4.15.6
EDIT_COLLABORATION
4.15.7
EDIT_COLLABORATION_FORM
4.15.8
GET_CLBRA_DOCUMENTS
4.15.9
GET_CLBRA_INFO
4.15.10
GET_COLLABORATION_LIST
4.15.11
GET_USER_CLBRA_LIST
5
Workflow Services
5.1
About Workflow Services
5.2
Doc and General Services (Workflows)
5.2.1
ADD_PROBLEMREPORT
5.2.2
DELETE_PROBLEMREPORT
5.2.3
GET_CRITERIA_WORKFLOWS_FOR_GROUP
5.2.4
GET_DOCUMENT_PROBLEMREPORTS
5.2.5
GET_PROBLEMREPORTS_SEARCH_FORM
5.2.6
GET_PROBLEMREPORTS_SEARCH_RESULTS
5.2.7
GET_UPDATE_PROBLEMREPORT_FORM
5.2.8
GET_WORKFLOWDOCUMENTS
5.2.9
GET_WORKFLOWS_FOR_ALL
5.2.10
LOAD_WORKFLOW_QUEUE
5.2.11
NOTIFY_CONTRIBUTOR
5.2.12
PROBLEMREPORT_INFO
5.2.13
RESEND_PROBLEMREPORT
5.2.14
REVIEW_WORKFLOW_DOC
5.2.15
UPDATE_PROBLEMREPORT
5.2.16
WORKFLOW_CHECKIN_SUB
5.2.17
WORKFLOW_EDIT_REV
5.2.18
WORKFLOW_NEW_REV
5.2.19
WORKFLOW_REJECT_FORM
5.3
Workflow Template Services
5.3.1
ADD_WF_TEMPLATE
5.3.2
DELETE_WF_TEMPLATE
5.3.3
EDIT_WF_TEMPLATE
5.3.4
GET_WF_TEMPLATE
5.3.5
GET_WF_TEMPLATES
5.4
Workflow Services
5.4.1
ADD_WORKFLOW
5.4.2
ADD_WORKFLOW_SCRIPT
5.4.3
ADD_WORKFLOW_TOKEN
5.4.4
ADD_WORKFLOWALIASES
5.4.5
ADD_WORKFLOWDOCUMENT
5.4.6
ADD_WORKFLOWDOCUMENT_SUB
5.4.7
ADD_WORKFLOWDOCUMENTS
5.4.8
ADD_WORKFLOWSTEP
5.4.9
CRITERIAWORKFLOW_DISABLE
5.4.10
CRITERIAWORKFLOW_DISABLE_SUB
5.4.11
CRITERIAWORKFLOW_ENABLE
5.4.12
DELETE_WFCONTRIBUTORS
5.4.13
DELETE_WORKFLOW
5.4.14
DELETE_WORKFLOW_SCRIPT
5.4.15
DELETE_WORKFLOW_TOKEN
5.4.16
DELETE_WORKFLOWCRITERIA
5.4.17
DELETE_WORKFLOWDOCUMENTS
5.4.18
DELETE_WORKFLOWSTEP
5.4.19
EDIT_WORKFLOW
5.4.20
EDIT_WORKFLOW_SCRIPT
5.4.21
EDIT_WORKFLOW_TOKEN
5.4.22
EDIT_WORKFLOWCRITERIA
5.4.23
EDIT_WORKFLOWSTEP
5.4.24
GET_ACTIVE_WORKFLOWS
5.4.25
GET_ALL_WORKFLOWDOCREVISIONS
5.4.26
GET_CRITERIA_WORKFLOWS_FOR_GROUP
5.4.27
GET_WF_COMPANION_INFO
5.4.28
GET_WORKFLOW
5.4.29
GET_WORKFLOW_INFO
5.4.30
GET_WORKFLOW_INFO_BYNAME
5.4.31
GET_WORKFLOW_SCRIPT
5.4.32
GET_WORKFLOWDOCREVISIONS
5.4.33
GET_WORKFLOWS
5.4.34
TEST_WORKFLOW_SCRIPT
5.4.35
WORKFLOW_APPROVE
5.4.36
WORKFLOW_CANCEL
5.4.37
WORKFLOW_CHECKIN
5.4.38
WORKFLOW_EDIT_APPROVE
5.4.39
WORKFLOW_REJECT
5.4.40
WORKFLOW_START
6
Archive Services
6.1
About Archive Services
6.2
Archive Services
6.2.1
ADD_ARCHIVE
6.2.2
ADD_COLLECTION
6.2.3
ADD_PROXIEDCOLLECTION
6.2.4
CANCEL_ARCHIVE
6.2.5
CHECKIN_ARCHIVE
6.2.6
COPY_ARCHIVE
6.2.7
DELETE_ARCHIVE
6.2.8
DELETE_BATCH_FILE
6.2.9
DELETE_BATCH_FILE_DOCUMENTS
6.2.10
DELETE_BATCH_FILE_TABLES
6.2.11
EDIT_ARCHIVE
6.2.12
EDIT_ARCHIVEDATA
6.2.13
EDIT_EXPORTERS
6.2.14
EDIT_TRANSFEROPTIONS
6.2.15
EXECUTE_BATCH
6.2.16
EXPORT_ARCHIVE
6.2.17
GET_ARCHIVECOLLECTIONS
6.2.18
GET_ARCHIVETABLECONTENT
6.2.19
GET_ARCHIVED_FILE
6.2.20
GET_ARCHIVES
6.2.21
GET_ARCHIVERELATIONQUERY
6.2.22
GET_BATCH_FILE_DOCUMENTS
6.2.23
GET_BATCH_PROPERTIES
6.2.24
GET_BATCH_SCHEMA
6.2.25
GET_BATCH_VALUES
6.2.26
GET_BATCHFILES
6.2.27
GET_PROXIED_ARCHIVECOLLECTIONS
6.2.28
GET_PROXIEDSERVERS
6.2.29
GET_REPLICATION_DATA
6.2.30
GET_TABLECOLUMNLIST
6.2.31
GET_TARGET_INFO
6.2.32
GET_TARGET_TRANSFER_STATUS
6.2.33
GET_TRANSFER_SOURCE_INFO
6.2.34
IMPORT_ARCHIVE
6.2.35
IMPORT_ARCHIVE_START_AUTOMATED
6.2.36
IMPORT_BATCHFILE
6.2.37
IMPORT_DOCUMENT
6.2.38
IMPORT_TABLE_ENTRY
6.2.39
INSERT_NATIVE
6.2.40
INSERT_NEW
6.2.41
REGISTER_IMPORTER
6.2.42
REMOVE_COLLECTION
6.2.43
REMOVE_EXPORTER
6.2.44
REMOVE_IMPORTER
6.2.45
REMOVE_PROXIEDTRANSFER
6.2.46
REMOVE_QUEUED_IMPORT
6.2.47
REMOVE_TRANSFER
6.2.48
REQUEST_TRANSFER
6.2.49
TRANSFER_ARCHIVE
6.2.50
UPDATE_TARGET_TOTALS
6.2.51
UPDATE_TRANSFER_STATUS
6.2.52
UPLOAD_ARCHIVE_TRANSFER
7
Contribution Folders Services
7.1
About Contribution Folders Services
7.2
Contribution Folders Services
7.2.1
COLLECTION_ADD
7.2.2
COLLECTION_ADD_LINK
7.2.3
COLLECTION_BROWSE
7.2.4
COLLECTION_CHECKIN_NEW
7.2.5
COLLECTION_CHECKIN_REVISION
7.2.6
COLLECTION_CHECKIN_SEL_SUB
7.2.7
COLLECTION_COPY_ALL
7.2.8
COLLECTION_COPY_COLLECTION
7.2.9
COLLECTION_COPY_ITEM
7.2.10
COLLECTION_COPY_LOT
7.2.11
COLLECTION_DELETE
7.2.12
COLLECTION_DELETE_ALL
7.2.13
COLLECTION_DELETE_COLLECTION
7.2.14
COLLECTION_DELETE_ITEM
7.2.15
COLLECTION_DELETE_LOT
7.2.16
COLLECTION_DISPLAY
7.2.17
COLLECTION_EDIT
7.2.18
COLLECTION_GET_ADMIN_CONFIG
7.2.19
COLLECTION_GET_ADMIN_INHERIT_CONFIG
7.2.20
COLLECTION_GET_ADMIN_MARKED_CONFIG
7.2.21
COLLECTION_GET_ADMIN_META_CONFIG
7.2.22
COLLECTION_GET_ADMIN_METADATA_DEFAULTS
7.2.23
COLLECTION_GET_ADMIN_MOUNTED_CONFIG
7.2.24
COLLECTION_GET_ARCHIVE
7.2.25
COLLECTION_GET_BRANCH
7.2.26
COLLECTION_GET_COLLECTION
7.2.27
COLLECTION_GET_COLLECTIONS
7.2.28
COLLECTION_GET_CONTENT_FILE
7.2.29
COLLECTION_GET_CONTENTS
7.2.30
COLLECTION_GET_FILE
7.2.31
COLLECTION_GET_INFO
7.2.32
COLLECTION_GET_LINKS
7.2.33
COLLECTION_GET_META_MAPPING
7.2.34
COLLECTION_GET_PROFILE_METADATA_DEFAULTS
7.2.35
COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS
7.2.36
COLLECTION_GET_REFERENCE
7.2.37
COLLECTION_GET_SEARCH_FORM
7.2.38
COLLECTION_GET_SYSTEM_FILE
7.2.39
COLLECTION_GET_USER_CONFIG
7.2.40
COLLECTION_INFO
7.2.41
COLLECTION_ISVALID_META
7.2.42
COLLECTION_LOCK
7.2.43
COLLECTION_MOVE_ALL
7.2.44
COLLECTION_MOVE_COLLECTION
7.2.45
COLLECTION_MOVE_ITEM
7.2.46
COLLECTION_MOVE_LOT
7.2.47
COLLECTION_NEW
7.2.48
COLLECTION_PROFILE_GET_COLUMNS
7.2.49
COLLECTION_PROFILE_UPDATE_COLUMNS
7.2.50
COLLECTION_RESTORE_COLLECTION
7.2.51
COLLECTION_RESTORE_ITEM
7.2.52
COLLECTION_SEARCH_CONTENT
7.2.53
COLLECTION_SEARCH_RESULTS
7.2.54
COLLECTION_SET_ARCHIVE
7.2.55
COLLECTION_SET_USER_CONFIG
7.2.56
COLLECTION_UNLOCK
7.2.57
COLLECTION_UPDATE
7.2.58
COLLECTION_UPDATE_ADMIN_CONFIG
7.2.59
COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG
7.2.60
COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS
7.2.61
COLLECTION_UPDATE_ALL
7.2.62
COLLECTION_UPDATE_ITEM
7.2.63
COLLECTION_UPDATE_META
7.2.64
COLLECTION_UPDATE_META_TABLE
7.2.65
COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS
7.2.66
COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS
7.2.67
COLLECTION_UPDATE_STRUCTURE
7.2.68
COLLECTION_VERIFY_FOLDER_NAME
7.2.69
FOLDERSLOCAL_BUILD_MOUNT
7.2.70
FOLDERSLOCAL_CREATE_MOUNT
7.2.71
FOLDERSLOCAL_DELETE_MOUNT
7.2.72
FOLDERSLOCAL_UPDATE_MOUNT
7.2.73
GET_FOLDER_HISTORY_REPORT
7.2.74
GET_OPTION_LISTS
7.2.75
GOTO_COLLECTION
7.2.76
GOTO_ROOT_COLLECTION
8
Folders Services
8.1
About Folders Services
8.2
Folders Services
8.2.1
FLD_BROWSE
8.2.2
FLD_BROWSE_POPUP
8.2.3
FLD_COPY
8.2.4
FLD_CREATE_FILE
8.2.5
FLD_CREATE_FILE_FORM
8.2.6
FLD_CREATE_FOLDER
8.2.7
FLD_CREATE_FOLDER_FORM
8.2.8
FLD_DELETE
8.2.9
FLD_EDIT_FILE
8.2.10
FLD_EDIT_FILE_FORM
8.2.11
FLD_EDIT_FOLDER
8.2.12
FLD_EDIT_FOLDER_FORM
8.2.13
FLD_EDIT_METADATA_RULES
8.2.14
FLD_EDIT_METADATA_RULES_FORM
8.2.15
FLD_FOLDER_MIGRATION_STATUS
8.2.16
FLD_FOLDER_SEARCH
8.2.17
FLD_FOLDER_SEARCH_FORM
8.2.18
FLD_GET_CHOOSE_DESTINATION_DIALOG
8.2.19
FLD_GET_CREATE_LINK_DIALOG
8.2.20
FLD_GET_CREATE_SHORTCUT_DIALOG
8.2.21
FLD_GET_RENAME_FILE_DIALOG
8.2.22
FLD_GET_RENAME_FOLDER_DIALOG
8.2.23
FLD_INFO
8.2.24
FLD_LOAD_SOFT_LINKS_FOR_DOCUMENT
8.2.25
FLD_MIGRATION_FOLDER_DATA
8.2.26
FLD_MOVE
8.2.27
FLD_PRE_CHECKIN
8.2.28
FLD_PROPAGATE
8.2.29
FLD_PROPAGATE_FORM
8.2.30
FLD_REINDEX_FOLDER_CONTENTS
8.2.31
FLD_RETRIEVE_CHILD_FILES
8.2.32
FLD_RETRIEVE_CHILD_FOLDERS
8.2.33
FLD_SUBSCRIBE
8.2.34
FLD_TEST_USER_CAPABILITIES
8.2.35
FLD_UNSUBSCRIBE
8.2.36
FLD_UNFILE
9
Records Services
9.1
About Records Services
9.2
Records Services
9.2.1
ACTIVATE_SERVICE
9.2.2
APPROVE_DELETE_SERVICE
9.2.3
BROWSE_CATEGORY_FORM
9.2.4
BROWSE_FOLDER_FORM
9.2.5
BROWSE_SERIES_FORM
9.2.6
CHECKIN_NEW_REVISION_SERVICE
9.2.7
CHECKIN_SIMILAR_FORM
9.2.8
CLEAR_FOLDER_CANCELLED_DATE
9.2.9
CLEAR_FOLDER_EXPIRATION_DATE
9.2.10
CLEAR_FOLDER_OSBOLETE_DATE
9.2.11
CLEAR_FOLDER_RESCINDED_DATE
9.2.12
CLEAR_FOLDER_REVIEW_DATE
9.2.13
CLEAR_RECORD_CANCELLED_DATE
9.2.14
CLEAR_RECORD_EXPIRATION_DATE
9.2.15
CLEAR_RECORD_OBSOLETE_DATE
9.2.16
CLOSE_FOLDER
9.2.17
CREATE_FOLDER
9.2.18
CREATE_FOLDER_FORM
9.2.19
DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE
9.2.20
DELETE_FOLDER
9.2.21
DELETE_REVISION_SERVICE
9.2.22
EDIT_FOLDER
9.2.23
EDIT_FOLDER_FORM
9.2.24
FREEZE_FOLDER
9.2.25
FREEZE_RECORD
9.2.26
INFO_CATEGORY_FORM
9.2.27
INFO_FOLDER_FORM
9.2.28
INFO_FOLDER_LIFECYCLE
9.2.29
INFO_FOLDER_METADATA_HISTORY
9.2.30
INFO_FOLDER_REVIEW_HISTORY
9.2.31
INFO_RECORD_LIFECYCLE
9.2.32
INFO_RECORD_METADATA_HISTORY
9.2.33
INFO_RECORD_REVIEW_HISTORY
9.2.34
INFO_SERIES_FORM
9.2.35
MARK_FOLDER_ACTIVATION_DATE
9.2.36
MARK_FOLDER_CANCELLED_DATE
9.2.37
MARK_FOLDER_EXPIRATION_DATE
9.2.38
MARK_FOLDER_OBSOLETE_DATE
9.2.39
MARK_FOLDER_RESCINDED_DATE
9.2.40
MARK_FOLDER_REVIEW_DATE
9.2.41
MARK_FOLDER_REVIEW_DATE_ RECURSIVE
9.2.42
MARK_RECORD_CANCELLED_DATE
9.2.43
MARK_RECORD_EXPIRATION_DATE
9.2.44
MARK_RECORD_OBSOLETE_DATE
9.2.45
MARK_RECORD_RESCINDED_DATE
9.2.46
MARK_RECORD_REVIEW_DATE
9.2.47
MOVE_FOLDER
9.2.48
PREVIEW_RECORD_LIFECYCLE
9.2.49
RMA_CLOSE_SERVICE
9.2.50
RMA_CUTOFF_SERVICE
9.2.51
RMA_DESTROY_SERVICE
9.2.52
RMA_EXPORT_ARCHIVE_SERVICE
9.2.53
RMA_EXPORT_SERVICE
9.2.54
RMA_MARK_COMPLETED
9.2.55
RMA_NO_ACTION_SERVICE
9.2.56
RMA_OBSOLETE_SERVICE
9.2.57
RMA_SCRUB_SERVICE
9.2.58
RMA_SUPERSEDE_SERVICE
9.2.59
UNCLOSE_FOLDER
9.2.60
UNFREEZE_FOLDER
9.2.61
UNFREEZE_RECORD
10
Physical Content Management Services
10.1
About Physical Content Management Services
10.2
Physical Content Management Services
10.2.1
ADD_FUNCTION_BARCODE
10.2.2
ADJUST_INVOICE
10.2.3
ADJUST_INVOICE_FORM
10.2.4
BARCODE_PROCESS
10.2.5
BATCH_STORAGE_CREATION_FORM
10.2.6
BLOCK_STORAGE
10.2.7
BROWSE_CHARGE_INVOICES_FORM
10.2.8
BROWSE_CHARGE_TRANSACTIONS_BY_INVOICE_FORM
10.2.9
BROWSE_CHARGE_TRANSACTIONS_FORM
10.2.10
BROWSE_CHARGE_TRANSACTIONS_WITH_NO_INVOICE_FORM
10.2.11
BROWSE_RESERVATION_ITEMS_FORM
10.2.12
BROWSE_STORAGE_FORM
10.2.13
CHECKIN_EXTERNAL_ITEM
10.2.14
CHECKOUT_EXTERNAL_ITEM
10.2.15
CLEAN_UP_STORAGE
10.2.16
CONFIG_CHARGE_BACKS
10.2.17
CONFIG_CHARGE_BACKS_FORM
10.2.18
CONFIGURE_CHARGE_BILLERS_FORM
10.2.19
CONFIGURE_CHARGE_PAYMENT_TYPES_FORM
10.2.20
CONFIGURE_CHARGE_TYPES_FORM
10.2.21
CREATE_CHARGE_BILLER
10.2.22
CREATE_CHARGE_BILLER_FORM
10.2.23
CREATE_CHARGE_PAYMENT_TYPE
10.2.24
CREATE_CHARGE_PAYMENT_TYPE_FORM
10.2.25
CREATE_CHARGE_TYPE
10.2.26
CREATE_CHARGE_TYPE_FORM
10.2.27
CREATE_CHARGE_TRANSACTION
10.2.28
CREATE_CHARGE_TRANSACTION_FORM
10.2.29
CREATE_CHARGE_TRANSACTION_MULTIPLE
10.2.30
CREATE_EXTERNAL_ITEM
10.2.31
CREATE_EXTERNAL_ITEM_FORM
10.2.32
CREATE_EXTERNAL_ITEM_SIMILAR_FORM
10.2.33
CREATE_MEDIA_TYPE
10.2.34
CREATE_MEDIA_TYPE_FORM
10.2.35
CREATE_OBJECT_TYPE
10.2.36
CREATE_OBJECT_TYPE_FORM
10.2.37
CREATE_RESERVATION
10.2.38
CREATE_RESERVATION_FORM
10.2.39
CREATE_STORAGE
10.2.40
CREATE_STORAGE_FORM
10.2.41
CREATE_STORAGE_TYPE
10.2.42
CREATE_STORAGE_TYPE_FORM
10.2.43
DELETE_CHARGE_BILLER
10.2.44
DELETE_CHARGE_INVOICE
10.2.45
DELETE_CHARGE_PAYMENT_TYPE
10.2.46
DELETE_CHARGE_TRANSACTION
10.2.47
DELETE_CHARGE_TYPE
10.2.48
DELETE_COMPLETED_RESERVATIONS
10.2.49
DELETE_EXTERNAL_ITEM
10.2.50
DELETE_MEDIA_TYPE
10.2.51
DELETE_OBJECT_TYPE
10.2.52
DELETE_RESERVATION
10.2.53
DELETE_RESERVATION_ITEM
10.2.54
DELETE_STORAGE
10.2.55
DELETE_STORAGE_TYPE
10.2.56
EDIT_CHARGE_BILLER
10.2.57
EDIT_CHARGE_BILLER_FORM
10.2.58
EDIT_CHARGE_PAYMENT_TYPE
10.2.59
EDIT_CHARGE_TYPE_FORM
10.2.60
EDIT_EXTERNAL_ITEM
10.2.61
EDIT_EXTERNAL_ITEM_FORM
10.2.62
EDIT_MEDIA_TYPE
10.2.63
EDIT_MEDIA_TYPE_FORM
10.2.64
EDIT_OBJECT_TYPE
10.2.65
EDIT_OBJECT_TYPE_FORM
10.2.66
EDIT_OBJECT_TYPE_RELATIONSHIPS
10.2.67
EDIT_OBJECT_TYPE_RELATIONSHIPS_FORM
10.2.68
EDIT_RESERVATION
10.2.69
EDIT_RESERVATION_FORM
10.2.70
EDIT_RESERVATION_ITEM
10.2.71
EDIT_RESERVATION_ITEM_FORM
10.2.72
EDIT_RESERVATION_ITEM_STATUS
10.2.73
EDIT_STORAGE
10.2.74
EDIT_STORAGE_FORM
10.2.75
EDIT_STORAGE_TYPE
10.2.76
EDIT_STORAGE_TYPE_FORM
10.2.77
GENERATE_CHARGE_INVOICE
10.2.78
GET_EXPORT_INVOICES
10.2.79
INFO_CHARGE_BILLER_FORM
10.2.80
INFO_CHARGE_INVOICE_FORM
10.2.81
INFO_CHARGE_PAYMENT_TYPE_FORM
10.2.82
INFO_CHARGE_TRANSACTION_FORM
10.2.83
INFO_CHARGE_TYPE_FORM
10.2.84
INFO_EXTERNAL_ITEM_FORM
10.2.85
INFO_MEDIA_TYPE_FORM
10.2.86
INFO_OBJECT_TYPE_FORM
10.2.87
INFO_RESERVATION_FORM
10.2.88
INFO_RESERVATION_ITEM_FORM
10.2.89
INFO_STORAGE_FORM
10.2.90
INFO_STORAGE_TYPE_FORM
10.2.91
MARK_INVOICE_PAID
10.2.92
MARK_INVOICE_PAID_FORM
10.2.93
MOVE_STORAGE
10.2.94
NOTIFY_OVERDUE_USERS
10.2.95
PROCESS_OVERDUE_REQUESTS
10.2.96
PROCESS_STORAGE_SPACE_COUNTS
10.2.97
RESERVE_STORAGE
10.2.98
RUN_CHARGEBACK_REPORT
10.2.99
RUN_CHARGEBACK_REPORT_MULTIPLE
10.2.100
RUN_FUNCTION_BARCODE_LABEL
10.2.101
RUN_RESERVATION_REPORT
10.2.102
RUN_RESERVATION_SEARCH_RESULTS_REPORT
10.2.103
RUN_STORAGE_BARCODE_LABEL
10.2.104
RUN_STORAGE_REPORT
10.2.105
RUN_USER_BARCODE_LABEL
10.2.106
SCREEN_CHARGE_BACKS_ADVANCED_FORM
10.2.107
SCREEN_CHARGE_BACKS_FORM
10.2.108
SEARCH_EXTERNAL_ITEM_FORM
10.2.109
UNRESERVE_STORAGE
10.2.110
UPDATE_STORAGE_DEPTHS
10.2.111
UPDATE_USERS_WITH_NO_BARCODES
11
Extended User Attributes Services
11.1
About Extended User Attributes Services
11.2
Extended User Attributes Services
11.2.1
ADD_EXTENDED_USER_ATTRIBUTES
11.2.2
EDIT_EXTENDED_USER_ATTRIBUTES
11.2.3
DELETE_EXTENDED_USER_ATTRIBUTES
11.2.4
DELETE_EXTENDED_ATTRIBUTES_BY_APPLICATION
11.2.5
DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_USER
11.2.6
DELETE_ALL_EXTENDED_ATTRIBUTES_FOR_APPLICATION
11.2.7
QUERY_EXTENDED_USER_ATTRIBUTES
11.2.8
QUERY_EXTENDED_ATTRIBUTE_MAPPINGS
11.2.9
EC_SET_PROPERTY
11.2.10
EC_DELETE_PROPERTY
11.2.11
EC_GET_PROPERTY
11.2.12
EC_GET_PROPERTY_BY_KEY
11.2.13
SET_DEFAULT_ATTRIBUTES
11.2.14
DELETE_DEFAULT_ATTRIBUTES
11.2.15
GET_DEFAULT_ATTRIBUTES
11.2.16
SET_EXTENDED_ATTRIBUTE_MAPPINGS
11.2.17
DELETED_EXTENDED_ATTRIBUTE_MAPPINGS
11.2.18
ADD_USER
11.2.19
EDIT_USER
11.2.20
DELETE_USER
11.2.21
QUERY_USER_ATTRIBUTES
12
Folios Services
12.1
About Folios Services
12.2
Folio Services
12.2.1
LOAD_FOLIO_NODE
12.2.2
UPDATE_FOLIO
12.2.3
CHECKIN_NEW_FOLIO
12.2.4
CREATE_FOLIO_SNAPSHOT
12.2.5
LOCK_FOLIO
12.2.6
UNLOCK_FOLIO
12.2.7
CREATE_FOLIO_RENDITION
12.2.8
GENERATE_GUIDS
13
Link Manager Services
13.1
About Link Manager Services
13.2
Link Manager Services
13.2.1
ABORT_LINKS_ACTIVITY
13.2.2
ADD_MANAGED_DOCLINKS
13.2.3
DELETE_MANAGED_DOCLINKS
13.2.4
GET_LINK_INFO
13.2.5
GET_LINKS_ADMIN_PAGE
13.2.6
LK_GET_SEARCH_RESULTS
13.2.7
RECOMPUTE_MANAGED_LINKS
13.2.8
REFRESH_MANAGED_DOCLINKS
13.2.9
REFRESH_MANAGED_LINKS
13.2.10
REFRESH_REFS_MANAGED_LINKS
14
Virtual Content Repository Services
14.1
About Virtual Content Repository Services
14.2
Virtual Content Repository Services
14.2.1
VCR_FOLDER_INFO
14.2.2
VCR_GET_CONTENT_TYPE
14.2.3
VCR_GET_CONTENT_TYPES
14.2.4
VCR_GET_DOCUMENT
14.2.5
VCR_GET_DOCUMENT_BY_NAME
A
Actions
A.1
About Service Actions
A.2
A
A.3
B
A.4
C
A.5
D
A.6
E
A.7
F
A.8
G
A.9
H
A.10
I
A.11
L
A.12
M
A.13
N
A.14
P
A.15
Q
A.16
R
A.17
S
A.18
T
A.19
U
A.20
V
Index
Scripting on this page enhances content navigation, but does not change the content in any way.