Content
|
Index
|
Search
Introduction
Integration possibilities
Integration via database
Technical overview
Interface data template
Manipulating records in the DIINTERFACE table through scripts
Data load in the interface
XLS file structure definition
Diagnosis and correction of errors
Published interfaces
Administration
ADCOM - Company import (customer/manufacturer/supplier)
ADCTC - Company contacts import
ADMACT – Activity import
ADMADP – Activity associated with position or department import
ADMATR - Attribute import
ADMATRPROFVL - Employee profile attribute value
ADMATRRELATION – Attributes relationship
ADMATRVAL - Import of attribute values
ADMCPNATRASS - Import of association of attributes to companies
ADMDEP - Department data import
ADMEMPLOYEEPROF – Edits the employee profile data
ADMMEA - Import of measurement units
ADMPOS - Position data import
ADMTEAM - Team import
ADMTEAMASSOC - Associate a department, position, or user with a team
ADMUSR - User data import
ADMUSRCOMP - Full import of user data
EXTERNALUSER - Import and deactivation of the external user's data
Asset
ASDOWNTIME – Downtime record import
ASTASTATT - Asset attributes import
ASTASTDELETE – Asset deletion
ASTASTINSERT - Asset import
ASTCMDBDELETE - Delete relationship - CMDB
ASTCMDBINSERT - Add relationship - CMDB
ASTCONFSITE - Storage place import
ASTOEE - Insertion of Parameter data to calculate OEE
ASTPLANACT - Activity plan import
ASTSECU - Asset type security import
ASTSITE - Asset location import
ASTSTATE - Asset condition import
ASTSTATUS - Asset status import
ASTSTRC - Asset structure import
ASTTYPE - Asset types import
Audit
AUSPOPULATIONDATA - Population data
Competence
CPTEVALIT – Evaluation item
CPTEVALITHAB – Evaluation item association with competence
CPTREG - Competence
Document
DCACCESS - Access permission to documents
DCARCHIVALTRANSFER - File transfer
DCCOPYSTATION - Add copy station
DCCOPYSTATIONEDIT - Edit copy station
DCCOPYSTATIONRESP - Insert party responsible for copy station
DCCOPYSTATIONRESPDELETE - Delete responsible parties from copy station list
DCCOPYSTATIONSTATUS - Change copy station status
DCDELETECOPYSTATION - Delete copy station
DCDOC - Document import
DCDOCATR - Attribute import
DCDOCATRASS - Attribute association import
DCDOCATRVAL - Attribute values import
DCDOCCANCEL - Document cancellation
DCDOCCOMP - Complementary documents import
DCDOCELEC - Import of electronic file of documents
DCDOCPROCASSOC - Associate document with process
DCDOCREV - Document revision import
DCDOCREVPAR - Revision participants import
DCDOCSTRUCTASS - Association of documents with the container structure
DCDOCSTRUCTDESASS - Disassociation of documents from the container structure
DCPROTOCOLPRINTEDCOPYNEW - Add printed copy data
DCRELATECOPYSTATION - Document association with copy station
FMEA
FMEFCAUSE - Failure cause import
FMEFCTRL – Failure control import
FMEFEFFECT - Failure effect import
FMEFMODE - Failure mode import
FMEFUNC - FMEA function import
FMEREQ - Requirement import
Inspection
IPCFG - Inspection configuration
IPCFGCAR - Characteristic relationship in inspection configuration
IPCFGCKL – Checklist relationship in inspection configuration
IPCFGDELSUP - Disassociates a supplier from an inspection form
IPCFGNEWSUP - Associates a supplier with an inspection form
IPQUAL - Inspection qualifications import
IPREC - Import of receiving
Kanban
TSKTASKASSOCIATE – Associate task with the instance
TSKTASKEDIT – Edit task
TSKTASKINSERT – Create task
TSKTASKUPDATEATTRIB – Edit attribute
Maintenance
MNCALIBRATION - Calibration data import
MNMAINTCORRECT – Corrective maintenance import
MNMAINTMETER – Meter reading
MNMAINTPROGRAMMED - Programmed maintenance import
MNMAINTVARIABLE – Variable reading
MNPOINT - Calibration table point data import
MNTABLE - Calibration table data import
PDM
ITATRIB - Attribute type characteristics import
ITATTR - Association of attributes with the item
ITBOM - Item structure import
ITCARTPAT - Asset type association import with the item characteristics
ITCUST - Item X customer association import
ITDOCASSOC - Association of documents with the item record
ITINSP - Production inspection
ITITEM - Item import
ITMANU - Item X manufacturer association import
ITSECU - Item type security import
ITSUPP - Item X supplier association import
ITTYPE - Item types import
ITVARI - Import of variable-type characteristics
Performance
STRDELSCMETRICACCESS - Deletion of security from the Scorecard indicator
STRDELSCOREACCESSMTR - Deletion of default security for Scorecard indicator/element
STRDELSCORECARDACCESS - Deletion of Scorecard security
STRDELVALUES - Delete indicator values
STRELEMENT - Element import
STRMETRIC - Indicator import
STRSCELEMENT - Scorecard element import
STRSCMETRIC - Scorecard indicators import
STRSCMETRICACCESS - Addition of security for Scorecard indicator
STRSCOREACCESSMTR - Insertion of default security for Scorecard indicator
STRSCORECARD - Import of template-based Scorecard
STRSCORECARDACCESS - Insertion of Scorecard security
STRSCSUBMETRIC - Sub-indicator import
STRVALUES - Import of target/measurement of indicators
Project
PROFINANCE - Financial import
PRORESOURCE - Resource value import
PROTIME - Timesheet import
Requirement
REQPOPULATIONDATA - Add population data
REQPOPULATIONDATADEL - Delete population data
RQMAPPINGANALYSIS – Map requirement
RQMAPPINGREVISION - Requirement mapping
RQREQATTRIBUTE - Requirement attribute value
RQREQUIREMENT - Sub-requirements
RQREVISION - Reference requirements
RQREVRELEASE - Release revision
RQREVSTART - Start revision
Risk
RICONTROLATTRIBUTE - Control attribute value
RIRISKANALYSIS - Risk analysis
RIRISKATTRIBUTE – Risk attribute value
RISBESTPRACTICE – Best practice
RISBESTPRACTICETYPE – Best practice type
RISCONSEQUENCE – Consequence
RISCONSEQUENCETYPE – Consequence type
RISCONTROL – Control
RISCONTROLANALYSIS - Control analysis
RISCONTROLTYPE – Control type
RISEVAL - Matrix-type evaluation
RISEVAL - Quantitative/Matrix-type evaluation
RISITEM – Element
RISITEMTYPE – Element type
RISOBJECTIVE – Objective
RISOBJECTIVETYPE – Objective type
RISPOPULATIONDATA - Add population data
RISPOPULATIONDATADEL - Delete population data
RISRISK – Risk
RISRISKTYPE - Risk/Opportunity type
RISSOURCE – Risk source
RISSOURCETYPE – Risk source type
RISTREATMENT – Treatment
RISTREATMENTTYPE – Treatment type
SPC
SPCSAMPATT - Attribute characteristic sample import
SPCSAMPCHANGESTATUS – Sample status update
SPCSAMPVAR - Variable characteristic sample import
Storeroom
STMDELINPUTEVENT - Input event deletion
STMDELOUTPUTEVENT - Output event deletion
STMDELSTORAGEPLACE - Storage place deletion
STMDELSTORE - Storeroom deletion
STMDELSTOREOBJ - Storeroom object deletion
STMEVENTATTRIB - Association of event attributes import
STMINPUTEVENT - Input event import
STMINPUTOBJECT - Input event objects import
STMOUTPUTEVENT - Output event import
STMOUTPUTOBJECT - Output event objects import
STMSTORAGEPLACE - Storage place import
STMSTORE - Storeroom import
STMSTOREATTRIB - Storeroom attribute association import
STMSTOREOBJECT - Import of storeroom objects
Supply
INSATTR - Association of attributes with the supply
INSINS - Supply import
INSINSSTR - Supply structure import
INSTYPE - Supply type import
INSUPP - Supply X supplier association import
Survey
SRVRESP - Survey respondent import
Time control
WRFINANCE - Financial import
WRRESOURCE - Resource value import
WRTIME - Timesheet import
Training
TRASSOC - Participant evaluation and/or association
TRCHANGESTEP - Training status change
TRCOST - Training cost
TRCOURSEATTRIB - Course attribute values import
TRCOURSEREG - Course
TRPRESENCELIST - Attendance list import
TRREG - Training record creation
TRTRAININGATTRIB - Training attribute values import
Waste
WMSHIPATTRIBASSOC - Attribute association import with the transport
WMWASTEATTRIB - Attribute import
WMWASTEATTRIBASSOC - Attribute association import with the waste
WMWASTEATTRIBVALUE - Attribute values import
Workflow
WFINSTANCE - Workflow
Workspace
GNCATALOGSERVICE - Service catalog service import
Integration via SOAP web services
Technical overview
API Key authentication
Basic HTTP authentication
Published web services
Action plan
editAction
editActionStatus
editIsolatedAction
executeAction
executeIsolatedAction
getAction
getAttachmentAction
newAction
newActionPlan
newActionPlanInstanceAssociation
newAttachmentAction
newIsolatedAction
setAttributeValue
Administration
addAttribProfileValue
addAttribute
addAttributeValue
addCompany
addCompContact
addDepartmentPosition
addMeasUnity
addUserAbsence
addUserDepartment
addUserToAccessGroup
changeOrganizationalUnitStatus
changePositionStatus
changeUserStatus
compAtribAssoc
deleteAttributeRelationship
deleteCompany
deleteCompContact
deleteDepartment
deleteMeasUnity
deleteUser
deleteUserAcessGroup
deleteUserDepartment
deleteUserLeader
disableUser
editDepartment
editOrganizationalUnit
editUser
editUserDepartment
getAttribData
getDepartment
getUserData
importUser
importUserV2
inactiveExternalUser
newAttributeRelationship
newDepartment
newExternalUser
newPosition/editPosition
newUser
updateEmployeeProfile
Archive
newPhysicalFileLoan
Asset
del_objectType
delete_assetConfSite
deleteCMDBRelationship
import_asset
import_asset_oee
import_asset_site
import_asset_state
import_asset_status
import_asset_structure_insert_update
import_assetConfSite
import_attrib_assoc
import_del_asset
import_del_asset_site
import_del_asset_state
import_del_asset_structure
import_objectSecurity
import_objectType
importAssetDowntime
importCMDBRelationship
importPlanActivity
Capture
deleteBatch
newBatch
newBatchFile
getBatches
getBatchData
executeBatch
setIndexValue
Document
associateProcess
cancelDocument
changeCopyStationStatus
checkAccessPermission
deleteAccessPermission
deleteCopyStation
deleteDocument
deleteDocumentContainerAssociation
deleteRespCopyStation
deleteRevision
downloadEletronicFile
editCopyStation
editDocument
getKeyWords
getKeyWordsData
listAccessPermission
listPendencyDocument
newAccessPermission
newCaptureInstance
newCopyStation
newCopyStationResp
newDocument
newDocument2
newDocumentContainerAssociation
newProtocolPrintedCopy
newRevision
relateCopyStation
releasePendencyDocument
searchAccessAudit
searchCategory
searchDocument
setAttributeValue
shareDocument
uploadEletronicFile
viewDocumentData
FMEA
addFailureCause
addFailureControl
addFailureEffect
addFailureMode
addFunction
addRequirements
Forms
deleteTableRecord
deleteTableRecordList
editTableRecord
getTableRecord
newTableRecord
newTableRecordList
Generic
addAreaToTeam
addPositionToTeam
addUserToRole
addUserToTeam
createTeamByArea
createTeamByPosition
createTeamByUser
deleteTeamMember
editTeamByArea
editTeamByPosition
editTeamByUser
newRole
newTeam
newTeamMember
removeAreaFromTeam
removePositionFromTeam
removeTeam
removeUserFromRole
removeUserFromTeam
Inspection
createUpdateConfiguration
createUpdateDeleteReceiving
deleteSupplierInspConfiguration
editQualificationIndexValue
importRecvInspAtt
importRecvInspVar
newSupplierInspConfiguration
relateCharacteristicToInspConfiguration
relateChecklistToInspConfiguration
Kanban
createTask
editTask
insertAssociation
updateTaskAttrib
Knowledge base
newArticle
Maintenance
createCorrectiveMaintenance
import_calibration
import_del_calibration
import_point
import_table
insertMeterReading
insertVariableReading
newProgrammedMaintenance
PDM
addBom
addCharacteristicAttrib
addCharacteristicVar
addCustomer
addManufacturer
addSupplier
deleteBom
deleteCustomer
deleteItem
deleteManufacturer
deleteSupplier
import_attrib_assoc
newItem
newItemType
relateAssetTypeToCharacteristic
relateProductionInspectionToChar
Performance
addMeasuresInAdinterface
addMultipleMeasuresInAdinterface
viewMetricValuesData
viewScMetricData
viewScorecardMetricValuesData
Project
editProgramCost
editProgramRevenue
editProjectCost
editProjectRevenue
editProjectTaskCost
editProjectTaskRevenue
executeProjectTask
getProjectCost
getProjectRevenue
newAssocDocProj
newProgramCost
newProgramRevenue
newProjectCost
newProjectRevenue
newProjectTaskCost
newProjectTaskRevenue
Request
getKeyWordRequestStatus
newKeyWordRequest
sendRequestToApprov
Risk
createControlAnalysisFile
createControlFile
createRiskAnalysisFile
createRiskFile
SPC
ChangeStatusSample
CmmImportFile
DeleteAttCause
DeleteAttDefect
DeleteSampleAtt
DeleteSampleVar
ImportAttCause
ImportAttDefect
ImportSampleAtt
ImportSampleVar
Storeroom
executeInputEvent
executeOutputEvent
executeTransferEvent
importAttributeEvent
inputEventInterface
inputObjectInterface
outputEventInterface
outputObjectInterface
Supply
addEditSupplySupplier
addEditSupplyWarehouse
addSupplyStructure
createEditSupply
createSupplyType
deleteSupply
deleteSupplyStructure
deleteSupplySupplier
deleteSupplyWarehouse
import_attrib_assoc
Time control
editNonProjectTaskCost
editNonProjectTaskRevenue
executeNonProjectTask
newNonProjectTaskCost
newNonProjectTaskRevenue
Training
importAttribTrainValue
importTraining
importTrainingPresenceList
newCourse
newCourseEntityAssoc
newTrainingAttach
sendTrainingStep
Workflow
cancelWorkflow
clearChildEntityRecord
deleteChildEntityRecord
editAttributeValue
editChildEntityRecord
editEntityRecord
editWorkflowData
executeActivity
executeSystemActivity
getWorkflow
newAccessException
newAssocDocument
newAssocWorkflow
newAttachment
newChildEntityRecord
newChildEntityRecordList
newComment
newWorkflow
newWorkflowEditData
newWorkflowTypeEditData
reactivateWorkflow
unlinkActivityFromUser
Frequently Asked Questions
Integration via REST web services
Technical overview
Authentication for external application
Authentication and communication via API Gateway
Published web services
Asset
ASTASTDELETE
ASTASTINSERT
ASTCMDBDELETE
ASTCMDBINSERT
Configuration
DOWNLOAD
UPLOAD
Document
DC_EDIT_DOCUMENT_INTERFACE
Forms
DATASET
Kanban
TSKTASKUPDATEATTRIB
Knowledge base
ARTICLE
ARTICLES
Requirement
REQ_ATTRIBASSOC_INTERFACE
REQ_LEAF_INTERFACE
REQ_MAPPING_INTERFACE
REQ_REFERENCE_INTERFACE
REQ_REVRELEASE_INTERFACE
REQ_REVSTART_INTERFACE
Risk
RIS_CONTROL_INTERFACE
RIS_CONTROLANALYSIS_INTERFACE
RIS_EVAL_INTERFACE - Matrix-type evaluation
RIS_EVAL_INTERFACE - Quantitative/Matrix-type evaluation
RIS_RISK_INTERFACE
RIS_RISKANALYSIS_INTERFACE
Supply
INSDEL
INSINS
INSUPP
INSUPPDEL
Workflow
HISTORY-COMMENT
INSTANCE
INSTANCE-ATTRIBUTE
Workspace
LANGUAGE