Table Of Content

REST API Guide OnPremises and PrivateCloud AgilePoint NX v6.0 SP1 Document Revision r6.0.3 September 2016 Contents 2 Contents REST API...........................................................................................................10 Preface...............................................................................................................11 Disclaimer of Warranty...............................................................................................................................11 Copyright.....................................................................................................................................................11 Trademarks.................................................................................................................................................11 Government Rights Legend.......................................................................................................................11 Virus-free software policy...........................................................................................................................11 Document Revision Numbers.....................................................................................................................11 AgilePoint Documentation in PDF and HTML...........................................................................................12 Opening the Documentation Library..........................................................................................................12 Finding Information in the Documentation Library.....................................................................................13 Downloading Files and Sharing Links from the Documentation Library....................................................13 Contact AgilePoint Sales............................................................................................................................14 Contact AgilePoint Customer Support.......................................................................................................14 Basic Programming Tasks..............................................................................15 Authentication.............................................................................................................................................15 HttpOperations Code Examples.................................................................................................................17 Methods.............................................................................................................24 Process Definition Methods........................................................................................................................24 Check In Process Definition............................................................................................................25 Check Out Process Definition.........................................................................................................27 Create Process Definition................................................................................................................29 Delete Process Definition................................................................................................................31 Get Base Process Definition ID......................................................................................................33 Get Process Definition By Base Process Definition ID...................................................................34 Get Process Definition Graphics.....................................................................................................36 Get Process Definition Name and Version.....................................................................................38 Get Process Definitions...................................................................................................................40 Get Process Definition Supplement................................................................................................42 Get Process Definition XML............................................................................................................44 Get Released Process Definition ID...............................................................................................45 Get Released Process Definitions..................................................................................................47 Release Process Definition.............................................................................................................49 Set Process Definition Supplement.................................................................................................50 Uncheckout Process Definition........................................................................................................52 Update Process Definition...............................................................................................................54 Methods for Process Instances..................................................................................................................56 Archive Process Instance................................................................................................................56 Create Process Instance.................................................................................................................58 Cancel Process Instance.................................................................................................................63 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 3 Delete Process Instance..................................................................................................................66 Get Events By Process Instance ID...............................................................................................67 Get Process Instance......................................................................................................................69 Get Process Instance Attribute.......................................................................................................72 Get Process Instance Attributes......................................................................................................74 Merge Process Instances................................................................................................................76 Migrate Process Instance................................................................................................................79 Query Process Instances................................................................................................................83 Query Process Instances Using SQL.............................................................................................86 Restore Process Instance...............................................................................................................89 Resume Process Instance...............................................................................................................90 Rollback Process Instance..............................................................................................................92 Split Process Instance.....................................................................................................................95 Suspend Process Instance..............................................................................................................98 Update Process Instance..............................................................................................................100 Methods for Activity Instances.................................................................................................................103 Cancel Activity Instance................................................................................................................103 Get Activity Instance......................................................................................................................105 Get Activity Instances By Process Instance ID.............................................................................107 Get Activity Instance Status..........................................................................................................109 Query Activity Instances................................................................................................................111 Query Activity Instances in Xml Format........................................................................................114 Rollback Activity Instance..............................................................................................................116 Rollback Activity Instances............................................................................................................118 Methods for Manual Work Items (Tasks).................................................................................................121 Activate Work Item........................................................................................................................121 Assign Work Item..........................................................................................................................124 Cancel Work Item..........................................................................................................................127 Complete Work Item......................................................................................................................130 Create Linked Work Item..............................................................................................................133 Create Pseudo Work Item.............................................................................................................138 Create Work Item..........................................................................................................................142 Get Work Item...............................................................................................................................147 Get Work List By User ID.............................................................................................................149 Query Work List.............................................................................................................................152 Query Work List Using SQL..........................................................................................................155 Reassign Work Item......................................................................................................................157 Undo Assign Work Item................................................................................................................160 Update Work Item.........................................................................................................................163 Methods for Automatic Work Items (Procedures)....................................................................................166 Cancel Procedure..........................................................................................................................166 Complete Procedure......................................................................................................................168 Get Procedure...............................................................................................................................171 Query Procedure List....................................................................................................................173 User Delegation........................................................................................................................................176 Activate Delegation........................................................................................................................176 Add Delegation..............................................................................................................................178 Cancel Delegation.........................................................................................................................181 Get Delegation...............................................................................................................................182 Get Delegations.............................................................................................................................184 Remove Delegation.......................................................................................................................187 Update Delegation.........................................................................................................................189 Methods for Email Templates..................................................................................................................192 Add Email Template......................................................................................................................192 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 4 Get All EMail Templates................................................................................................................195 Get EMail Template.......................................................................................................................196 Remove Email Template...............................................................................................................198 Update Email Template.................................................................................................................200 Methods for Email and Notifications........................................................................................................202 Cancel Mail Deliverable.................................................................................................................203 Get Expecting Send Mail Deliverable...........................................................................................204 Get Mail Deliverables....................................................................................................................206 Send Mail.......................................................................................................................................208 Resend Mail Deliverable................................................................................................................212 Methods for Custom Attributes................................................................................................................213 Delete Custom Attributes...............................................................................................................213 Get Custom Attribute.....................................................................................................................215 Get Custom Attributes By ID.........................................................................................................217 Get Custom Attributes By IDs.......................................................................................................219 Get Custom Attributes By Names.................................................................................................222 Remove Custom Attribute.............................................................................................................225 Remove Custom Attributes............................................................................................................227 Set Custom Attributes...................................................................................................................229 Group, Role, and Rights..........................................................................................................................231 Add Group.....................................................................................................................................231 Add Group Member.......................................................................................................................234 Add Role........................................................................................................................................237 Add Role Member.........................................................................................................................242 Get Access Rights.........................................................................................................................245 Get Access Right Names..............................................................................................................247 Get Group......................................................................................................................................249 Get Group Members......................................................................................................................251 Get Groups....................................................................................................................................252 Get Role.........................................................................................................................................254 Get Roles.......................................................................................................................................256 Query Role Members....................................................................................................................258 Remove Group..............................................................................................................................260 Remove Group Member................................................................................................................262 Remove Role.................................................................................................................................264 Remove Role Member...................................................................................................................266 Update Group................................................................................................................................269 Update Role...................................................................................................................................271 Other Web Services.................................................................................................................................275 Get UUID (Universally Unique ID)................................................................................................275 Query Audit Trail...........................................................................................................................276 Query Database.............................................................................................................................278 Methods for Events..................................................................................................................................280 Get Event.......................................................................................................................................281 Administrative Service..............................................................................................................................283 Get Database Information.............................................................................................................283 Get Domain Groups......................................................................................................................285 Get Domain Group Members........................................................................................................287 Get Domain Name.........................................................................................................................289 Get Domain Users.........................................................................................................................290 Get Locale.....................................................................................................................................293 Get Register User..........................................................................................................................294 Get Register Users........................................................................................................................296 Get Sender Email Address............................................................................................................298 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 5 Get SMTP Server..........................................................................................................................300 Get System Performance Information...........................................................................................301 Get System User...........................................................................................................................303 Query Register Users Using SQL.................................................................................................304 Register User.................................................................................................................................307 Unregister User..............................................................................................................................312 Update Registered User................................................................................................................314 Classes............................................................................................................319 AddGroupMemberHelper..........................................................................................................................319 Syntax............................................................................................................................................319 Constructors...................................................................................................................................319 Namespace and Assembly............................................................................................................319 Properties.......................................................................................................................................319 AddEMailTemplateHelper.........................................................................................................................321 Syntax............................................................................................................................................321 Constructors...................................................................................................................................321 Namespace and Assembly............................................................................................................321 Properties.......................................................................................................................................321 AddRoleMemberHelper............................................................................................................................322 Syntax............................................................................................................................................322 Constructors...................................................................................................................................322 Namespace and Assembly............................................................................................................322 Properties.......................................................................................................................................322 AddUpdateRoleHelper..............................................................................................................................324 Syntax............................................................................................................................................324 Constructors...................................................................................................................................324 Namespace and Assembly............................................................................................................324 Properties.......................................................................................................................................324 ClientDataHelper.......................................................................................................................................325 Syntax............................................................................................................................................325 Constructors...................................................................................................................................325 Namespace and Assembly............................................................................................................325 Properties.......................................................................................................................................326 CreateLinkedWorkItemHelper...................................................................................................................326 Syntax............................................................................................................................................326 Constructors...................................................................................................................................326 Namespace and Assembly............................................................................................................326 Properties.......................................................................................................................................327 CreateProcInstHelper...............................................................................................................................329 Syntax............................................................................................................................................329 Constructors...................................................................................................................................329 Namespace and Assembly............................................................................................................329 Properties.......................................................................................................................................329 CreatePseudoWorkItemHelper.................................................................................................................332 Syntax............................................................................................................................................332 Constructors...................................................................................................................................332 Namespace and Assembly............................................................................................................332 Properties.......................................................................................................................................332 CreateWorkItemHelper.............................................................................................................................334 Syntax............................................................................................................................................334 Constructors...................................................................................................................................334 Namespace and Assembly............................................................................................................334 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 6 Properties.......................................................................................................................................335 GetCustomAttrByNamesHelper................................................................................................................336 Syntax............................................................................................................................................336 Constructors...................................................................................................................................336 Namespace and Assembly............................................................................................................337 Properties.......................................................................................................................................337 GetDelegationsHelper...............................................................................................................................337 Syntax............................................................................................................................................337 Constructors...................................................................................................................................338 Namespace and Assembly............................................................................................................338 Properties.......................................................................................................................................338 GetDomainHelper.....................................................................................................................................339 Syntax............................................................................................................................................339 Constructors...................................................................................................................................339 Namespace and Assembly............................................................................................................339 Properties.......................................................................................................................................339 GetWorkListByUserIDHelper....................................................................................................................340 Syntax............................................................................................................................................340 Constructors...................................................................................................................................340 Namespace and Assembly............................................................................................................340 Properties.......................................................................................................................................340 GroupHelper.............................................................................................................................................341 Syntax............................................................................................................................................341 Constructors...................................................................................................................................341 Namespace and Assembly............................................................................................................341 Properties.......................................................................................................................................342 IWFWorkflowService.................................................................................................................................343 Description.....................................................................................................................................343 Syntax............................................................................................................................................343 Constructors...................................................................................................................................343 Namespace and Assembly............................................................................................................343 IWFTrackingEventPublisher.....................................................................................................................343 Description.....................................................................................................................................343 Syntax............................................................................................................................................343 Constructors...................................................................................................................................344 Namespace and Assembly............................................................................................................344 Properties.......................................................................................................................................344 KeyValue...................................................................................................................................................344 Description.....................................................................................................................................344 Syntax............................................................................................................................................345 Constructors...................................................................................................................................345 Namespace and Assembly............................................................................................................345 Properties.......................................................................................................................................345 NameValue...............................................................................................................................................346 Description.....................................................................................................................................346 Syntax............................................................................................................................................346 Constructors...................................................................................................................................346 Namespace and Assembly............................................................................................................346 Properties.......................................................................................................................................346 ReassignWorkItemHelper.........................................................................................................................347 Syntax............................................................................................................................................347 Constructors...................................................................................................................................347 Namespace and Assembly............................................................................................................347 Properties.......................................................................................................................................347 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 7 RegisteredUser.........................................................................................................................................348 Description.....................................................................................................................................348 Syntax............................................................................................................................................348 Constructors...................................................................................................................................348 Namespace and Assembly............................................................................................................349 Properties.......................................................................................................................................349 RemoveGroupMemberHelper...................................................................................................................350 Syntax............................................................................................................................................350 Constructors...................................................................................................................................351 Namespace and Assembly............................................................................................................351 Properties.......................................................................................................................................351 RemoveRoleMemberHelper.....................................................................................................................351 Syntax............................................................................................................................................351 Constructors...................................................................................................................................352 Namespace and Assembly............................................................................................................352 Properties.......................................................................................................................................352 SendMailHelper........................................................................................................................................353 Syntax............................................................................................................................................353 Constructors...................................................................................................................................353 Namespace and Assembly............................................................................................................353 Properties.......................................................................................................................................353 UpdateEMailTemplateHelper....................................................................................................................355 Syntax............................................................................................................................................355 Constructors...................................................................................................................................355 Namespace and Assembly............................................................................................................355 Properties.......................................................................................................................................355 UpdateRegisteredUserIconHelper............................................................................................................356 Syntax............................................................................................................................................356 Constructors...................................................................................................................................356 Namespace and Assembly............................................................................................................357 Properties.......................................................................................................................................357 WFAccessRights.......................................................................................................................................357 Description.....................................................................................................................................357 Syntax............................................................................................................................................358 Constructors...................................................................................................................................358 Namespace and Assembly............................................................................................................358 WFAgilePart..............................................................................................................................................358 Description.....................................................................................................................................358 Syntax............................................................................................................................................358 Constructors...................................................................................................................................358 Namespace and Assembly............................................................................................................358 WFAgilePartDescriptor.............................................................................................................................359 Description.....................................................................................................................................359 Syntax............................................................................................................................................359 Constructors...................................................................................................................................359 Namespace and Assembly............................................................................................................359 Properties.......................................................................................................................................359 WFAgileWork............................................................................................................................................364 Description.....................................................................................................................................364 Syntax............................................................................................................................................365 Constructors...................................................................................................................................365 Namespace and Assembly............................................................................................................365 WFAgileWorkDescriptor............................................................................................................................365 Description.....................................................................................................................................365 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 8 Syntax............................................................................................................................................365 Constructors...................................................................................................................................365 Namespace and Assembly............................................................................................................365 Properties.......................................................................................................................................366 WFAny......................................................................................................................................................374 Description.....................................................................................................................................374 Syntax............................................................................................................................................374 Constructors...................................................................................................................................374 Namespace and Assembly............................................................................................................374 Properties.......................................................................................................................................375 WFEvent...................................................................................................................................................375 Description.....................................................................................................................................375 Syntax............................................................................................................................................375 Constructors...................................................................................................................................375 Namespace and Assembly............................................................................................................376 Properties.......................................................................................................................................376 WFIntegratedApplication...........................................................................................................................381 Description.....................................................................................................................................381 Syntax............................................................................................................................................381 Constructors...................................................................................................................................382 Namespace and Assembly............................................................................................................382 Properties.......................................................................................................................................382 WFPartialRollbackInstruction....................................................................................................................383 Description.....................................................................................................................................383 Syntax............................................................................................................................................383 Constructors...................................................................................................................................384 Namespace and Assembly............................................................................................................384 Properties.......................................................................................................................................384 WFIntegratedApplicationDescriptor..........................................................................................................384 Description.....................................................................................................................................384 Syntax............................................................................................................................................384 Constructors...................................................................................................................................385 Namespace and Assembly............................................................................................................385 Properties.......................................................................................................................................385 WFProcessMergingInstruction..................................................................................................................385 Description.....................................................................................................................................385 Syntax............................................................................................................................................385 Constructors...................................................................................................................................386 Namespace and Assembly............................................................................................................386 Properties.......................................................................................................................................386 WFProcessMigrationInstruction................................................................................................................387 Description.....................................................................................................................................387 Syntax............................................................................................................................................387 Constructors...................................................................................................................................387 Namespace and Assembly............................................................................................................387 Properties.......................................................................................................................................387 WFProcessPluggableAdapter...................................................................................................................388 Description.....................................................................................................................................388 Syntax............................................................................................................................................389 Constructors...................................................................................................................................389 Namespace and Assembly............................................................................................................389 Properties.......................................................................................................................................389 WFProcessPluggableAdapterDescriptor..................................................................................................391 Description.....................................................................................................................................391 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 9 Syntax............................................................................................................................................391 Constructors...................................................................................................................................391 Namespace and Assembly............................................................................................................391 Properties.......................................................................................................................................391 WFQueryExpr...........................................................................................................................................393 Description.....................................................................................................................................393 Syntax............................................................................................................................................393 Constructors...................................................................................................................................393 Namespace and Assembly............................................................................................................394 Properties.......................................................................................................................................394 WFQueryExprHelper.................................................................................................................................395 Syntax............................................................................................................................................395 Constructors...................................................................................................................................395 Namespace and Assembly............................................................................................................395 Properties.......................................................................................................................................396 WFProcessSplittingInstruction..................................................................................................................397 Description.....................................................................................................................................397 Syntax............................................................................................................................................397 Constructors...................................................................................................................................397 Namespace and Assembly............................................................................................................397 Properties.......................................................................................................................................397 WFTimeDuration.......................................................................................................................................398 Description.....................................................................................................................................398 Syntax............................................................................................................................................398 Constructors...................................................................................................................................398 Namespace and Assembly............................................................................................................398 Properties.......................................................................................................................................398 WFTimeUnit..............................................................................................................................................399 Description.....................................................................................................................................399 Syntax............................................................................................................................................399 Constructors...................................................................................................................................399 Namespace and Assembly............................................................................................................400 Properties.......................................................................................................................................400 Data Types......................................................................................................401 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 REST API 10 REST API This document describes the AgilePoint REST API. AgilePoint recommends this API especially for use with mobile applications. JavaScript, Java, and C# examples are provided for each method. This API has the following endpoints. The name of your AgilePoint Server directory depends upon whether you are using AgilePoint on premises or AgilePoint for Azure: • Workflow API - https://[qualified machine name]:[port]/[AgilePointServer or AgilePointService]/Workflow • Administration API - https://[qualified machine name]:[port]/[AgilePointServer or AgilePointService]/Admin Note: For your data security, AgilePoint strongly recommends using SSL (https) for all communication with the AgilePoint REST API. Good to Know • For jQuery version 1.9 and higher, for a REST service that returns a response of null or {}, The REST API call dataType must be Text. AgilePoint NX v6.0 SP1 REST API Guide r6.0.3

Description:
Virus-free software policy. Methods for Activity Instances. Get Activity Instances By Process Instance ID..
ebook img

REST API Guide PDF

401 Pages·2016·1.35 MB·English
by  
#api
Save to my drive
Quick download
Download
Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview REST API Guide

REST API Guide OnPremises and PrivateCloud AgilePoint NX v6.0 SP1 Document Revision r6.0.3 September 2016 Contents 2 Contents REST API...........................................................................................................10 Preface...............................................................................................................11 Disclaimer of Warranty...............................................................................................................................11 Copyright.....................................................................................................................................................11 Trademarks.................................................................................................................................................11 Government Rights Legend.......................................................................................................................11 Virus-free software policy...........................................................................................................................11 Document Revision Numbers.....................................................................................................................11 AgilePoint Documentation in PDF and HTML...........................................................................................12 Opening the Documentation Library..........................................................................................................12 Finding Information in the Documentation Library.....................................................................................13 Downloading Files and Sharing Links from the Documentation Library....................................................13 Contact AgilePoint Sales............................................................................................................................14 Contact AgilePoint Customer Support.......................................................................................................14 Basic Programming Tasks..............................................................................15 Authentication.............................................................................................................................................15 HttpOperations Code Examples.................................................................................................................17 Methods.............................................................................................................24 Process Definition Methods........................................................................................................................24 Check In Process Definition............................................................................................................25 Check Out Process Definition.........................................................................................................27 Create Process Definition................................................................................................................29 Delete Process Definition................................................................................................................31 Get Base Process Definition ID......................................................................................................33 Get Process Definition By Base Process Definition ID...................................................................34 Get Process Definition Graphics.....................................................................................................36 Get Process Definition Name and Version.....................................................................................38 Get Process Definitions...................................................................................................................40 Get Process Definition Supplement................................................................................................42 Get Process Definition XML............................................................................................................44 Get Released Process Definition ID...............................................................................................45 Get Released Process Definitions..................................................................................................47 Release Process Definition.............................................................................................................49 Set Process Definition Supplement.................................................................................................50 Uncheckout Process Definition........................................................................................................52 Update Process Definition...............................................................................................................54 Methods for Process Instances..................................................................................................................56 Archive Process Instance................................................................................................................56 Create Process Instance.................................................................................................................58 Cancel Process Instance.................................................................................................................63 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 3 Delete Process Instance..................................................................................................................66 Get Events By Process Instance ID...............................................................................................67 Get Process Instance......................................................................................................................69 Get Process Instance Attribute.......................................................................................................72 Get Process Instance Attributes......................................................................................................74 Merge Process Instances................................................................................................................76 Migrate Process Instance................................................................................................................79 Query Process Instances................................................................................................................83 Query Process Instances Using SQL.............................................................................................86 Restore Process Instance...............................................................................................................89 Resume Process Instance...............................................................................................................90 Rollback Process Instance..............................................................................................................92 Split Process Instance.....................................................................................................................95 Suspend Process Instance..............................................................................................................98 Update Process Instance..............................................................................................................100 Methods for Activity Instances.................................................................................................................103 Cancel Activity Instance................................................................................................................103 Get Activity Instance......................................................................................................................105 Get Activity Instances By Process Instance ID.............................................................................107 Get Activity Instance Status..........................................................................................................109 Query Activity Instances................................................................................................................111 Query Activity Instances in Xml Format........................................................................................114 Rollback Activity Instance..............................................................................................................116 Rollback Activity Instances............................................................................................................118 Methods for Manual Work Items (Tasks).................................................................................................121 Activate Work Item........................................................................................................................121 Assign Work Item..........................................................................................................................124 Cancel Work Item..........................................................................................................................127 Complete Work Item......................................................................................................................130 Create Linked Work Item..............................................................................................................133 Create Pseudo Work Item.............................................................................................................138 Create Work Item..........................................................................................................................142 Get Work Item...............................................................................................................................147 Get Work List By User ID.............................................................................................................149 Query Work List.............................................................................................................................152 Query Work List Using SQL..........................................................................................................155 Reassign Work Item......................................................................................................................157 Undo Assign Work Item................................................................................................................160 Update Work Item.........................................................................................................................163 Methods for Automatic Work Items (Procedures)....................................................................................166 Cancel Procedure..........................................................................................................................166 Complete Procedure......................................................................................................................168 Get Procedure...............................................................................................................................171 Query Procedure List....................................................................................................................173 User Delegation........................................................................................................................................176 Activate Delegation........................................................................................................................176 Add Delegation..............................................................................................................................178 Cancel Delegation.........................................................................................................................181 Get Delegation...............................................................................................................................182 Get Delegations.............................................................................................................................184 Remove Delegation.......................................................................................................................187 Update Delegation.........................................................................................................................189 Methods for Email Templates..................................................................................................................192 Add Email Template......................................................................................................................192 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 4 Get All EMail Templates................................................................................................................195 Get EMail Template.......................................................................................................................196 Remove Email Template...............................................................................................................198 Update Email Template.................................................................................................................200 Methods for Email and Notifications........................................................................................................202 Cancel Mail Deliverable.................................................................................................................203 Get Expecting Send Mail Deliverable...........................................................................................204 Get Mail Deliverables....................................................................................................................206 Send Mail.......................................................................................................................................208 Resend Mail Deliverable................................................................................................................212 Methods for Custom Attributes................................................................................................................213 Delete Custom Attributes...............................................................................................................213 Get Custom Attribute.....................................................................................................................215 Get Custom Attributes By ID.........................................................................................................217 Get Custom Attributes By IDs.......................................................................................................219 Get Custom Attributes By Names.................................................................................................222 Remove Custom Attribute.............................................................................................................225 Remove Custom Attributes............................................................................................................227 Set Custom Attributes...................................................................................................................229 Group, Role, and Rights..........................................................................................................................231 Add Group.....................................................................................................................................231 Add Group Member.......................................................................................................................234 Add Role........................................................................................................................................237 Add Role Member.........................................................................................................................242 Get Access Rights.........................................................................................................................245 Get Access Right Names..............................................................................................................247 Get Group......................................................................................................................................249 Get Group Members......................................................................................................................251 Get Groups....................................................................................................................................252 Get Role.........................................................................................................................................254 Get Roles.......................................................................................................................................256 Query Role Members....................................................................................................................258 Remove Group..............................................................................................................................260 Remove Group Member................................................................................................................262 Remove Role.................................................................................................................................264 Remove Role Member...................................................................................................................266 Update Group................................................................................................................................269 Update Role...................................................................................................................................271 Other Web Services.................................................................................................................................275 Get UUID (Universally Unique ID)................................................................................................275 Query Audit Trail...........................................................................................................................276 Query Database.............................................................................................................................278 Methods for Events..................................................................................................................................280 Get Event.......................................................................................................................................281 Administrative Service..............................................................................................................................283 Get Database Information.............................................................................................................283 Get Domain Groups......................................................................................................................285 Get Domain Group Members........................................................................................................287 Get Domain Name.........................................................................................................................289 Get Domain Users.........................................................................................................................290 Get Locale.....................................................................................................................................293 Get Register User..........................................................................................................................294 Get Register Users........................................................................................................................296 Get Sender Email Address............................................................................................................298 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 5 Get SMTP Server..........................................................................................................................300 Get System Performance Information...........................................................................................301 Get System User...........................................................................................................................303 Query Register Users Using SQL.................................................................................................304 Register User.................................................................................................................................307 Unregister User..............................................................................................................................312 Update Registered User................................................................................................................314 Classes............................................................................................................319 AddGroupMemberHelper..........................................................................................................................319 Syntax............................................................................................................................................319 Constructors...................................................................................................................................319 Namespace and Assembly............................................................................................................319 Properties.......................................................................................................................................319 AddEMailTemplateHelper.........................................................................................................................321 Syntax............................................................................................................................................321 Constructors...................................................................................................................................321 Namespace and Assembly............................................................................................................321 Properties.......................................................................................................................................321 AddRoleMemberHelper............................................................................................................................322 Syntax............................................................................................................................................322 Constructors...................................................................................................................................322 Namespace and Assembly............................................................................................................322 Properties.......................................................................................................................................322 AddUpdateRoleHelper..............................................................................................................................324 Syntax............................................................................................................................................324 Constructors...................................................................................................................................324 Namespace and Assembly............................................................................................................324 Properties.......................................................................................................................................324 ClientDataHelper.......................................................................................................................................325 Syntax............................................................................................................................................325 Constructors...................................................................................................................................325 Namespace and Assembly............................................................................................................325 Properties.......................................................................................................................................326 CreateLinkedWorkItemHelper...................................................................................................................326 Syntax............................................................................................................................................326 Constructors...................................................................................................................................326 Namespace and Assembly............................................................................................................326 Properties.......................................................................................................................................327 CreateProcInstHelper...............................................................................................................................329 Syntax............................................................................................................................................329 Constructors...................................................................................................................................329 Namespace and Assembly............................................................................................................329 Properties.......................................................................................................................................329 CreatePseudoWorkItemHelper.................................................................................................................332 Syntax............................................................................................................................................332 Constructors...................................................................................................................................332 Namespace and Assembly............................................................................................................332 Properties.......................................................................................................................................332 CreateWorkItemHelper.............................................................................................................................334 Syntax............................................................................................................................................334 Constructors...................................................................................................................................334 Namespace and Assembly............................................................................................................334 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 6 Properties.......................................................................................................................................335 GetCustomAttrByNamesHelper................................................................................................................336 Syntax............................................................................................................................................336 Constructors...................................................................................................................................336 Namespace and Assembly............................................................................................................337 Properties.......................................................................................................................................337 GetDelegationsHelper...............................................................................................................................337 Syntax............................................................................................................................................337 Constructors...................................................................................................................................338 Namespace and Assembly............................................................................................................338 Properties.......................................................................................................................................338 GetDomainHelper.....................................................................................................................................339 Syntax............................................................................................................................................339 Constructors...................................................................................................................................339 Namespace and Assembly............................................................................................................339 Properties.......................................................................................................................................339 GetWorkListByUserIDHelper....................................................................................................................340 Syntax............................................................................................................................................340 Constructors...................................................................................................................................340 Namespace and Assembly............................................................................................................340 Properties.......................................................................................................................................340 GroupHelper.............................................................................................................................................341 Syntax............................................................................................................................................341 Constructors...................................................................................................................................341 Namespace and Assembly............................................................................................................341 Properties.......................................................................................................................................342 IWFWorkflowService.................................................................................................................................343 Description.....................................................................................................................................343 Syntax............................................................................................................................................343 Constructors...................................................................................................................................343 Namespace and Assembly............................................................................................................343 IWFTrackingEventPublisher.....................................................................................................................343 Description.....................................................................................................................................343 Syntax............................................................................................................................................343 Constructors...................................................................................................................................344 Namespace and Assembly............................................................................................................344 Properties.......................................................................................................................................344 KeyValue...................................................................................................................................................344 Description.....................................................................................................................................344 Syntax............................................................................................................................................345 Constructors...................................................................................................................................345 Namespace and Assembly............................................................................................................345 Properties.......................................................................................................................................345 NameValue...............................................................................................................................................346 Description.....................................................................................................................................346 Syntax............................................................................................................................................346 Constructors...................................................................................................................................346 Namespace and Assembly............................................................................................................346 Properties.......................................................................................................................................346 ReassignWorkItemHelper.........................................................................................................................347 Syntax............................................................................................................................................347 Constructors...................................................................................................................................347 Namespace and Assembly............................................................................................................347 Properties.......................................................................................................................................347 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 7 RegisteredUser.........................................................................................................................................348 Description.....................................................................................................................................348 Syntax............................................................................................................................................348 Constructors...................................................................................................................................348 Namespace and Assembly............................................................................................................349 Properties.......................................................................................................................................349 RemoveGroupMemberHelper...................................................................................................................350 Syntax............................................................................................................................................350 Constructors...................................................................................................................................351 Namespace and Assembly............................................................................................................351 Properties.......................................................................................................................................351 RemoveRoleMemberHelper.....................................................................................................................351 Syntax............................................................................................................................................351 Constructors...................................................................................................................................352 Namespace and Assembly............................................................................................................352 Properties.......................................................................................................................................352 SendMailHelper........................................................................................................................................353 Syntax............................................................................................................................................353 Constructors...................................................................................................................................353 Namespace and Assembly............................................................................................................353 Properties.......................................................................................................................................353 UpdateEMailTemplateHelper....................................................................................................................355 Syntax............................................................................................................................................355 Constructors...................................................................................................................................355 Namespace and Assembly............................................................................................................355 Properties.......................................................................................................................................355 UpdateRegisteredUserIconHelper............................................................................................................356 Syntax............................................................................................................................................356 Constructors...................................................................................................................................356 Namespace and Assembly............................................................................................................357 Properties.......................................................................................................................................357 WFAccessRights.......................................................................................................................................357 Description.....................................................................................................................................357 Syntax............................................................................................................................................358 Constructors...................................................................................................................................358 Namespace and Assembly............................................................................................................358 WFAgilePart..............................................................................................................................................358 Description.....................................................................................................................................358 Syntax............................................................................................................................................358 Constructors...................................................................................................................................358 Namespace and Assembly............................................................................................................358 WFAgilePartDescriptor.............................................................................................................................359 Description.....................................................................................................................................359 Syntax............................................................................................................................................359 Constructors...................................................................................................................................359 Namespace and Assembly............................................................................................................359 Properties.......................................................................................................................................359 WFAgileWork............................................................................................................................................364 Description.....................................................................................................................................364 Syntax............................................................................................................................................365 Constructors...................................................................................................................................365 Namespace and Assembly............................................................................................................365 WFAgileWorkDescriptor............................................................................................................................365 Description.....................................................................................................................................365 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 8 Syntax............................................................................................................................................365 Constructors...................................................................................................................................365 Namespace and Assembly............................................................................................................365 Properties.......................................................................................................................................366 WFAny......................................................................................................................................................374 Description.....................................................................................................................................374 Syntax............................................................................................................................................374 Constructors...................................................................................................................................374 Namespace and Assembly............................................................................................................374 Properties.......................................................................................................................................375 WFEvent...................................................................................................................................................375 Description.....................................................................................................................................375 Syntax............................................................................................................................................375 Constructors...................................................................................................................................375 Namespace and Assembly............................................................................................................376 Properties.......................................................................................................................................376 WFIntegratedApplication...........................................................................................................................381 Description.....................................................................................................................................381 Syntax............................................................................................................................................381 Constructors...................................................................................................................................382 Namespace and Assembly............................................................................................................382 Properties.......................................................................................................................................382 WFPartialRollbackInstruction....................................................................................................................383 Description.....................................................................................................................................383 Syntax............................................................................................................................................383 Constructors...................................................................................................................................384 Namespace and Assembly............................................................................................................384 Properties.......................................................................................................................................384 WFIntegratedApplicationDescriptor..........................................................................................................384 Description.....................................................................................................................................384 Syntax............................................................................................................................................384 Constructors...................................................................................................................................385 Namespace and Assembly............................................................................................................385 Properties.......................................................................................................................................385 WFProcessMergingInstruction..................................................................................................................385 Description.....................................................................................................................................385 Syntax............................................................................................................................................385 Constructors...................................................................................................................................386 Namespace and Assembly............................................................................................................386 Properties.......................................................................................................................................386 WFProcessMigrationInstruction................................................................................................................387 Description.....................................................................................................................................387 Syntax............................................................................................................................................387 Constructors...................................................................................................................................387 Namespace and Assembly............................................................................................................387 Properties.......................................................................................................................................387 WFProcessPluggableAdapter...................................................................................................................388 Description.....................................................................................................................................388 Syntax............................................................................................................................................389 Constructors...................................................................................................................................389 Namespace and Assembly............................................................................................................389 Properties.......................................................................................................................................389 WFProcessPluggableAdapterDescriptor..................................................................................................391 Description.....................................................................................................................................391 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 Contents 9 Syntax............................................................................................................................................391 Constructors...................................................................................................................................391 Namespace and Assembly............................................................................................................391 Properties.......................................................................................................................................391 WFQueryExpr...........................................................................................................................................393 Description.....................................................................................................................................393 Syntax............................................................................................................................................393 Constructors...................................................................................................................................393 Namespace and Assembly............................................................................................................394 Properties.......................................................................................................................................394 WFQueryExprHelper.................................................................................................................................395 Syntax............................................................................................................................................395 Constructors...................................................................................................................................395 Namespace and Assembly............................................................................................................395 Properties.......................................................................................................................................396 WFProcessSplittingInstruction..................................................................................................................397 Description.....................................................................................................................................397 Syntax............................................................................................................................................397 Constructors...................................................................................................................................397 Namespace and Assembly............................................................................................................397 Properties.......................................................................................................................................397 WFTimeDuration.......................................................................................................................................398 Description.....................................................................................................................................398 Syntax............................................................................................................................................398 Constructors...................................................................................................................................398 Namespace and Assembly............................................................................................................398 Properties.......................................................................................................................................398 WFTimeUnit..............................................................................................................................................399 Description.....................................................................................................................................399 Syntax............................................................................................................................................399 Constructors...................................................................................................................................399 Namespace and Assembly............................................................................................................400 Properties.......................................................................................................................................400 Data Types......................................................................................................401 AgilePoint NX v6.0 SP1 REST API Guide r6.0.3 REST API 10 REST API This document describes the AgilePoint REST API. AgilePoint recommends this API especially for use with mobile applications. JavaScript, Java, and C# examples are provided for each method. This API has the following endpoints. The name of your AgilePoint Server directory depends upon whether you are using AgilePoint on premises or AgilePoint for Azure: • Workflow API - https://[qualified machine name]:[port]/[AgilePointServer or AgilePointService]/Workflow • Administration API - https://[qualified machine name]:[port]/[AgilePointServer or AgilePointService]/Admin Note: For your data security, AgilePoint strongly recommends using SSL (https) for all communication with the AgilePoint REST API. Good to Know • For jQuery version 1.9 and higher, for a REST service that returns a response of null or {}, The REST API call dataType must be Text. AgilePoint NX v6.0 SP1 REST API Guide r6.0.3

Description:
Virus-free software policy. Methods for Activity Instances. Get Activity Instances By Process Instance ID..
See more

The list of books you might like

Upgrade Premium
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.
DMCA & Copyright: Dear all, most of the website is community built, users are uploading hundred of books everyday, which makes really hard for us to identify copyrighted material, please contact us if you want any material removed.
Copyright @ PDFdrive.to, 2022 | We love our users