Available Function Modules
The following function modules are released.
Collaboration
Name of the function module |
Purpose |
CFX_API_COLLABORATION_CREATE |
Create collaboration |
CFX_API_COLLABORATION_CHANGE |
Change collaboration |
CFX_API_COL_GETDETAIL |
Display collaboration |
CFX_API_COLLABORATION_DELETE |
Delete collaboration |
CFX_API_COL_GETLIST_COL |
List of collaborations in the collaborative scenario |
CFX_API_COL_GETLIST_COMP |
List of collaborations in the competitive scenario |
CFX_API_COL_GETLIST_STANDARD |
Find collaborations in the collaborative scenario |
CFX_API_COL_GETLIST_TEMPLATES |
Collaborations that can be used as templates |
Work Area
Name of the function module |
Purpose |
CFX_API_AREA_CREATE |
Create work area |
CFX_API_AREA_CHANGE |
Change work area |
CFX_API_AREA_GETDETAIL |
Display work area |
CFX_API_AREA_DELETE |
Delete work area |
Folder
Name of the function module |
Purpose |
CFX_API_FOLDER_CREATE |
Create folder |
CFX_API_FOLDER_CHANGE |
Change folder |
CFX_API_FOLDER_GETDETAIL |
Display folder |
CFX_API_FOLDER_DELETE |
Delete folder |
CFX_API_FOLDER_COPY |
Copy folder |
Folder Object
Name of the function module |
Purpose |
CFX_API_DOC_CREATE |
Create folder object |
CFX_API_DOC_CHANGE |
Change folder object |
CFX_API_DOC_GETDETAIL |
Display folder object |
CFX_API_DOC_DELETE |
Delete folder object |
CFX_API_DOC_COPY |
Copy folder object |
CFX_API_DOC_VERSION_GETDETAIL |
Display a version of a folder object |
CFX_API_DOC_VERSION_CHANGE |
Change a version of a folder object |
A folder object is an object that can be contained in a folder, for example, a document, data sheet, material, bill of material, text, bookmark, or a discussion. In the API, “DOC” stands for a folder object.
Folder Object, Contents
Name of the function module |
Purpose |
CFX_API_DOC_DOCUMENT_ASURL |
Determine URL used to access the content of the document, data sheet, material, BOM, or generic object as a file |
CFX_API_DOC_DOCUMENT_READ |
Provide same file as CFX_API_DOC_DOCUMENT_ASURL but as table |
CFX_API_DOC_DOCUMENT_WRITE |
Change contents of the document, data sheet, material, BOM, or generic object |
CFX_API_DOC_NOTE_READ |
Read contents of a text |
CFX_API_DOC_NOTE_WRITE |
Write contents of a text |
CFX_API_DOC_BOOKMARK_READ |
Read bookmark |
CFX_API_DOC_BOOKMARK_WRITE |
Change bookmark |
CFX_API_DOC_MATERIAL_READ |
Read contents of a material |
CFX_API_DOC_MATERIAL_WRITE |
Write contents of a material |
CFX_API_DOC_MATERIAL_COMPARE |
Compare two material versions |
CFX_API_DOC_STRUCTURE_READ |
Read contents of a structure |
CFX_API_DOC_STRUCTURE_WRITE |
Write contents of a structure |
CFX_API_DOC_STRUCTURE_COMPARE |
Compare two structure versions |
CFX_API_DOC_GEN_OBJECT_CHANGE |
Change data of a generic object |
CFX_API_DOC_GEN_OBJECT_READ |
Read data of a generic object |
CFX_API_DOC_LAYER_CHANGE_BS_ID |
Change redline layer: ID of the appropriate layer in the back-end system |
CFX_API_DOC_LAYER_CREATE |
Create redline layer, for example, from back-end |
CFX_API_DOC_LAYER_DELETE |
Delete redline layer |
CFX_API_DOC_LAYER_GETDETAIL |
Details of a redline layer |
Authorizations
Name of the function module |
Purpose |
CFX_ACO_API_ACTIVITIES_GET |
Display authorizations |
CFX_ACO_API_ACTIVITIES_SET |
Set authorizations |
CFX_ACO_API_ACTIVITIES_RESET |
Reset authorizations |
Alias Names
Name of the function module |
Purpose |
CFX_API_ALIAS_CREATE |
Create alias |
CFX_API_ALIAS_CHANGE |
Change alias |
CFX_API_ALIAS_GETDETAIL |
Display alias |
Alias Labels
Name of the function module |
Purpose |
CFX_API_ALIAS_GET_VALUE |
Determine alias label |
CFX_API_ALIAS_SET_VALUE |
Change alias label |
CFX_API_ALIAS_BS_GET_VALUE |
Determine alias label in namespace or back-end system |
CFX_API_ALIAS_BS_SET_VALUE |
Change alias label in namespace or back-end system |
Status
Name of the function module |
Purpose |
CFX_API_OBJECT_STATUS_CHANGE |
Change status of object |
CFX_API_OBJECT_STATUS_GET |
Display status of object |
CFX_API_STATUS_PROFILE_ASSIGN |
Assign a status profile to an object |
CFX_API_STATUS_PROFILE_GETLIST |
Supplies a list of all status profiles |
Search
Name of the function module |
Purpose |
CFX_API_SEARCH_GETLIST |
Determine list of searches |
CFX_API_SEARCH_GETDETAIL |
Read search (attributes and found objects) |
CFX_API_SEARCH_BS_ALIASES |
Find folder objects with specified aliases |
It is not possible to create a search via API.
External References to Collaborations
Name of the function module |
Purpose |
CFX_API_REFERENCE_CREATE |
Create external reference |
CFX_API_REFERENCE_GETDETAIL |
Display external reference |
CFX_API_REFERENCE_DELETE |
Delete external reference |
CFX_API_REFERENCE_GET |
Read external references per object |
User
Name of the function module |
Purpose |
CFX_API_USER_CREATE |
Create cFolders user |
CFX_API_USER_CHANGE |
Change cFolders user |
CFX_API_USER_DELETE |
Delete cFolders user |
System
Name of the function module |
Purpose |
CFX_API_SYSTEM_GETDETAIL |
Determine information about the system (for example, cFolders version, current user) |
CFX_API_SYSTEM_REFRESH |
Delete local cache |
Thumbnail
Name of the function module |
Purpose |
CFX_API_THUMBNAIL_GET |
Determine thumbnail data for an object |
CFX_API_THUMBNAIL_CHANGE |
Change thumbnail of an object |
CFX_API_THUMBNAIL_DELETE |
Delete thumbnail |
Category
Name of the function module |
Purpose |
CFX_API_CATEGORY_ASSIGN |
Assign a category to the object |
CFX_API_CATEGORY_CHANGE |
Change category data |
CFX_API_CATEGORY_READ |
Read category data |
Name of the function module |
Purpose |
CFX_API_EMAIL_SEND |
Send e-mail |