tibco nimbus tm - tibco product documentation nimbus web... · no part of this document may be ......
TRANSCRIPT
Important Information
TIBCO Nimbus Web Services API Reference
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO
SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED
TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER
TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT
FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE
AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF
THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT
OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF
THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF
AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright law s and treaties. No part of this
document may be reproduced in any form w ithout the w ritten authorization of TIBCO Softw are Inc.
TIBCO, Tw o-Second Advantage and TIBCO Nimbus are either registered trademarks or trademarks of TIBCO Softw are Inc. in the
United States and/or other countries.
All other product and company names and marks mentioned in this document are the property of their respective ow ners and are
mentioned for identif ication purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM
PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE RELEASE NOTE FOR THE
AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY
ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN
THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER
DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ
ME" FILES.
Copyright © 1997-2015 TIBCO Softw are Inc. ALL RIGHTS RESERVED.
TIBCO Softw are Inc. Confidential Information
3Contents
TIBCO Nimbus Web Services API Reference
Table of Contents
TIBCO Nimbus Web Services API Reference.................................................................................................................... 5Enabling the API
.................................................................................................................... 6Authentication
.................................................................................................................... 7IMapService
.............................................................................................................. 7Methods
.................................................................................................................... 9IDiagramService
.............................................................................................................. 9Methods
.............................................................................................................. 14Complex Types
.............................................................................................................. 24Simple Types
.................................................................................................................... 28IDataTableService
.............................................................................................................. 28Methods
.............................................................................................................. 36Complex Types
.............................................................................................................. 42Simple Types
.................................................................................................................... 44IActionService
.............................................................................................................. 44Methods
.............................................................................................................. 50Complex Types
.............................................................................................................. 57Simple Types
.................................................................................................................... 59IChangeRequestService
.............................................................................................................. 59Methods
.............................................................................................................. 61Complex Types
TIBCO Nimbus Web Services API Reference4
TIBCO Nimbus Web Services API Reference
The following sections are available in this guide:
Name Description
Enabling the API
Authentication
IMapService IMapService contains methods for retrieving keyinformation about a process map.
IDiagramService IDiagramService contains methods for retrievinginformation about a particular diagram.
IDataTableService IDataTableService contains methods for workingwith data tables and data table attachments.
IActionService Use the IActionService to create a new Actionfor a diagram.
IChangeRequestService Use the IChangeRequestService to create a newChange Request for a diagram.
Enabling the API 5
TIBCO Nimbus Web Services API Reference
1.1 Enabling the APIBefore the API can be used it first needs to be enabled. This can be done by adding the following section tothe Web Server's config.ini file
[WebServices]APIEnabled=1
If you also wish to switch on WSDL publishing then you must add the PublisWSDL paramater to the[WebServices] section, as follows:
[WebServices]APIEnabled=1PublishWSDL=1
TIBCO Nimbus Web Services API Reference6
TIBCO Nimbus Web Services API Reference
1.2 AuthenticationEach API request must be performed in the context of a TIBCO Nimbus user. To identify the user, two customheaders must be added to the SOAP request. These headers are
X-ControlUsername
X-ControlPassword
Alternatively you can pass both username and password together in the X-ControlUsername header so longas username is first and is separated from the password by a new line. ie: \n
IMapService 7
TIBCO Nimbus Web Services API Reference
1.3 IMapService
DescriptionIMapService contains methods for retrieving key information about a process map.
RemarksIMapService allows a client application to retrieve a map's GUID and also the GUID of the map's rootdiagram.Map and diagram GUIDs are mandatory inputs for all of the calls in the IDiagramService
See AlsoMethods
1.3.1 Methods
Methods
Name Description
GetMapGUID Returns a map GUID for a specifed map path.
GetRootDiagramGUID Returns the GUID for the root diagram in aprocess map
GetMapGUID
DescriptionReturns a map GUID for a specifed map path.
Parameters
Name Type Direction Description
MapPath string Input Process map path. eg :\draft\my map
ReturnsA value of type string.
RemarksThe result from GetMapGUID can be used in the majority of calls in IDiagramService
GetRootDiagramGUID
Description
TIBCO Nimbus Web Services API Reference8
TIBCO Nimbus Web Services API Reference
Returns the GUID for the root diagram in a process map
Parameters
Name Type Direction Description
MapGUID string Input Unique indentifier for aprocess map. This canbe obtained by calling IMapService.GetMapGUID
ReturnsA value of type string.
RemarksDiagram GUIDs are required for all of the calls in IDiagramService
IDiagramService 9
TIBCO Nimbus Web Services API Reference
1.4 IDiagramService
DescriptionIDiagramService contains methods for retrieving information about a particular diagram.
RemarksIDiagramService is a read-only service and exposes no methods for editing a diagram.All operations are done in the context of the currently signed-in user. If that user does not have access toparticular diagram an EDiagramServiceError exception is thrown.
See AlsoMethods | Complex Types | Simple Types
1.4.1 Methods
Methods
Name Description
GetActivityInfo Use GetActivityInfo to retrieve an ActivityInfostruct that contains all key information about aspecific diagram activity.
GetDiagramAndActivityInfo Use GetDiagramAndActivityInfo to retrieve an ActivityInfo struct that contains all keyinformation about a specific diagram activity,and also a DiagramInfo struct that describes theactivity's parent diagram
GetDiagramInfo Use GetDiagramInfo to retrieve informationabout a particular diagram.
GetDiagramObjectCount Use GetDiagramObjectCount to return thenumber of objects in a diagram
GetDiagramObjects Use GetDiagramObjects to retrieve an array ofall root objects
GetDiagramTitle Use GetDiagramTitle to look up the displayname for a diagram
GetLevels Use GetLevels to return all child diagrams thathave the specified diagram as their parent
GetActivityInfo
DescriptionUse GetActivityInfo to retrieve an ActivityInfo struct that contains all key information about a specific diagramactivity.
TIBCO Nimbus Web Services API Reference10
TIBCO Nimbus Web Services API Reference
Parameters
Name Type Direction Description
MapGUID string Input Unique map id
DiagramGUID string Input Unique diagram id
ActivityGUID string Input Unique activity id
ReturnsA value of type ActivityInfo having the structure defined by the following table.
Name Type Description
ID int A grouping id that allows childobjects to be associated with aparent activity
ObjectID int An integer id that uniquelyidentifies the object within thediagram
GUID string The globally unique identifierfor an activity
Commentary string Contains any commentary thathas been added to the activity.Only plain text is returned bythe API. All formatting isremoved.
Inputs Inputs An array of flowlines that act asinputs to the activity
Outputs Outputs An array of flowlines that act asoutputs from the activity
Resources Resources An array of resources
Notes string Contains any popup notes thathave been added to thecommentary.Only plain text is returned bythe API. All formatting isremoved.Only plain text is returned bythe API. All formatting isremoved.
Attachments Attachments An array of attachment items
DrillDowns Drilldowns An array of diagram drilldowns
StatementLinks StatementLinks An array of statement links
Text string The activity text.Only plain text is returned bythe API. All formatting isremoved.
IDiagramService 11
TIBCO Nimbus Web Services API Reference
RemarksIf the diagram cannot be found in the Process Repository then an EDiagramServiceError exception is thrown.
GetDiagramAndActivityInfo
DescriptionUse GetDiagramAndActivityInfo to retrieve an ActivityInfo struct that contains all key information about aspecific diagram activity, and also a DiagramInfo struct that describes the activity's parent diagram
Parameters
Name Type Direction Description
MapGUID string Input Unique map id
DiagramGUID string Input Unique diagram id
ActivityGUID string Input Unique activity id
ReturnsA value of type DiagramActivityInfo having the structure defined by the following table.
Name Type Description
DiagramInfo DiagramInfo Struct describing the specifiedactivity's parent diagram
ActivityInfo ActivityInfo Struct describing the specifiedactivity
RemarksIf the diagram cannot be found in the Process Repository then an EDiagramServiceError exception is thrown.
GetDiagramInfo
DescriptionUse GetDiagramInfo to retrieve information about a particular diagram.
Parameters
Name Type Direction Description
MapGUID string Input Unique map id
DiagramGUID string Input Unique diagram id
IncludeDiagramObjects boolean Input If set to true then theDiagramInfo.Objectsarray will be populated
ReturnsA value of type DiagramInfo having the structure defined by the following table.Name Type Description
MapName string Map name
TIBCO Nimbus Web Services API Reference12
TIBCO Nimbus Web Services API Reference
DiagramTitle string Diagram title
Level string The level number for thediagram
Owner string User name for the diagramowner
Author string User name for the diagramauthor
Version string Diagram version number
GUID string Diagram unique identifier
MapPath string Path to the diagram's parentmap
NotationType NotationType Defines the notation style usedby the diagram.
ParentGUID string Unique identifier of the parentdiagram
PrimaryContact PrimaryContact Defines which role is theprimary contact for the diagram.This can either be the Owner orthe Author
PreparedDate dateTime The date on which the diagramwas prepared
AuthStatus AuthStatus The diagram's currentauthorization status
MapType MapType Identifies the map type. eg :draft, master, archive etc.
ReviewDate dateTime Date of the last diagram review.This is only populated if arecurring review has been setup for the diagram
Template string Filename for the diagram'stemplate.
PercentDone int Percentage of the diagram thathas been completed
ModifiedDate dateTime Date that the diagram was lastmodified
ModifiedBy string User name of the person thatlast modified the diagram
Status string Diagram status. eg : promoted
VariantType VariantType Identifies whether the diagramis a process variant or not
WebServerURL string URL to the diagram
ObjectCount int Number of objects on thediagram
Objects DiagramObjectInfoArray An array of diagram objects
IDiagramService 13
TIBCO Nimbus Web Services API Reference
RemarksIf the diagram cannot be found in the Process Repository then an EDiagramServiceError exception is thrown.
GetDiagramObjectCount
DescriptionUse GetDiagramObjectCount to return the number of objects in a diagram
Parameters
Name Type Direction Description
MapGUID string Input Unique map id
DiagramGUID string Input Unique diagram id
ReturnsA value of type int.
RemarksThis method only counts Activities, Images, Textboxes, Signposts and Flowlines.
GetDiagramObjects
DescriptionUse GetDiagramObjects to retrieve an array of all root objects
Parameters
Name Type Direction Description
MapGUID string Input Unique map id
DiagramGUID string Input Unique diagram id
ReturnsA value of type DiagramObjectInfoArray.
RemarksThis method only returns Activities, Images, Textboxes, Signposts and Flowlines.
GetDiagramTitle
DescriptionUse GetDiagramTitle to look up the display name for a diagram
ParametersName Type Direction Description
TIBCO Nimbus Web Services API Reference14
TIBCO Nimbus Web Services API Reference
MapGUID string Input Unique map identifier
DiagramGUID string Input Unique diagramidentifier
ReturnsA value of type string.
RemarksIf the diagram cannot be found in the Process Repository then an EDiagramServiceError exception is thrown.
GetLevels
DescriptionUse GetLevels to return all child diagrams that have the specified diagram as their parent
Parameters
Name Type Direction Description
MapGUID string Input Unique map identifier
DiagramGUID string Input Unique diagramidentifier
ReturnsA value of type DiagramLevels.
RemarksIf the diagram cannot be found in the Process Repository then an EDiagramServiceError exception is thrown.
1.4.2 Complex Types
Complex TypesName Description
ActivityInfo A struct that describes a diagram activity
Attachment A struct that describes a diagram attachment
Attachments An array of Attachment structs
DiagramActivityInfo Encapsulates a DiagramInfo and ActivityInfostruct
DiagramInfo A struct to enscapsulate all available diagraminformation
DiagramLevel A struct that describes a diagram level
DiagramLevels An array of DiagramLevel structs
DiagramObjectInfo A struct that describes the common propertiesof a diagram object
DiagramObjectInfoArray Array of DiagramObjectInfo structs
IDiagramService 15
TIBCO Nimbus Web Services API Reference
Drilldown Struct for representing a diagram drilldown
Drilldowns An array of Drilldown structs.
Input A struct that represents an input flowline
Inputs Array of Input structs
Output A struct that represents an output flowline
Outputs Array of Output structs
Resource Struct representing a resource
Resources An array of Resource structs
StatementLink A struct represent a statement link
StatementLinks An array of StatementLink structs
ActivityInfo
DescriptionA struct that describes a diagram activity
Content ModelContains elements as defined in the following table.Component Type Description
ID int A grouping id that allows childobjects to be associated with aparent activity
ObjectID int An integer id that uniquelyidentifies the object within thediagram
GUID string The globally unique identifierfor an activity
Commentary string Contains any commentary thathas been added to the activity.Only plain text is returned bythe API. All formatting isremoved.
Inputs Inputs An array of flowlines that act asinputs to the activity
Outputs Outputs An array of flowlines that act asoutputs from the activity
Resources Resources An array of resources
Notes string Contains any popup notes thathave been added to thecommentary.Only plain text is returned bythe API. All formatting isremoved.Only plain text is returned by
TIBCO Nimbus Web Services API Reference16
TIBCO Nimbus Web Services API Reference
the API. All formatting isremoved.
Attachments Attachments An array of attachment items
DrillDowns Drilldowns An array of diagram drilldowns
StatementLinks StatementLinks An array of statement links
Text string The activity text.Only plain text is returned bythe API. All formatting isremoved.
Referenced By
Name Type
GetActivityInfo Method
Attachment
DescriptionA struct that describes a diagram attachment
Content ModelContains elements as defined in the following table.
Component Type Description
GUID string The attachment's globally unqiueid
Title string Attachment title
AttachmentType AttachmentType Attachment type
TargetID string Attachment target id.For registry attachments, thisvalue refers to the items id inthe registry
For data table attachments, thisvalue refers to the data tablelink id
Attachments
DescriptionAn array of Attachment structs
AttributesName Type Required? Default Description
arrayType string No http://schemas.nimbuspa
IDiagramService 17
TIBCO Nimbus Web Services API Reference
rtners.com/control/soap/:Attachment[]
offset arrayCoordinate No
id ID No
href anyURI No
DiagramActivityInfo
DescriptionEncapsulates a DiagramInfo and ActivityInfo struct
Content ModelContains elements as defined in the following table.
Component Type Description
DiagramInfo DiagramInfo Struct describing the specifiedactivity's parent diagram
ActivityInfo ActivityInfo Struct describing the specifiedactivity
Referenced By
Name Type
GetDiagramAndActivityInfo Method
DiagramInfo
DescriptionA struct to enscapsulate all available diagram information
Content ModelContains elements as defined in the following table.Component Type Description
MapName string Map name
DiagramTitle string Diagram title
Level string The level number for thediagram
Owner string User name for the diagramowner
Author string User name for the diagramauthor
Version string Diagram version number
GUID string Diagram unique identifier
TIBCO Nimbus Web Services API Reference18
TIBCO Nimbus Web Services API Reference
MapPath string Path to the diagram's parentmap
NotationType NotationType Defines the notation style usedby the diagram.
ParentGUID string Unique identifier of the parentdiagram
PrimaryContact PrimaryContact Defines which role is theprimary contact for the diagram.This can either be the Owner orthe Author
PreparedDate dateTime The date on which the diagramwas prepared
AuthStatus AuthStatus The diagram's currentauthorization status
MapType MapType Identifies the map type. eg :draft, master, archive etc.
ReviewDate dateTime Date of the last diagram review.This is only populated if arecurring review has been setup for the diagram
Template string Filename for the diagram'stemplate.
PercentDone int Percentage of the diagram thathas been completed
ModifiedDate dateTime Date that the diagram was lastmodified
ModifiedBy string User name of the person thatlast modified the diagram
Status string Diagram status. eg : promoted
VariantType VariantType Identifies whether the diagramis a process variant or not
WebServerURL string URL to the diagram
ObjectCount int Number of objects on thediagram
Objects DiagramObjectInfoArray An array of diagram objects
Referenced By
Name Type
GetDiagramInfo Method
DiagramLevel
DescriptionA struct that describes a diagram level
IDiagramService 19
TIBCO Nimbus Web Services API Reference
Content ModelContains elements as defined in the following table.
Component Type Description
DiagramGUID string Diagram GUID
DiagramTitle string Diagram title
LevelName string Diagram's level in the currentmap
DiagramLevels
DescriptionAn array of DiagramLevel structs
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:DiagramLevel[]
offset arrayCoordinate No
id ID No
href anyURI No
Referenced By
Name Type
GetLevels Method
DiagramObjectInfo
DescriptionA struct that describes the common properties of a diagram object
Content ModelContains elements as defined in the following table.Component Type Description
ID int ID used for grouping childobjects with parent activities
ObjectType ObjectType The type of diagram object
ObjectID int Unique identifier for an objectwithin the scope of a diagram
ObjectGUID string The globally unique identifier
TIBCO Nimbus Web Services API Reference20
TIBCO Nimbus Web Services API Reference
for an object
Text string Object display text
Top int y1 co-ordinate value
Left int x1 co-ordinate value
Bottom int y2 co-ordinate value
Right int x2 co-ordinate value
FillColor string Hex representation of object'sbackground color
LineColor string Hex representation of object'spen color
DiagramObjectInfoArray
DescriptionArray of DiagramObjectInfo structs
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:DiagramObjectInfo[]
offset arrayCoordinate No
id ID No
href anyURI No
Referenced By
Name Type
GetDiagramObjects Method
Drilldown
DescriptionStruct for representing a diagram drilldown
Content ModelContains elements as defined in the following table.Component Type Description
DrilldownGUID string Child diagram GUID
DrilldownType VariantType Process variant type
IDiagramService 21
TIBCO Nimbus Web Services API Reference
DrilldownTitle string Child diagram title
Drilldowns
DescriptionAn array of Drilldown structs.
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:Drilldown[]
offset arrayCoordinate No
id ID No
href anyURI No
Input
DescriptionA struct that represents an input flowline
Content ModelContains elements as defined in the following table.
Component Type Description
LineGUID string Unique identifier
ActivityGUID string Input/output activity GUID
Text string Line text
Referenced By
Name Type
Output Complex Type
Inputs
DescriptionArray of Input structs
AttributesName Type Required? Default Description
TIBCO Nimbus Web Services API Reference22
TIBCO Nimbus Web Services API Reference
arrayType string No http://schemas.nimbuspartners.com/control/soap/:Input[]
offset arrayCoordinate No
id ID No
href anyURI No
Output
DescriptionA struct that represents an output flowline
Content ModelContains elements as defined in the following table.
Component Type Description
LineGUID string Unique identifier
ActivityGUID string Input/output activity GUID
Text string Line text
Outputs
DescriptionArray of Output structs
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:Output[]
offset arrayCoordinate No
id ID No
href anyURI No
Resource
DescriptionStruct representing a resource
IDiagramService 23
TIBCO Nimbus Web Services API Reference
Content ModelContains elements as defined in the following table.
Component Type Description
ResID int Resource id
Name string Resource name
DisplayName string Resource display name
InfoField1 string Generic info field
InfoField2 string Generic info field
Visible boolean Identifies if resource is visiblewithin its parent activity
Status ResourceStatus Resource status/type
Resources
DescriptionAn array of Resource structs
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:Resource[]
offset arrayCoordinate No
id ID No
href anyURI No
StatementLink
DescriptionA struct represent a statement link
Content ModelContains elements as defined in the following table.
Component Type Description
StatementLinkID int Statement link id
SetName string Parent statement set's name
StatementName string Parent statement's name
Level string Level
TIBCO Nimbus Web Services API Reference24
TIBCO Nimbus Web Services API Reference
StatementLinks
DescriptionAn array of StatementLink structs
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:StatementLink[]
offset arrayCoordinate No
id ID No
href anyURI No
1.4.3 Simple Types
Simple Types
Name Description
AttachmentType An enumeration that describes the type of anattachment
AuthStatus An enumeration that describes the authorizationstatus for a diagram
MapType An enumeration that describes the type of mapthat the diagram is owned by.
NotationType An enumeration that describes the notation typeused by the diagram
ObjectType An enumeration that defines the type of a rootdiagram object
PrimaryContact An enumeration that describes which role is theprimary contact for a diagram
ResourceStatus An enumeration that describes the status of anactivity resource.
VariantType An enumeration that describes a process varianttype
Simple Type: AttachmentType
Description
IDiagramService 25
TIBCO Nimbus Web Services API Reference
An enumeration that describes the type of an attachment
Enumeration
Value Description
File Use for registry attachments, and also direct filelinks
URL Web address attachment
Email Email attachment type
DataTable A data table attachment
Diagram A Diagram attachment
IntWP An internal document attachment
IntImage An internal image attachment
MenuFunc A link to a Nimbus Author Client menu function
ExcelDataLink An Excel data link
Registry Not used
LineLink Line linker attachment
StoryboardLink A link to a storyboard
Scorecard A link to scorecard
SAPTransaction A link to an SAP transaction
Salesforce Salesforce attachment type
Oracle Oracle attachment type
Formvine Formvine attachment type
Tibbr Tibbr attachment type
Spotfire Spotfire attachment type
AMXBPM AMX BPM attachment type
Simple Type: AuthStatus
DescriptionAn enumeration that describes the authorization status for a diagram
Enumeration
Value Description
NotAuthorized Authorization has not been requested
AuthorizationPending Authorization pending
AuthorizedOK Authorization approved
NoAuthorizers No authorizers set up
Promote
Update
Simple Type: MapType
Description
TIBCO Nimbus Web Services API Reference26
TIBCO Nimbus Web Services API Reference
An enumeration that describes the type of map that the diagram is owned by.
Enumeration
Value Description
Draft A draft map
Master A master map
Scenario A scenario map
Archive An archived map
Template A template
Simple Type: NotationType
DescriptionAn enumeration that describes the notation type used by the diagram
Enumeration
Value Description
Simple Simple notation
BPM Business Process Model notation
Simple Type: ObjectType
DescriptionAn enumeration that defines the type of a root diagram object
Enumeration
Value Description
Unknown The object is of an unknown type
Activity An activity
Line A flowline (either straight or dog-leg)
FreeText A text box
Image An image
SignPost A signpost
Simple Type: PrimaryContact
DescriptionAn enumeration that describes which role is the primary contact for a diagram
Enumeration
Value Description
Owner The owner is the primary contact
Author The author is the primary contact
Simple Type: ResourceStatus
IDiagramService 27
TIBCO Nimbus Web Services API Reference
DescriptionAn enumeration that describes the status of an activity resource.
Enumeration
Value Description
Unknown The resource is of an unknown status
CentralResource The resource is from the central resource library
LocalResource The resource is local to a process map
OverridenResource The resource is from the central library, but hasbeen overriden in a process map
Simple Type: VariantType
DescriptionAn enumeration that describes a process variant type
EnumerationValue Description
Standard Diagram is part of the standard process
Variant Diagram is part of a process variant
TIBCO Nimbus Web Services API Reference28
TIBCO Nimbus Web Services API Reference
1.5 IDataTableService
DescriptionIDataTableService contains methods for working with data tables and data table attachments.
RemarksThe methods of IDataTableService only allow you to edit records in an existing data table. It does notcurrently allow you to attach a new table to a diagram.All data table operations are done in the context of the currently signed-in user, so if that user does not havesufficient access rights an EDataTableServiceError exception will be thrown.
See AlsoMethods | Complex Types | Simple Types
1.5.1 Methods
MethodsName Description
AddDataTableRecord Use AddDataTableRecord to add a new record toan existing data table attachment
CreateEmptyRecord Use CreateEmptyRecord when working with datatables that are being used to extend the fieldsavailable in a Change Request or Action.
CreateEmptyRecordForAttachment Use CreateEmptyRecordForAttachment whenworking with data tables that are attached to anactivity.
DeleteDataTableRecord Use DeleteDataTableRecord to remove anexisting record from a data table attachment
GetDataTable Use GetDataTable to retrieve a data tableattachment and all of its records
GetDataTableDefinition Use GetDataTableDefinition to retrieve the fulldefinition of a data table for a given tabledefinition id.
GetDataTableDefinitionByLinkID Use GetDataTableDefinitionByLinkID to retrievethe full definition of a data table for a data tablelink id.
GetDataTableRecord Use GetDataTableRecord to retrieve a singlerecord from a data table attachment.
GetDataTableRecords Use GetDataTableRecords to retrieve a range ofrecords from a data table attachment.
GetPopupList Use GetPopupList to retrieve a list and its listitems.
IDataTableService 29
TIBCO Nimbus Web Services API Reference
UpdateDataTableRecord Use UpdateDataTableRecord to update anexisting record in a data table attachment
AddDataTableRecord
DescriptionUse AddDataTableRecord to add a new record to an existing data table attachment
Parameters
Name Type Direction Description
TableLinkID int Input The link id for anexisting data tableattachment. This can beretrieved from theTargetID property of adata table Attachment.
TableRecord DataTableRecord Input A struct containing allthe required data tablefield values
ReturnsA value of type DataTableRecord having the structure defined by the following table.
Name Type Description
RecordID int Primary key for the record.
Fields DataTableFields Array of data table fields.
Created DataRecordAudit An audit struct containing thedate/time the record wascreated, and the user name ofthe user that created.
LastModified DataRecordAudit An audit struct containing thedate/time the record was lastupdated, and the user name ofthe user that performed theupdate.
RemarksThe TableRecord will be validated by the AddDataTableRecord method and any missing or invalid values willcause an EDataTableServiceError exception to be thrown.When the record is saved any calculated fields are refreshsed and any default field values are applied. Themethod then returns an updated copy of the record.
CreateEmptyRecord
Description
TIBCO Nimbus Web Services API Reference30
TIBCO Nimbus Web Services API Reference
Use CreateEmptyRecord when working with data tables that are being used to extend the fields available in aChange Request or Action.
Parameters
Name Type Direction Description
TableDefID int Input Data table definition id
ReturnsA value of type DataTableRecord having the structure defined by the following table.
Name Type Description
RecordID int Primary key for the record.
Fields DataTableFields Array of data table fields.
Created DataRecordAudit An audit struct containing thedate/time the record wascreated, and the user name ofthe user that created.
LastModified DataRecordAudit An audit struct containing thedate/time the record was lastupdated, and the user name ofthe user that performed theupdate.
RemarksCreateEmptyRecord returns a fully formed DataTableRecord struct. In addition any default field values willhave been applied.
CreateEmptyRecordForAttachment
DescriptionUse CreateEmptyRecordForAttachment when working with data tables that are attached to an activity.
Parameters
Name Type Direction Description
TableLinkID int Input The data table link id.This can be obtainedfrom the TargetIDproperty of a data tableattachment
ReturnsA value of type DataTableRecord having the structure defined by the following table.Name Type Description
RecordID int Primary key for the record.
Fields DataTableFields Array of data table fields.
Created DataRecordAudit An audit struct containing the
IDataTableService 31
TIBCO Nimbus Web Services API Reference
date/time the record wascreated, and the user name ofthe user that created.
LastModified DataRecordAudit An audit struct containing thedate/time the record was lastupdated, and the user name ofthe user that performed theupdate.
RemarksCreateEmptyRecordForAttachment returns a fully formed DataTableRecord struct. In addition any default fieldvalues will have been applied.
DeleteDataTableRecord
DescriptionUse DeleteDataTableRecord to remove an existing record from a data table attachment
Parameters
Name Type Direction Description
TableLinkID int Input The table link id. Thiscan be retrieved formthe TargetID property ofa data tableattachment.
RecordID int Input Id of record to delete
ReturnsA value of type boolean.
RemarksAn EDataTableServiceError exception will be thrown if the record cannot be located in the data table
GetDataTable
DescriptionUse GetDataTable to retrieve a data table attachment and all of its records
ParametersName Type Direction Description
TableLinkID int Input The table link id. Thiscan be retrieved formthe TargetID property ofa data tableattachment.
TIBCO Nimbus Web Services API Reference32
TIBCO Nimbus Web Services API Reference
ReturnsA value of type DataTable having the structure defined by the following table.
Name Type Description
TableID int The data table id
TableDefID int The data table definition id
Name string The table name
Comments string Additional comments
Version int Table definition version
IsEmpty boolean Denotes whether the table isempty or not
Records DataTableRecords An array of DataTableRecordstructs
GetDataTableDefinition
DescriptionUse GetDataTableDefinition to retrieve the full definition of a data table for a given table definition id.
Parameters
Name Type Direction Description
TableDefID int Input The table definition toretrieve
IncludePopupLists boolean Input If set to true then theDataTableDef.PopupLists property will bepopulated with all liststhat are referenced bythe table definition
ReturnsA value of type DataTableDef having the structure defined by the following table.
Name Type Description
TableDefID int The table definition id
Name string The table name
FieldDefs DataTableFieldDefs An array of DataTableFieldstructs that define the fieldsthat make up the table
Lists PopupLists An array of PopupList structsthat define the lists referencedby the table
Comment string Additional comments
Version int Table definition version
IDataTableService 33
TIBCO Nimbus Web Services API Reference
GetDataTableDefinitionByLinkID
DescriptionUse GetDataTableDefinitionByLinkID to retrieve the full definition of a data table for a data table link id.
Parameters
Name Type Direction Description
TableLinkID int Input The table link id. Thiscan be retrieved formthe TargetID property ofa data tableattachment.
IncludePopupLists boolean Input If set to true then theDataTableDef.PopupLists property will bepopulated with all liststhat are referenced bythe table definition
ReturnsA value of type DataTableDef having the structure defined by the following table.
Name Type Description
TableDefID int The table definition id
Name string The table name
FieldDefs DataTableFieldDefs An array of DataTableFieldstructs that define the fieldsthat make up the table
Lists PopupLists An array of PopupList structsthat define the lists referencedby the table
Comment string Additional comments
Version int Table definition version
GetDataTableRecord
DescriptionUse GetDataTableRecord to retrieve a single record from a data table attachment.
ParametersName Type Direction Description
TableLinkID int Input The table link id. Thiscan be retrieved formthe TargetID property of
TIBCO Nimbus Web Services API Reference34
TIBCO Nimbus Web Services API Reference
a data tableattachment.
RecordID int Input Id of record to retrieve
ReturnsA value of type DataTableRecord having the structure defined by the following table.
Name Type Description
RecordID int Primary key for the record.
Fields DataTableFields Array of data table fields.
Created DataRecordAudit An audit struct containing thedate/time the record wascreated, and the user name ofthe user that created.
LastModified DataRecordAudit An audit struct containing thedate/time the record was lastupdated, and the user name ofthe user that performed theupdate.
RemarksAn EDataTableServiceError exception to be thrown if the specified RecordID does not exist.
GetDataTableRecords
DescriptionUse GetDataTableRecords to retrieve a range of records from a data table attachment.
Parameters
Name Type Direction Description
TableLinkID int Input The table link id. Thiscan be retrieved formthe TargetID property ofa data tableattachment.
StartRecordIndex int Input Index of the first recordto retrieve from thetable
RecordCount int Input Maximum number ofrecords to retrieve fromthe table
ReturnsA value of type DataTableRecords.
IDataTableService 35
TIBCO Nimbus Web Services API Reference
GetPopupList
DescriptionUse GetPopupList to retrieve a list and its list items.
Parameters
Name Type Direction Description
ListID int Input Id of list to retrieve
ReturnsA value of type PopupList having the structure defined by the following table.
Name Type Description
ListID int List id
Name string List name
ParentListID int Parent list id (this is used whenconstraining list values)
Items PopupListItems Array of list items
UpdateDataTableRecord
DescriptionUse UpdateDataTableRecord to update an existing record in a data table attachment
Parameters
Name Type Direction Description
TableLinkID int Input The table link id. Thiscan be retrieved formthe TargetID property ofa data tableattachment.
TableRecord DataTableRecord Input Id of record to update
ReturnsA value of type DataTableRecord having the structure defined by the following table.Name Type Description
RecordID int Primary key for the record.
Fields DataTableFields Array of data table fields.
Created DataRecordAudit An audit struct containing thedate/time the record wascreated, and the user name ofthe user that created.
LastModified DataRecordAudit An audit struct containing thedate/time the record was lastupdated, and the user name of
TIBCO Nimbus Web Services API Reference36
TIBCO Nimbus Web Services API Reference
the user that performed theupdate.
RemarksAn EDataTableServiceError exception to be thrown if the specified RecordID does not exist.
1.5.2 Complex Types
Complex Types
Name Description
DataRecordAudit Struct representing a data record audit field
DataTable Struct representing a data table
DataTableDef Struct representing a data table definition
DataTableField Struct representing a field in a data table record
DataTableFieldDef Struct representing a data table field definition
DataTableFieldDefs Array of DataTableFieldDef structs.
DataTableFields Array of DataTableField structs.
DataTableRecord Struct representing a data table record
DataTableRecords Array of DataTableRecord structs
PopupList Struct representing a popup list.
PopupListItem Struct representing an individual list item
PopupListItems Array of PopupListItem structs
PopupLists Array of PopupList structs
DataRecordAudit
DescriptionStruct representing a data record audit field
Content ModelContains elements as defined in the following table.
Component Type Description
Username string Name of user that made thechange
Timestamp dateTime Timestamp for the change
RemarksEach DataTableRecord has two instances of DataRecordAudit. One for when the record was created andanother for when it was last updated.
IDataTableService 37
TIBCO Nimbus Web Services API Reference
DataTable
DescriptionStruct representing a data table
Content ModelContains elements as defined in the following table.
Component Type Description
TableID int The data table id
TableDefID int The data table definition id
Name string The table name
Comments string Additional comments
Version int Table definition version
IsEmpty boolean Denotes whether the table isempty or not
Records DataTableRecords An array of DataTableRecordstructs
Referenced By
Name Type
GetDataTable Method
DataTableDef
DescriptionStruct representing a data table definition
Content ModelContains elements as defined in the following table.
Component Type Description
TableDefID int The table definition id
Name string The table name
FieldDefs DataTableFieldDefs An array of DataTableFieldstructs that define the fieldsthat make up the table
Lists PopupLists An array of PopupList structsthat define the lists referencedby the table
Comment string Additional comments
Version int Table definition version
Referenced ByName Type
TIBCO Nimbus Web Services API Reference38
TIBCO Nimbus Web Services API Reference
GetDataTableDefinition Method
GetDataTableDefinitionByLinkID Method
DataTableField
DescriptionStruct representing a field in a data table record
Content ModelContains elements as defined in the following table.
Component Type Description
FieldDefID int Reference to a DataTableFieldDef
DataType FieldDataType Field data type
Value string Field value
DisplayValue string Field display value
IsNull boolean Is field null
IsError boolean Is field in error (used forcalculated fields)
DataTableFieldDef
DescriptionStruct representing a data table field definition
Content ModelContains elements as defined in the following table.Component Type Description
FieldDefID int Field definition id
FieldName string Field display name
DataType FieldDataType Field data type
DecPlaces int Number of decimal places touse when displaying a numericvalue
DispLeft boolean Position to place the UnitsOfvalue. If true then UnitsOf isplaced to the left of the fieldvalue when the display value isgenerated
PopupListID int Reference to a popup list. See PopupList for details.
ParentFieldID int Parent field id
IDataTableService 39
TIBCO Nimbus Web Services API Reference
Expression string Expression to use for calculatedfields
Required boolean Denotes if field is mandatory
NotNull boolean Denotes if field is nullable
Visible boolean Denotes if field is visible in theAuthor Client summary panel
UnitsOf string Units display label
DefaultToday boolean Default to today's date. Only foruse with date fields
DefaultCurrentUser boolean Default to current user. Only foruse with user fields
DataTableFieldDefs
DescriptionArray of DataTableFieldDef structs.
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:DataTableFieldDef[]
offset arrayCoordinate No
id ID No
href anyURI No
DataTableFields
DescriptionArray of DataTableField structs.
AttributesName Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:DataTableField[]
offset arrayCoordinate No
id ID No
TIBCO Nimbus Web Services API Reference40
TIBCO Nimbus Web Services API Reference
href anyURI No
DataTableRecord
DescriptionStruct representing a data table record
Content ModelContains elements as defined in the following table.
Component Type Description
RecordID int Primary key for the record.
Fields DataTableFields Array of data table fields.
Created DataRecordAudit An audit struct containing thedate/time the record wascreated, and the user name ofthe user that created.
LastModified DataRecordAudit An audit struct containing thedate/time the record was lastupdated, and the user name ofthe user that performed theupdate.
Referenced By
Name Type
AddDataTableRecord Method
CreateEmptyRecord Method
CreateEmptyRecordForAttachment Method
GetDataTableRecord Method
UpdateDataTableRecord Method
DataTableRecords
DescriptionArray of DataTableRecord structs
AttributesName Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:DataTableRecord[]
offset arrayCoordinate No
IDataTableService 41
TIBCO Nimbus Web Services API Reference
id ID No
href anyURI No
Referenced By
Name Type
GetDataTableRecords Method
PopupList
DescriptionStruct representing a popup list.
Content ModelContains elements as defined in the following table.
Component Type Description
ListID int List id
Name string List name
ParentListID int Parent list id (this is used whenconstraining list values)
Items PopupListItems Array of list items
Referenced By
Name Type
GetPopupList Method
PopupListItem
DescriptionStruct representing an individual list item
Content ModelContains elements as defined in the following table.
Component Type Description
ItemID int Item id
Name string Display value
ParentItemID int Parent id
PopupListItems
DescriptionArray of PopupListItem structs
TIBCO Nimbus Web Services API Reference42
TIBCO Nimbus Web Services API Reference
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:PopupListItem[]
offset arrayCoordinate No
id ID No
href anyURI No
PopupLists
DescriptionArray of PopupList structs
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:PopupList[]
offset arrayCoordinate No
id ID No
href anyURI No
1.5.3 Simple Types
Simple Types
Name Description
FieldDataType Enumeration that represents the type of datathat a field can contain
Simple Type: FieldDataType
DescriptionEnumeration that represents the type of data that a field can contain
Enumeration
IDataTableService 43
TIBCO Nimbus Web Services API Reference
Value Description
Alpha Can store alphanumeric text
Integer Can store integer values
Decimal Can store decimal values
Date Can store date values
Time Can store time values
TrueFalse Can store either True or False
YesNo Can store either Yes or No
OnOff Can store either On or Off
PopupList Can store values available in a popup list
ShortAlpha Can store an alphanumeric string up to 250characters
User Can store a reference to a user
UserGroup Can store a reference to a user group
Resource Can store a reference to a resource
ResourceGroup Can store a reference to a resource group
Calculated Calculated values. These are updated internallyby Nimbus
URL Can store a URL
TIBCO Nimbus Web Services API Reference44
TIBCO Nimbus Web Services API Reference
1.6 IActionService
DescriptionUse the IActionService to create a new Action for a diagram.
RemarksIActionService currently only allow you to create actions for diagrams and also stand-alone actions (ie : thosethat have no host object).All operations are done in the context of the currently signed-in user, so if that user does not have sufficientaccess rights an EActionServiceError exception will be thrown.
See AlsoMethods | Complex Types | Simple Types
1.6.1 Methods
MethodsName Description
CreateNewAction Use CreateNewAction to create an action that isnot attached to any particular host object.
CreateNewDiagramAction Use CreateNewDiagramAction to create anaction that is attached to a particular diagram.
GetAdditionalFieldsTableDefID Use this method to lookup the id of the datatable definition that is used to extend the fieldsavailable in an action
GetAssigneeStatuses Use GetAssigneeStatues to return an array of allconfigured assignee statuses.
GetCategoryDetails Use GetCategoryDetails to retrieve extendedinformation about an action category
GetCategoryNames Use GetCategoryNames to return a list of allaction categories
GetCategoryNamesForHost Use GetCategoryNamesForHost to return a listof all categories that support a particular host
GetOwnerStatuses Use GetOwnerStatues to return an array of allconfigured owner statuses.
GetTimeZones
PrepareNewAction Use PrepareNewAction to create a new CreateAction struct ready for submission toCreateNewAction
PrepareNewDiagramAction Use PrepareNewDiagramAction to create a newCreateDiagramAction struct ready forsubmission to CreateNewAction
IActionService 45
TIBCO Nimbus Web Services API Reference
CreateNewAction
DescriptionUse CreateNewAction to create an action that is not attached to any particular host object.
Parameters
Name Type Direction Description
Request CreateAction Input Input fields required tocreate a new action
ReturnsA value of type CreateActionResult having the structure defined by the following table.
Name Type Description
ActionGroupID int Action group id
Subject string Action subject
HostName string Description of the action host
CreateNewDiagramAction
DescriptionUse CreateNewDiagramAction to create an action that is attached to a particular diagram.
Parameters
Name Type Direction Description
Request CreateDiagramAction Input Input fields required tocreate a new diagramaction
ReturnsA value of type CreateActionResult having the structure defined by the following table.
Name Type Description
ActionGroupID int Action group id
Subject string Action subject
HostName string Description of the action host
GetAdditionalFieldsTableDefID
DescriptionUse this method to lookup the id of the data table definition that is used to extend the fields available in anaction
TIBCO Nimbus Web Services API Reference46
TIBCO Nimbus Web Services API Reference
ReturnsA value of type int.
RemarksOnce the data table definition id has been retrieved it can then be subsequently used by IDataTableService.GetDataTableDefinition to retrieve the full table structure.
GetAssigneeStatuses
DescriptionUse GetAssigneeStatues to return an array of all configured assignee statuses.
ReturnsA value of type ActionStatuses.
Remarks
GetCategoryDetails
DescriptionUse GetCategoryDetails to retrieve extended information about an action category
Parameters
Name Type Direction Description
CategoryName string Input Category name to lookup
ReturnsA value of type ActionCategory having the structure defined by the following table.
Name Type Description
Name string Category name
OwnerFieldsTableDefID int Which data table to use forowner category fields
GetCategoryNames
DescriptionUse GetCategoryNames to return a list of all action categories
ReturnsA value of type StringArray.
IActionService 47
TIBCO Nimbus Web Services API Reference
GetCategoryNamesForHost
DescriptionUse GetCategoryNamesForHost to return a list of all categories that support a particular host
Parameters
Name Type Direction Description
HostType HostType Input Specifies whichHostType an actioncategory must supportfor it to be included inthe method output
ReturnsA value of type StringArray.
GetOwnerStatuses
DescriptionUse GetOwnerStatues to return an array of all configured owner statuses.
ReturnsA value of type ActionStatuses.
RemarksUse the values returned by the array to determine what OwnerStatusID should be assigned to a new action
GetTimeZones
ReturnsA value of type TimeZones.
PrepareNewAction
DescriptionUse PrepareNewAction to create a new CreateAction struct ready for submission to CreateNewAction
ParametersName Type Direction Description
ActionCategory string Input Action category to usefor default values. If novalue is supplied thenNimbus will use the
TIBCO Nimbus Web Services API Reference48
TIBCO Nimbus Web Services API Reference
most appropriatedefault.
ReturnsA value of type CreateAction having the structure defined by the following table.
Name Type Description
Category string Category to assign to the newaction
Subject string Action subject
Notes string Action notes/comments
Priority ActionPriority Action priority
Owner User Action owner. Either the id orthe name property need to bepopulated when creating a newaction
Assignees UserListItems Array of users/groups to assignthe action to
Editors UserListItems Array of users/groups that havethe ability to edit the action
Viewers UserListItems Array of users/groups that havethe ability to view the action
StartDate date Action start date
DueDate ActionDate Action due date
OneClickCompletion boolean Determines if the action groupcan be completed by just oneuser
OwnerStatusID int Status id for the action group.This determines if the actiongroup is active or completed
Reminder Reminder Reminder & escalation settings
OwnerCategoryFields DataTableRecord Field values for the ownercategory data table
AdditionalFields DataTableRecord Field values for the data tableused to extend an action record
PrepareNewDiagramAction
DescriptionUse PrepareNewDiagramAction to create a new CreateDiagramAction struct ready for submission toCreateNewAction
ParametersName Type Direction Description
IActionService 49
TIBCO Nimbus Web Services API Reference
MapGUID string Input Unique map identifier
DiagramGUID string Input Unique diagramidentifier
ActionCategory string Input Action category to usefor default values. If novalue is supplied thenNimbus will use themost appropriatedefault.
ReturnsA value of type CreateDiagramAction having the structure defined by the following table.
Name Type Description
Category string Category to assign to the newaction
Subject string Action subject
Notes string Action notes/comments
Priority ActionPriority Action priority
Owner User Action owner. Either the id orthe name property need to bepopulated when creating a newaction
Assignees UserListItems Array of users/groups to assignthe action to
Editors UserListItems Array of users/groups that havethe ability to edit the action
Viewers UserListItems Array of users/groups that havethe ability to view the action
StartDate date Action start date
DueDate ActionDate Action due date
OneClickCompletion boolean Determines if the action groupcan be completed by just oneuser
OwnerStatusID int Status id for the action group.This determines if the actiongroup is active or completed
Reminder Reminder Reminder & escalation settings
OwnerCategoryFields DataTableRecord Field values for the ownercategory data table
AdditionalFields DataTableRecord Field values for the data tableused to extend an action record
MapGUID string Map unique id
DiagramGUID string Diagram unique id
TIBCO Nimbus Web Services API Reference50
TIBCO Nimbus Web Services API Reference
1.6.2 Complex Types
Complex Types
Name Description
ActionCategory Struct representing an action category
ActionDate Struct representing an action date/time
ActionStatus Struct representing an action status
ActionStatuses Array of ActionStatus structs
CreateAction Struct used to pass required information to the CreateNewAction method.
CreateActionResult Struct returned by the Create Action methods ifthe create operation was successful
CreateDiagramAction Struct used to pass required information to the CreateNewDiagramAction method.
Reminder Struct that represents the reminder options usedwhen creating a new action
TimeZone Struct that represents a time zone
TimeZones Array of TimeZone structs
User Struct that represents a Nimbus user account
UserListItems An array of users and user groups
UserOrGroup Struct that represents either a user or a usergroup
ActionCategory
DescriptionStruct representing an action category
Content ModelContains elements as defined in the following table.
Component Type Description
Name string Category name
OwnerFieldsTableDefID int Which data table to use forowner category fields
Referenced By
Name Type
GetCategoryDetails Method
IActionService 51
TIBCO Nimbus Web Services API Reference
ActionDate
DescriptionStruct representing an action date/time
Content ModelContains elements as defined in the following table.
Component Type Description
DateTime dateTime The date/time local to thespecified timezone
TimeZone TimeZone The timezone for the date/time
ActionStatus
DescriptionStruct representing an action status
Content ModelContains elements as defined in the following table.
Component Type Description
ID int Status id
Name string Status name
Description string Status description
StatusType ActionStatusType Status type
NotesRequired boolean
ActionStatuses
DescriptionArray of ActionStatus structs
AttributesName Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:ActionStatus[]
offset arrayCoordinate No
id ID No
href anyURI No
TIBCO Nimbus Web Services API Reference52
TIBCO Nimbus Web Services API Reference
Referenced By
Name Type
GetAssigneeStatuses Method
GetOwnerStatuses Method
CreateAction
DescriptionStruct used to pass required information to the CreateNewAction method.
Content ModelContains elements as defined in the following table.Component Type Description
Category string Category to assign to the newaction
Subject string Action subject
Notes string Action notes/comments
Priority ActionPriority Action priority
Owner User Action owner. Either the id orthe name property need to bepopulated when creating a newaction
Assignees UserListItems Array of users/groups to assignthe action to
Editors UserListItems Array of users/groups that havethe ability to edit the action
Viewers UserListItems Array of users/groups that havethe ability to view the action
StartDate date Action start date
DueDate ActionDate Action due date
OneClickCompletion boolean Determines if the action groupcan be completed by just oneuser
OwnerStatusID int Status id for the action group.This determines if the actiongroup is active or completed
Reminder Reminder Reminder & escalation settings
OwnerCategoryFields DataTableRecord Field values for the ownercategory data table
AdditionalFields DataTableRecord Field values for the data tableused to extend an action record
IActionService 53
TIBCO Nimbus Web Services API Reference
Referenced By
Name Type
CreateDiagramAction Complex Type
CreateNewAction Method
PrepareNewAction Method
CreateActionResult
DescriptionStruct returned by the Create Action methods if the create operation was successful
Content ModelContains elements as defined in the following table.
Component Type Description
ActionGroupID int Action group id
Subject string Action subject
HostName string Description of the action host
Referenced By
Name Type
CreateNewAction Method
CreateNewDiagramAction Method
CreateDiagramAction
DescriptionStruct used to pass required information to the CreateNewDiagramAction method.
Content ModelContains elements as defined in the following table.Component Type Description
Category string Category to assign to the newaction
Subject string Action subject
Notes string Action notes/comments
Priority ActionPriority Action priority
Owner User Action owner. Either the id orthe name property need to bepopulated when creating a newaction
Assignees UserListItems Array of users/groups to assign
TIBCO Nimbus Web Services API Reference54
TIBCO Nimbus Web Services API Reference
the action to
Editors UserListItems Array of users/groups that havethe ability to edit the action
Viewers UserListItems Array of users/groups that havethe ability to view the action
StartDate date Action start date
DueDate ActionDate Action due date
OneClickCompletion boolean Determines if the action groupcan be completed by just oneuser
OwnerStatusID int Status id for the action group.This determines if the actiongroup is active or completed
Reminder Reminder Reminder & escalation settings
OwnerCategoryFields DataTableRecord Field values for the ownercategory data table
AdditionalFields DataTableRecord Field values for the data tableused to extend an action record
MapGUID string Map unique id
DiagramGUID string Diagram unique id
Referenced By
Name Type
CreateNewDiagramAction Method
PrepareNewDiagramAction Method
Reminder
DescriptionStruct that represents the reminder options used when creating a new action
Content ModelContains elements as defined in the following table.Component Type Description
EnableEmailReminders boolean Determines whether emailreminders are enabled
EnableSMSReminders boolean Determines whether SMSreminders are enabled
SendEvery int Determines how often (in days)a reminder is sent
SendStart int Determines how many daysbefore an action is due beforesending out reminder emails
IActionService 55
TIBCO Nimbus Web Services API Reference
EnableEscalations boolean Determines if an overdue actionis escalated to the owner's linemanager
EscalateAfter int Determines how many days anitem is overdue before it isescalated
TimeZone
DescriptionStruct that represents a time zone
Content ModelContains elements as defined in the following table.
Component Type Description
ID int Timezone id
Name string Timezone name
DisplayName string Timezone display name
UtcOffsetInMins int Number of minutes differencefrom UTC
TimeZones
DescriptionArray of TimeZone structs
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:TimeZone[]
offset arrayCoordinate No
id ID No
href anyURI No
Referenced By
Name Type
GetTimeZones Method
TIBCO Nimbus Web Services API Reference56
TIBCO Nimbus Web Services API Reference
User
DescriptionStruct that represents a Nimbus user account
Content ModelContains elements as defined in the following table.
Component Type Description
ID int Item id
Name string Item Name
DisplayName string Item display name
Referenced By
Name Type
UserOrGroup Complex Type
UserListItems
DescriptionAn array of users and user groups
Attributes
Name Type Required? Default Description
arrayType string No http://schemas.nimbuspartners.com/control/soap/:UserOrGroup[]
offset arrayCoordinate No
id ID No
href anyURI No
UserOrGroup
DescriptionStruct that represents either a user or a user group
Content ModelContains elements as defined in the following table.Component Type Description
ID int Item id
Name string Item Name
IActionService 57
TIBCO Nimbus Web Services API Reference
DisplayName string Item display name
IsGroup boolean Is the item a user or a usergroup
1.6.3 Simple Types
Simple Types
Name Description
ActionPriority Enumeration that describes the priority of anaction
ActionStatusType Enumeration describing the function of an actionstatus
HostType Enumeration that describes the type of hostobject that an action is assigned to
Simple Type: ActionPriority
DescriptionEnumeration that describes the priority of an action
Enumeration
Value Description
High High priority action
Medium Medium priority action
Low Low priority action
Simple Type: ActionStatusType
DescriptionEnumeration describing the function of an action status
Enumeration
Value Description
Active Action status represents an active state
Completed Action status represents a completed state
Close Action status represents a closed state
Deleted Action status represents a deleted state
Simple Type: HostType
DescriptionEnumeration that describes the type of host object that an action is assigned to
TIBCO Nimbus Web Services API Reference58
TIBCO Nimbus Web Services API Reference
Enumeration
Value Description
None Action has no host
Diagram Action is assigned to a diagram
Document Action is assigned to a document
Metric Action is assigned to a metric item
Storyboard Action is assigned to a storyboard
Statement Action is assigned to a statement
StatementLink Action is assigned to a statement link
StatementAudit Action is assigned to a statement audit
StatementLinkAudit Action is assigned to a statement link audit
StatementSet Action is assigned to a statement set
Topic Action is assigned to a topic
Referenced By
Name Type
GetCategoryNamesForHost Method
RemarksNote, that only the values None and Diagram are currently supported.
IChangeRequestService 59
TIBCO Nimbus Web Services API Reference
1.7 IChangeRequestService
DescriptionUse the IChangeRequestService to create a new Change Request for a diagram.
RemarksIChangeRequestService currently only allows you to create change requests for a diagram. It does not allowyou to create CRs for registry items and it also does not allow for fetching or editing of existing CRs.All operations are done in the context of the currently signed-in user, so if that user does not have sufficientaccess rights an EChangeRequestServiceError exception will be thrown.
See AlsoMethods | Complex Types
1.7.1 Methods
Methods
Name Description
CreateNewDiagramCR Use CreateNewDiagramCR to create and attacha new CR to a diagram
GetChangeRequestTableDefinitionID Use this method to lookup the id of the datatable definition that is used to extend the fieldsavailable in a change request.
PrepareNewDiagramCR Use PrepareNewDiagramCR to create an empty CreateDiagramChangeRequest struct that canbe populated and then passed to CreateNewDiagramCR
CreateNewDiagramCR
DescriptionUse CreateNewDiagramCR to create and attach a new CR to a diagram
Parameters
Name Type Direction Description
Request CreateDiagramChangeRequest
Input A struct containing thedetails required for anew CR
ReturnsA value of type CreateChangeRequestResult having the structure defined by the following table.
TIBCO Nimbus Web Services API Reference60
TIBCO Nimbus Web Services API Reference
Name Type Description
Reference string The unique reference for thenewly created CR. eg : CR0001
UniqueID int The primary key for the CR
AssignedUserID int ID of the user that the CR isinitially assigned to
AssignedUserName string Name of the user that the CR isinitially assigned to
HostName string Description of the diagram thatthe CR is attached to
RemarksWhen the CR is submitted to the API it is validated and the user context is checked to ensure that it has theappropriate privileges.The API then creates a new CR record and if appropriate ensures that it is synchronised between draft andmaster diagrams. The CR is then assigned to the diagram owner for review. An email is issued and an item isadded to the user's to-do list.
GetChangeRequestTableDefinitionID
DescriptionUse this method to lookup the id of the data table definition that is used to extend the fields available in achange request.
ReturnsA value of type int.
RemarksOnce the data table definition id has been retrieved it can then be subsequently used by IDataTableService.GetDataTableDefinition to retrieve the full table structure.
PrepareNewDiagramCR
DescriptionUse PrepareNewDiagramCR to create an empty CreateDiagramChangeRequest struct that can be populatedand then passed to CreateNewDiagramCR
Parameters
Name Type Direction Description
MapGUID string Input Map id
DiagramGUID string Input Diagram id
ReturnsA value of type CreateDiagramChangeRequest having the structure defined by the following table.
IChangeRequestService 61
TIBCO Nimbus Web Services API Reference
Name Type Description
MapGUID string Map id
DiagramGUID string Diagram id
Notes string Change request notes.
Fields DataTableRecord Change request fields. See DataTableRecord for more info
1.7.2 Complex Types
Complex Types
Name Description
CreateChangeRequestResult CreateChangeRequestResult contains usefulinformation about a newly created CR.
CreateDiagramChangeRequest CreateDiagramChangeRequest is used to passthe details of a change request to the CreateNewDiagramCR method
CreateChangeRequestResult
DescriptionCreateChangeRequestResult contains useful information about a newly created CR.
Content ModelContains elements as defined in the following table.
Component Type Description
Reference string The unique reference for thenewly created CR. eg : CR0001
UniqueID int The primary key for the CR
AssignedUserID int ID of the user that the CR isinitially assigned to
AssignedUserName string Name of the user that the CR isinitially assigned to
HostName string Description of the diagram thatthe CR is attached to
Referenced By
Name Type
CreateNewDiagramCR Method
TIBCO Nimbus Web Services API Reference62
TIBCO Nimbus Web Services API Reference
CreateDiagramChangeRequest
DescriptionCreateDiagramChangeRequest is used to pass the details of a change request to the CreateNewDiagramCRmethod
Content ModelContains elements as defined in the following table.
Component Type Description
MapGUID string Map id
DiagramGUID string Diagram id
Notes string Change request notes.
Fields DataTableRecord Change request fields. See DataTableRecord for more info
Referenced By
Name Type
CreateNewDiagramCR Method
PrepareNewDiagramCR Method
63INDEX
Index- A -ActionCategory 50
ActionDate 51
ActionPriority 57
ActionStatus 51
ActionStatuses 51
ActionStatusType 57
ActivityInfo 15
AddDataTableRecord 29
Attachment 16
Attachments 16
AttachmentType 24
Authentication 6
AuthStatus 25
- C -Complex Types 14, 36, 50, 61
CreateAction 52
CreateActionResult 53
CreateChangeRequestResult 61
CreateDiagramAction 53
CreateDiagramChangeRequest 62
CreateEmptyRecord 29
CreateEmptyRecordForAttachment 30
CreateNewAction 45
CreateNewDiagramAction 45
CreateNewDiagramCR 59
- D -DataRecordAudit 36
DataTable 37
DataTableDef 37
DataTableField 38
DataTableFieldDef 38
DataTableFieldDefs 39
DataTableFields 39
DataTableRecord 40
DataTableRecords 40
DeleteDataTableRecord 31
DiagramActivityInfo 17
DiagramInfo 17
DiagramLevel 18
DiagramLevels 19
DiagramObjectInfo 19
DiagramObjectInfoArray 20
Drilldown 20
Drilldowns 21
- E -Enabling the API 5
- F -FieldDataType 42
- G -GetActivityInfo 9
GetAdditionalFieldsTableDefID 45
GetAssigneeStatuses 46
GetCategoryDetails 46
GetCategoryNames 46
GetCategoryNamesForHost 47
GetChangeRequestTableDefinitionID 60
GetDataTable 31
GetDataTableDefinition 32
GetDataTableDefinitionByLinkID 33
GetDataTableRecord 33
GetDataTableRecords 34
GetDiagramAndActivityInfo 11
GetDiagramInfo 11
GetDiagramObjectCount 13
GetDiagramObjects 13
GetDiagramTitle 13
GetLevels 14
GetMapGUID 7
GetOwnerStatuses 47
GetPopupList 35
GetRootDiagramGUID 7
GetTimeZones 47
- H -HostType 57
- I -IActionService 44
IChangeRequestService 59
IDataTableService 28
IDiagramService 9
IMapService 7
Input 21
INDEX64
Inputs 21
- M -MapType 25
Methods 7, 9, 28, 44, 59
- N -NotationType 26
- O -ObjectType 26
Output 22
Outputs 22
- P -PopupList 41
PopupListItem 41
PopupListItems 41
PopupLists 42
PrepareNewAction 47
PrepareNewDiagramAction 48
PrepareNewDiagramCR 60
PrimaryContact 26
- R -Reminder 54
Resource 22
Resources 23
ResourceStatus 26
- S -Simple Types 24, 42, 57
StatementLink 23
StatementLinks 24
- T -TIBCO Nimbus Web Services API Reference 4
TimeZone 55
TimeZones 55
- U -UpdateDataTableRecord 35
User 56
UserListItems 56
UserOrGroup 56
- V -VariantType 27