Component
CMIS web service API
| API | Description |
|---|---|
| GET api/cmis/ping |
Ping test that returns "Hello World!" Useful for service monitoring by edge appliances doing automated keep-alive tests. |
| POST api/cmis/log/message |
No documentation available. |
| POST api/cmis/component |
Adds/Updates a component from the Utility |
| GET api/cmis/component/byxref/{xref} |
Gets a component object from the database by xref |
| GET api/cmis/component/byxref |
Gets a component object from the database by xref. This is used when special characters such as Ampersand,Percent sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| POST api/cmis/component/byxref |
Gets a component object from the database by xref. This is used when special characters such as Ampersand,Percent sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| GET api/cmis/component/{compid} |
Gets a component object from the database by it's primary key (id) |
| GET api/cmis/component/bysite/{site} |
Gets a component or list of component objects from the database by site. Defaults: _maxrows = 10, _startrow = 1 |
| GET api/cmis/component/byunit/{site}/{unit} |
Gets a component or list of component objects from the database by site and unit. |
| GET api/cmis/components |
Gets a component or list of component objects from the database by site and unit. |
| POST api/cmis/components |
Gets a component or list of component objects from the database by site and unit. |
| GET api/cmis/component/byuniquekey |
Gets a component or list of component objects from the database by site and unit. |
| POST api/cmis/component/byuniquekey |
Gets a component or list of component objects from the database by site and unit. |
| GET api/cmis/app/components |
Get a list of Components by based on the paramaters provided. arguments are passed as parameters. (PKG_COMPONENT.GET_COMPONENT_LIST) |
| DELETE api/cmis/component/delete/{compid} |
Delete a component entry from the table by id |
| DELETE api/cmis/component/deletebyxref/{xref} |
Delete a component entry from the table by id |
| DELETE api/cmis/component/deletebyxref |
Delete a component entry from the table by id. This is used when special characters such as Ampersand, Percent Sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| PUT api/cmis/component/update/{compid} |
Update a component object |
| PUT api/cmis/component/updatebyxref/{xref} |
Update a component by xref. |
| PUT api/cmis/component/updatebyxref |
Update a component by xref. This is used when special characters such as Ampersand, Percent Sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| POST api/Component?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
EC
CMIS web service API
| API | Description |
|---|---|
| POST api/cmis/ec |
No documentation available. |
| PUT api/cmis/ec/update |
Adds/Updates an engineering change document record in the DB Parses any parameters passed in post data then it parses and appends any command line parameters to the parameter list. Command line parameters will effectively overwrite any matching post data parameters. Add a single engineering change document to the DB if the record already exists it will be handled as an update. Post data fields: Fleet - The utility or fleet for the EC Site - The site associated to the EC Unit - The unit associated to the EC ECNum - Engineering Change number Rev - Engineering Change revision number Type - Engineering Change type *SubType - Engineering Change sub type Title - Title of the Engineering Change startDate - Date of last change in status of Engineering Change Status - Status of the Engineering Change SafetyClass - Safety Classification of the EC RiskCat - Risk category of the EC RespEng - The Responsible Engineer for the EC ExtDesignOrg - Name of the External Design Organization CreatedBy - The person who created the EC CreateDate - Date that the EC was created ApprovedDate - Date that the EC was approved AffectedComponents - List of the Affected Components associated to the EC InitiatingDocs - List of the Initiating Documents associated to the EC Workorders - Work Orders associated to the EC ECRelationship - List of the Child ECs associated to a Parent EC OR the EC number of the Parent EC associated to a Child EC *URL - URL link back to EC from host system GeneratedDocument - The Binary Object of the generated PDF document (Base64 encoded) ExternalReference - ID in external system |
| GET api/cmis/ec/byxref/{xref} |
No documentation available. |
| GET api/cmis/ec/byxref |
No documentation available. |
| POST api/cmis/ec/byxref |
No documentation available. |
| DELETE api/cmis/ec/delete/{xref_ec} |
CRUD operation used to delete an engineering change from the DB. |
| DELETE api/cmis/ec/delete/byxref |
CRUD operation used to delete an engineering change from the DB. |
| GET api/cmis/engineering_changes |
No documentation available. |
| POST api/cmis/engineering_changes |
No documentation available. |
| GET api/cmis/engineering_changes/ready |
No documentation available. |
| POST api/cmis/engineering_changes/ready |
No documentation available. |
| GET api/cmis/ec/ready |
No documentation available. |
| POST api/cmis/ec/ready |
No documentation available. |
| POST api/cmis/ec/accepted |
No documentation available. |
| POST api/cmis/ec/failed |
No documentation available. |
| POST api/cmis/ec/clear_ready |
No documentation available. |
| POST api/cmis/app/package |
No documentation available. |
| PUT api/cmis/app/ec/update |
No documentation available. |
| POST api/cmis/wnexus/engineering_changes |
No documentation available. |
| POST api/EC?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
Document
CMIS web service API
| API | Description |
|---|---|
| POST api/cmis/document |
Create a new document using URL encoded form data The following url parameters are accepted:__accept=[application/xml|application/json](default=application/json) &affectedDocumentId= &utility= &site= &doc_xref_unit= &description_doc= &docnumber= &doc_url_util= &doc_xref_comp= &list_delim= &revision= &sheetnumber= &sourcesystem= &status_doc= &subtype_doc= &title_doc= &type_doc= &doc_update_requirements= &xref_doc= &document_safety_class= |
| PUT api/cmis/document/update |
Create or update a document |
| GET api/cmis/document/byxref/{xref_doc} |
Get a document from RR Web Service by Utility External Reference Key |
| GET api/cmis/document/byxref |
Get a document from RR Web Service by Utility External Reference Key |
| POST api/cmis/document/byxref |
Get a document from RR Web Service by Utility External Reference Key |
| GET api/cmis/document/bydocid/{affectedDocId} |
Get a document from RR Web Service by CMISDP by RR AffectedDocId. |
| GET api/cmis/documents |
This operation will retrieve a list of the documents attributes which match the search criteria. The query parameter site is required all other parameters are optional and will be used in combination to search for matching documents. The title and description may include asterisks as the first and/or last character to indicate like style searches. The compid may be a single component ID or a comma separated list of component IDs to search against for documents. Not all systems will have all meta-data components associated to a documents; it is up to the various utility users to know which elements may be included in a search of the utility’s database. |
| POST api/cmis/documents |
This operation will retrieve a list of the documents attributes which match the search criteria. The query parameter site is required all other parameters are optional and will be used in combination to search for matching documents. The title and description may include asterisks as the first and/or last character to indicate like style searches. The compid may be a single component ID or a comma separated list of component IDs to search against for documents. Not all systems will have all meta-data components associated to a documents; it is up to the various utility users to know which elements may be included in a search of the utility’s database. |
| GET api/cmis/document/list |
This operation will retrieve a list of the documents attributes which match the search criteria. The query parameter site is required all other parameters are optional and will be used in combination to search for matching documents. The title and description may include asterisks as the first and/or last character to indicate like style searches. The compid may be a single component ID or a comma separated list of component IDs to search against for documents. Not all systems will have all meta-data components associated to a documents; it is up to the various utility users to know which elements may be included in a search of the utility’s database. |
| POST api/cmis/document/list |
This operation will retrieve a list of the documents attributes which match the search criteria. The query parameter site is required all other parameters are optional and will be used in combination to search for matching documents. The title and description may include asterisks as the first and/or last character to indicate like style searches. The compid may be a single component ID or a comma separated list of component IDs to search against for documents. Not all systems will have all meta-data components associated to a documents; it is up to the various utility users to know which elements may be included in a search of the utility’s database. |
| DELETE api/cmis/document/delete/{xref_doc} |
Delete a document |
| DELETE api/cmis/document/delete/byxref |
Delete a document |
| POST api/Document?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
Xref
CMIS web service API
| API | Description |
|---|---|
| GET api/cmis/xref/component/{xref_type} |
Retrieves the list of XREFs for the given xref_type attached to the Component provided Required Parameters xref_comp - The xref_comp used to identify the Component |
| POST api/cmis/xref/component/{xref_type} |
Adds/deletes the associated XREFs to an Component Deletes all existing XREFs of that type then Adds the xref_list as new records If a new XREF is provided that does not currently exist, a stub record will be created Required Parameters xref_comp - The xref_comp used to identify the Component xref_list - Delimited List of XREFs to associate to the Component. Uses list delimiter defined in the COMP by default NOTE: Must contain the complete list of XREFs as the should be |
| PUT api/cmis/xref/component/add/{xref_type} |
Appends the associated XREFs to a component If a new XREF is provided that does not currently exist, a stub record will be created Required Parameters xref_comp - The xref_comp used to identify the Component xref_list - Delimited List of XREFs to associate to the Component. Uses list delimiter defined in the COMP by default NOTE: Items in the list will be appended to the current list of XREFs |
| DELETE api/cmis/xref/component/delete/{xref_type} |
Deletes the associated XREFs to an Component Required Parameters xref_comp - The xref_comp used to identify the Component xref_list - Delimited List of XREFs to delete from the Component. Uses list delimiter defined in the COMP by default NOTE: Provide a list of Only the XREFs to be deleted |
| GET api/cmis/xref/ec/{xref_type} |
No documentation available. |
| POST api/cmis/xref/ec/{xref_type} |
No documentation available. |
| PUT api/cmis/xref/ec/add/{xref_type} |
No documentation available. |
| DELETE api/cmis/xref/ec/delete/{xref_type} |
No documentation available. |
| GET api/cmis/xref/workorder/{xref_type} |
Retrieves the list of XREFs for the given xref_type attached to the Workorder provided Required Parameters xref_wo - The xref_wo used to identify the Workorder |
| POST api/cmis/xref/workorder/{xref_type} |
Adds/deletes the associated XREFs to an Workorder Deletes all existing XREFs of that type then Adds the xref_list as new records If a new XREF is provided that does not currently exist, a stub record will be created Required Parameters xref_wo - The xref_wo used to identify the Workorder xref_list - Delimited List of XREFs to associate to the Workorder. Uses list delimiter defined in the WO by default NOTE: Must contain the complete list of XREFs as the should be |
| PUT api/cmis/xref/workorder/add/{xref_type} |
Appends the associated XREFs to a Workorder If a new XREF is provided that does not currently exist, a stub record will be created Required Parameters xref_wo - The xref_wo used to identify the Workorder xref_list - Delimited List of XREFs to associate to the Workorder. Uses list delimiter defined in the WO by default NOTE: Items in the list will be appended to the current list of XREFs |
| DELETE api/cmis/xref/workorder/delete/{xref_type} |
Deletes the associated XREFs to an Workorder Required Parameters xref_wo - The xref_wo used to identify the Workorder xref_list - Delimited List of XREFs to delete from the Workorder. Uses list delimiter defined in the WO by default NOTE: Provide a list of Only the XREFs to be deleted |
| GET api/cmis/xref/document/{xref_type} |
Retrieves the list of XREFs for the given xref_type attached to the Document provided Required Parameters xref_doc - The xref_doc used to identify the Document |
| POST api/cmis/xref/document/{xref_type} |
Adds/deletes the associated XREFs to an Document Deletes all existing XREFs of that type then Adds the xref_list as new records If a new XREF is provided that does not currently exist, a stub record will be created Required Parameters xref_doc - The xref_doc used to identify the Document xref_list - Delimited List of XREFs to associate to the Document. Uses list delimiter defined in the Document by default NOTE: Must contain the complete list of XREFs as the should be |
| PUT api/cmis/xref/document/add/{xref_type} |
Appends the associated XREFs to a Document If a new XREF is provided that does not currently exist, a stub record will be created Required Parameters xref_doc - The xref_doc used to identify the Document xref_list - Delimited List of XREFs to associate to the Document. Uses list delimiter defined in the Document by default NOTE: Items in the list will be appended to the current list of XREFs |
| DELETE api/cmis/xref/document/delete/{xref_type} |
Deletes the associated XREFs to an Document Required Parameters xref_doc - The xref_doc used to identify the Document xref_list - Delimited List of XREFs to delete from the Document. Uses list delimiter defined in the Document by default NOTE: Provide a list of Only the XREFs to be deleted |
| POST api/Xref?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
ExternalLogging
| API | Description |
|---|---|
| POST api/log/externalmessage |
No documentation available. |
| POST api/ExternalLogging?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
User
CMIS web service API
| API | Description |
|---|---|
| POST api/cmis/user |
Adds a new User |
| PUT api/cmis/user/{empid} |
Update user info using a true merge where only the fields passed in the post data are updated. It also parses and appends any command line parameters to the parameter list. Command line parameters will effectively overwrite any matching post data parameters. |
| PUT api/cmis/user/update |
Update user info using a true merge where only the fields passed in the post data are updated. It also parses and appends any command line parameters to the parameter list. Command line parameters will effectively overwrite any matching post data parameters. |
| GET api/cmis/user/byemail/{email} |
Gets user info by email address. If there is no '@' character in the field it will try the lookup by empid. email parameter must be base64 encoded. Security in the modern browsers chokes on the period in the address even encoded as %2E http://stackoverflow.com/questions/14359305/mvc-web-api-routing-fails-when-url-contains-encoded-ampersand |
| GET api/cmis/user/bykey/{xref_user} |
Get user info by employee id |
| GET api/cmis/user/bykey |
Get user info by employee id. This is used when special characters such as Ampersand,Percent sign, Colon, And At Symbol are within the xref value which are not allowed as part of the URI. |
| POST api/cmis/user/bykey |
Get user info by employee id. This is used when special characters such as Ampersand,Percent sign, Colon, And At Symbol are within the xref value which are not allowed as part of the URI. |
| GET api/cmis/app/user |
Get user info by username XREF_USER or EMAIL. This is used by the CMISDP Application when loggin into the App to retrieve the users information |
| DELETE api/cmis/user/delete/{userid} |
Delete user (mark inactive) in db |
| DELETE api/cmis/user/delete |
Delete user (mark inactive) in db. This is used when special characters such as Ampersand, Percent sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| GET api/cmis/users |
Get user info by employee id. This is used when special characters such as Ampersand, Percent sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| POST api/cmis/users |
Get user info by employee id. This is used when special characters such as Ampersand, Percent sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| POST api/cmis/user/Logout |
No documentation available. |
| POST api/cmis/user/Register |
Register and add a user. (Development API) |
| POST api/cmis/user/ResetPassword |
Reset a users password. (Develelopment API) |
| GET api/cmis/user/this |
No documentation available. |
| POST api/User?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
Reporting
| API | Description |
|---|---|
| GET api/cmis/reports/documentReport |
No documentation available. |
| GET api/cmis/reports/componentReport |
No documentation available. |
| POST api/Reporting?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
IEE
| API | Description |
|---|---|
| GET api/cmis/iee/ready |
No documentation available. |
| POST api/cmis/iee/ready |
No documentation available. |
| POST api/cmis/app/iee/submit |
No documentation available. |
| POST api/cmis/iee/accepted |
No documentation available. |
| POST api/cmis/iee/failed |
No documentation available. |
| POST api/cmis/iee |
No documentation available. |
| GET api/cmis/iee/byxref/{xrefIee} |
No documentation available. |
| GET api/cmis/iee/byxref |
No documentation available. |
| POST api/cmis/iee/byxref |
No documentation available. |
| GET api/cmis/iees |
No documentation available. |
| POST api/cmis/iees |
No documentation available. |
| DELETE api/cmis/iee/delete/{xrefIee} |
No documentation available. |
| DELETE api/cmis/iee/delete |
No documentation available. |
| POST api/IEE?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
DM
CMIS web service API Implements the Engineering Change
| API | Description |
|---|---|
| POST api/cmis/dm |
No documentation available. |
| POST api/DM?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
Workorder
CMIS web service API
| API | Description |
|---|---|
| POST api/cmis/workorder |
Adds/Updates a Work Order from the Utility Parses any parameters passed in post data then it parses and appends any command line parameters to the parameter list. Command line parameters will effectively overwrite any matching post data parameters. |
| PUT api/cmis/workorder/update |
No documentation available. |
| GET api/cmis/workorder/byxref/{xref} |
No documentation available. |
| GET api/cmis/workorder/byxref |
No documentation available. |
| POST api/cmis/workorder/byxref |
No documentation available. |
| GET api/cmis/workorders |
Get workorders by unique key |
| POST api/cmis/workorders |
Get workorders by unique key |
| DELETE api/cmis/workorder/deletebyxref/{xref_wo} |
CRUD operation used to delete a workorder from the DB. |
| DELETE api/cmis/workorder/deletebyxref |
CRUD operation used to delete a workorder from the DB. This is used when special characters such as Ampersand, Percent Sign, Colon, At Symbol are within the xref value which are not allowed as part of the URI. |
| POST api/cmis/app/workorder |
Adds/Updates a Work Order from the App Parses any parameters passed in post data then it parses and appends any command line parameters to the parameter list. Command line parameters will effectively overwrite any matching post data parameters. |
| GET api/cmis/app/workorders |
No documentation available. |
| POST api/Workorder?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
TVACalculationModule
| API | Description |
|---|---|
| GET api/cmis/tvacalc |
No documentation available. |
| POST api/cmis/tvacalc |
No documentation available. |
| DELETE api/cmis/tvacalc/delete |
No documentation available. |
| POST api/cmis/tvacalc/success |
No documentation available. |
| POST api/cmis/tvacalc/failed |
No documentation available. |
| POST api/cmis/tvacalc/inputfiles/success |
No documentation available. |
| POST api/cmis/tvacalc/inputfiles/failed |
No documentation available. |
| POST api/cmis/tvacalc/app/submit |
No documentation available. |
| POST api/TVACalculationModule?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
ActionTracking
| API | Description |
|---|---|
| POST api/cmis/action_tracking |
No documentation available. |
| GET api/cmis/action_tracking/byxref/{xrefAct} |
No documentation available. |
| GET api/cmis/action_tracking/byxref |
No documentation available. |
| POST api/cmis/action_tracking/byxref |
No documentation available. |
| DELETE api/cmis/action_tracking/delete/{xrefAct} |
No documentation available. |
| DELETE api/cmis/action_tracking/delete |
No documentation available. |
| POST api/ActionTracking?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |
DocumentMarkup
CMIS web service API
| API | Description |
|---|---|
| POST api/cmis/document_markup |
Create a new Document/Markup relationship using URL encoded form data |
| GET api/cmis/document_markup |
Get a Document/Markup Relationship from RR Web Service by Utility External Reference Key |
| GET api/cmis/document_markup/list |
This operation will retrieve a list of the Document/Markup Relationships which match the search criteria. The query parameter UTILITY and at least one of XREF_DOC or XREF_MARK is required all other parameters are optional and will be used in combination to search for matching documents. |
| DELETE api/cmis/document_markup/delete |
Delete a Document/Markup Relationship |
| GET api/cmis/document_markups/by_xref_ec |
No documentation available. |
| POST api/cmis/document_markups/by_xref_ec |
No documentation available. |
| GET api/cmis/app/document_markups |
This operation will retrieve a list of the Document/Markup Relationships which match the search criteria. The query parameter UTILITY and at least one of XREF_DOC or XREF_MARK is required all other parameters are optional and will be used in combination to search for matching documents. |
| GET api/cmis/app/document_markup/collection |
This operation will retrieve a collection of the Document/Markup Relationships that are related to a given XREF connected to an XREF_EC. This returns the fields needed by the Application to Add the Documents and Markups to the App with the Link Status |
| POST api/DocumentMarkup?fileName={fileName}&fileNameZip={fileNameZip}&compressionLevel={compressionLevel} |
No documentation available. |