cisco process orchestrator rest api service guide, 3.2 · get a global variable by its name or id,...

Cisco Process Orchestrator REST APIService

Table of ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

URI scheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Get all global variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Create global variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Delete a global variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Update global variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Get a global variable by its name or ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Create global variable of type 'Target Reference' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Update global variable of type 'Target Reference' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Get process instance status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Get output variables of a succeeded process instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Stop a process instance from running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Get all processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Start a process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Enable or disable a process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Get all runtime users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Delete a runtime user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Get a runtime user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Create runtime user of type 'Client Certificate User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Update runtime user of type 'Client Certificate User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Create runtime user of type 'OAuth User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Update runtime user of type 'OAuth User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Create runtime user of type 'OpenStack User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Update runtime user of type 'OpenStack User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Create runtime user of type 'Public-key Authenticated Admin User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Update runtime user of type 'Public-key Authenticated Admin User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Create runtime user of type 'Runtime Admin User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Update runtime user of type 'Runtime Admin User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Create runtime user of type 'Runtime User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Update runtime user of type 'Runtime User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Create runtime user of type 'SNNP User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Update runtime user of type 'SNNP User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Create runtime user of type 'Windows User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Update runtime user of type 'Windows User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Create runtime user of type 'vCloud User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Update runtime user of type 'vCloud User' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Create a property extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Delete a property extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Update a property extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Get a property extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Create a property extension of type 'Target Reference' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Update a property extension of type 'Target Reference' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Get all targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Delete a target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Get a target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Create a target 'AMQPBroker' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Update a target 'AMQPBroker' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Create a target 'ActiveDirectoryDomain' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Update a target 'ActiveDirectoryDomain' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Create a target 'CiscoPrimeServiceCatalogServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Update a target 'CiscoPrimeServiceCatalogServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Create a target 'CiscoUCSDirectorServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Update a target 'CiscoUCSDirectorServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Create a target 'CiscoUCSManager' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Update a target 'CiscoUCSManager' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Create a target 'Email Account (IMAP)'. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Update a target 'Email Account (IMAP)' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Create a target 'Email Account (POP3)' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Update a target 'Email Account (POP3)' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Create a target 'Email SMTP Server' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Update a target 'Email SMTP Server' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Create a target 'GenericService' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Update a target 'GenericService' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Create a target 'NetworkDeviceModule' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Update a target 'NetworkDeviceModule' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Create a target 'OpenStackServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Update a target 'OpenStackServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Create a target 'OracleDatabase' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Update a target 'OracleDatabase' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Create a target 'RemedyServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Update a target 'RemedyServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Create a target 'SNMP Device (Agent)' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Update a target 'SNMP Device (Agent)' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Create a target 'SNMP Server' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Update a target 'SNMP Server' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Create a target 'Terminal' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Update a target 'Terminal' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Create a target 'UnixLinuxSystem' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Update a target 'UnixLinuxSystem' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Create a target 'VMwareVirtualCenterServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Update a target 'VMwareVirtualCenterServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Create a target 'VMwarevCloudDirectorServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Update a target 'VMwarevCloudDirectorServer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Create a target 'VMwarevSphereHypervisor' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Update a target 'VMwarevSphereHypervisor' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Create a target 'WebTarget' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Update a target 'WebTarget' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Create a target 'WindowsComputer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Update a target 'WindowsComputer' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Create a task of type 'AlertTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Update a task of type 'AlertTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Create a task of type 'ApprovalTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Update a task of type 'ApprovalTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Create a task of type 'GuidedOperationTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Update a task of type 'GuidedOperationTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Create a task of type 'IncidentTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Update a task of type 'IncidentTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Create a task of type 'ReviewTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Update a task of type 'ReviewTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Create a task of type 'SurveyTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Update a task of type 'SurveyTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Create a task of type 'ChangeRequestTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Update a task of type 'ChangeRequestTask' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Add a note to the task specified by GUID Id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Get a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

AMQPBrokerTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

ActiveDirectoryDomainTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

AlertTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

ApprovalTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

ChangeRequestTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

ClientCertificateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

EmailIMAPTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

EmailPOP3Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

EmailSMTPTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

GeneralExtensionResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

GenericRuntimeUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

GenericServiceTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

GlobalVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

GlobalVariableResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

GuidedOperationTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

IOSRuntimeUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

IncidentTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

InstanceStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

NamedParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

NetworkDeviceModule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

OAuthUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

OpenStackTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

OpenStackUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

OracleDatabaseTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

PSCTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

ProcessDefinition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

ProcessVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

PublicKeyAdminUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

RESTVariableValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

RemedyServerTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

ReviewTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

RuntimeUserDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

SNMPAgentTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

SNMPManagerTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

SNMPUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

SurveyTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

TargetDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

TargetPropertyGeneral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

TargetPropertyObjectReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

TargetReferenceVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

TerminalTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

UCSDirectorTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

UcsManagerTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

UnixTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

VCloudDirectorUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

VMWareVsphereHypervisor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

VMwareVirtualCenterServerTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

VMwarevCloudDirectorServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

WebTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

WindowsTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

WindowsUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Overview

Version information

Version: v1

URI scheme

BasePath: /v1/api Schemes: HTTP, HTTPS

Paths

Get all global variables

GET /api/v1/GlobalVariables

Description

Get all global variables

Parameters

Type Name Description Required Schema Default

QueryParameter

nameFilter Filter all globalvariables bytheir name,whose namecontains thefilter string

false string

Responses

HTTP Code Description Schema

200 Returns a list of global variables RESTVariableValue array

400 BadRequest No Content

Produces

• application/json

• text/json

• application/xml

• text/xml

Tags

• GlobalVariables

Create global variable

POST /api/v1/GlobalVariables/{nameOrId}

Parameters


PathParameter nameOrId Name or GuidID of the globalvariable thatyou want toadd

true string

BodyParameter

jsonInput Sample inputto create globalvariable

true GlobalVariable

Responses


200 Returns Guid ID of the createdglobal variable

string


Consumes


• application/xml

• text/json

• text/xml

Tags

• GlobalVariables

Delete a global variable

DELETE /api/v1/GlobalVariables/{nameOrId}

Description

Delete a global variable

Parameters


PathParameter nameOrId Name or GuidID of the globalvariable thatyou want todelete

true string

Responses


200 Returns Guid ID of the deletedglobal variable

string


Produces


• text/json

• application/xml

• text/xml

Tags

• GlobalVariables

Update global variable

PATCH /api/v1/GlobalVariables/{nameOrId}

Parameters


PathParameter nameOrId Name or GuidID of the globalvariable thatyou want toupdate

true string

BodyParameter

jsonInput Sample inputto updateglobal variable

true GlobalVariable

Responses


200 Returns Guid ID of the updatedglobal variable

string


Consumes


• application/xml

• text/json

• text/xml

Tags

• GlobalVariables

Get a global variable by its name or ID

GET /api/v1/GlobalVariables/{nameOrId}

Description

Get a global variable by its name or ID, the response model schema may vary depends on the type of

the variable you are returning.

We only listed the most common one below

Parameters


PathParameter nameOrId Name or GuidID of the globalvariable thatyou want toreturn

true string

Responses


200 Get a global variable by its nameor ID

GlobalVariableResponse


Produces


• text/json

• application/xml

• text/xml

Tags

• GlobalVariables

Create global variable of type 'Target Reference'

POST /api/v1/GlobalVariables/{nameOrId} -- Target Reference

Parameters


PathParameter nameOrId Name or GuidID of the globalvariable thatyou want toadd

true string

BodyParameter

jsonInput Sample inputto create globalvarialbe oftype targetreference

true TargetReferenceVariable

Responses


200 Ok No Content


Consumes


• application/xml

• text/json

• text/xml

Tags

• GlobalVariables

Update global variable of type 'Target Reference'

PATCH /api/v1/GlobalVariables/{nameOrId} -- Target Reference

Parameters


PathParameter nameOrId Name or GuidID of the globalvariable thatyou want toupdate

true string

BodyParameter

jsonInput Sample inputto updateglobal varialbeof type targetreference

true TargetReferenceVariable

Responses


200 Ok No Content


Consumes


• application/xml

• text/json

• text/xml

Tags

• GlobalVariables

Get process instance status

POST /api/v1/ProcessInstances

Description

Get process instance status based on provided process instance GUIDs

Parameters


BodyParameter

ids A list ofprocessinstance GUIDs

true string array

Responses


200 Returns a list of process instancestatuses based on provided ids

InstanceStatus array


Consumes


• application/xml

• text/json

• text/xml

Produces


• text/json

• application/xml

• text/xml

Tags

• ProcessInstances

Get output variables of a succeeded process instance

GET /api/v1/ProcessInstances/outputvariables/{Id}

Description

Get output variables of a succeeded process instance. The returned list will be empty if the process is

still running

Parameters


PathParameter Id A processinstance ID

true string

Responses


200 A list of output variables of aprocess instance

RESTVariableValue array


Produces


• text/json

• application/xml

• text/xml

Tags


Stop a process instance from running

DELETE /api/v1/ProcessInstances/{Id}

Description

Stop a process instance from running based on provided ID

Parameters


PathParameter Id A processinstance ID

true string

Responses


200 Success message string


Produces


• text/json

• application/xml

• text/xml

Tags


Get all processes

GET /api/v1/Processes

Description

Get all processes

Parameters


QueryParameter

northboundOnly

Only returnnorthboundexposedprocesses, willreturn allprocessesif this attributeis not provided

false boolean

Responses


200 Returns a list of processes inCPO

ProcessDefinition array


Produces


• text/json

• application/xml

• text/xml

Tags

• Processes

Start a process

POST /api/v1/Processes/{nameOrId}

Description

Start a process. Use the variable name defined in the workflow. If providing input in XML format, some

characters in variable name will be invalid to be used as tag name. i.e space.

Please do a XML encode before use the variable name as the tag name

Parameters


PathParameter nameOrId Process nameor the GUID IDof the process

true string

BodyParameter

inputVariables true [Object]

Responses


200 Returns a list of GUIDs that havebeen started

InstanceStatus array


Consumes


• application/xml

• text/json

• text/xml

Produces


• text/json

• application/xml

• text/xml

Tags

• Processes

Enable or disable a process

PATCH /api/v1/Processes/{nameOrId}

Description

Enable or disable a process

Parameters


PathParameter nameOrId Process nameor the GUID IDof the process

true string


QueryParameter

enable True to enablethe process orfalse to disableit

true boolean

Responses


200 Success message string


Produces


• text/json

• application/xml

• text/xml

Tags

• Processes

Get all runtime users

GET /api/v1/RuntimeUsers

Description

Get all runtime users

Parameters


QueryParameter

nameFilter Filter all globalvariables bytheir name. Ifyou want to getnames whichcontain 'Web',please provideWeb.

false string

QueryParameter

typeFilter Filter allruntime usersby their type. Ifthe type namecontains space,please replaceit with %20. i.e'WindowsUser' will be'Windows%20User'

false string

Responses


200 Returns a list of runtime users RuntimeUserDefinition array


Produces


• text/json

• application/xml

• text/xml

Tags

• RuntimeUsers

Delete a runtime user

DELETE /api/v1/RuntimeUsers/{nameOrId}

Description

Delete a runtime user by name or its GUID Id

Parameters


PathParameter nameOrId Name or GUIDId of theruntime user

true string

Responses


200 Return GUID Id of the deletedruntime user

string


Produces


• text/json

• application/xml

• text/xml

Tags

• RuntimeUsers

Get a runtime user

GET /api/v1/RuntimeUsers/{nameOrId}

Description

Get a runtime user by name or its GUID Id. Depends on type of the runtime user you are retrieving,

response model schema may vary.

The one listed below is for generic model schema.

Parameters



true string

Responses


200 OK GenericRuntimeUser


Produces


• text/json

• application/xml

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'Client Certificate User'

POST /api/v1/RuntimeUsers/{nameOrId} -- Client Certificate User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type ClientCertificate

true ClientCertificateUser

Responses


200 Return GUID Id of the createdruntime user

string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'Client Certificate User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- Client Certificate User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type ClientCertificate

true ClientCertificateUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'OAuth User'

POST /api/v1/RuntimeUsers/{nameOrId} -- OAuth User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type 'OAuthUser'

true OAuthUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'OAuth User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- OAuth User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type 'OAuthUser'

true OAuthUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'OpenStack User'

POST /api/v1/RuntimeUsers/{nameOrId} -- OpenStack User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type'OpenStackUser'

true OpenStackUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'OpenStack User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- OpenStack User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type'OpenStackUser'

true OpenStackUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'Public-key Authenticated

Admin User'

POST /api/v1/RuntimeUsers/{nameOrId} -- Public-key Authenticated Admin User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type 'Public-keyAuthenticatedAdmin User'

true PublicKeyAdminUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'Public-key Authenticated

Admin User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- Public-key Authenticated Admin User

Parameters



true string

BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type 'Public-keyAuthenticatedAdmin User'

true PublicKeyAdminUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'Runtime Admin User'

POST /api/v1/RuntimeUsers/{nameOrId} -- Runtime Admin User

Parameters



true string

BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type'RuntimeAdmin User'

true IOSRuntimeUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'Runtime Admin User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- Runtime Admin User

Parameters



true string

BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type'RuntimeAdmin User'

true IOSRuntimeUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'Runtime User'

POST /api/v1/RuntimeUsers/{nameOrId} -- Runtime User

Parameters



true string

BodyParameter

jobjectInput Parametersneed to beprovided if youare creating agenericruntime user

true GenericRuntimeUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'Runtime User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- Runtime User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare updating agenericruntime user

true GenericRuntimeUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'SNNP User'

POST /api/v1/RuntimeUsers/{nameOrId} -- SNMP User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type 'SNNPUser'

true SNMPUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'SNNP User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- SNMP User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type 'SNNPUser'

true SNMPUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'Windows User'

POST /api/v1/RuntimeUsers/{nameOrId} -- Windows User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type'WindowsUser'

true WindowsUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'Windows User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- Windows User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type'WindowsUser'

true WindowsUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create runtime user of type 'vCloud User'

POST /api/v1/RuntimeUsers/{nameOrId} -- vCloud User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare creating aruntime userof type 'vCloudUser'

true VCloudDirectorUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Update runtime user of type 'vCloud User'

PATCH /api/v1/RuntimeUsers/{nameOrId} -- vCloud User

Parameters



true string


BodyParameter

jobjectInput Parametersneed to beprovided if youare updating aruntime userof type 'vCloudUser'

true VCloudDirectorUser

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• RuntimeUsers

Create a property extension

POST /api/v1/TargetProperties/{nameOrId}

Parameters


PathParameter nameOrId Name or GUIDId of thepropertyextension

true string


BodyParameter

jobjectInput Inputs that areneeded whento create apropertyextension oftype 'Boolean','Identity','Number','EncyptedString', 'String','Table'

true TargetPropertyGeneral

Responses


200 GUID Id of the created targetproperty

string


Consumes


• application/xml

• text/json

• text/xml

Tags

• TargetProperties

Delete a property extension

DELETE /api/v1/TargetProperties/{nameOrId}

Description

Delete a target property extension

Parameters



true string

Responses


200 GUID Id of the deleted targetproperty

string


Produces


• text/json

• application/xml

• text/xml

Tags


Update a property extension

PATCH /api/v1/TargetProperties/{nameOrId}

Parameters



true string


BodyParameter

jobjectInput Inputs that areneeded whento update apropertyextension oftype 'Boolean','Identity','Number','EncyptedString', 'String','Table'

true TargetPropertyGeneral

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags


Get a property extension

GET /api/v1/TargetProperties/{nameOrId}

Description

Get a target property extension by name or its GUID Id. Depends on type of the property extension you

are retrieving, response model schema may vary.

The one listed below is for most common schema.

Parameters



true string

Responses


200 Get a target property extension GeneralExtensionResponse


Produces


• text/json

• application/xml

• text/xml

Tags


Create a property extension of type 'Target Reference'

POST /api/v1/TargetProperties/{nameOrId} -- Target Reference Extension

Parameters



true string


BodyParameter

jobjectInput Inputs that areneeded whento create apropertyextension oftype 'TargetReference'

true TargetPropertyObjectReference

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags


Update a property extension of type 'Target Reference'

PATCH /api/v1/TargetProperties/{nameOrId} -- Target Reference Extension

Parameters



true string


BodyParameter

jobjectInput Inputs that areneeded whento updating apropertyextension oftype 'TargetReference'

true TargetPropertyObjectReference

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags


Get all targets

GET /api/v1/Targets

Description

Get all targets. You are filtering what to return by providing name filter and type filter

Parameters


QueryParameter

nameFilter Filter alltargets by theirname. If youwant to getnames whichcontain 'Web',please provideWeb.

false string

QueryParameter

typeFilter Filter alltargets by theirtype. If thetype namecontains space,please replaceit with %20. i.e'WindowsUser' will be'Windows%20User'

false string

Responses


200 Get all target definitions TargetDefinition array


Produces


• text/json

• application/xml

• text/xml

Tags

• Targets

Delete a target

DELETE /api/v1/Targets/{nameOrId}

Description

Delete a target

Parameters


PathParameter nameOrId Name or GUIDId of the target

true string

Responses


200 Return GUID Id of the deletedtarget

string


Produces


• text/json

• application/xml

• text/xml

Tags

• Targets

Get a target

GET /api/v1/Targets/{nameOrId}

Description

Get a target by name or its GUID Id. Depends on type of the target you are retrieving, response model

schema may vary.

The one listed below is for Web Target.

Parameters


PathParameter nameOrId Name or GUIDId of the target

true string

Responses


200 Return GUID Id of the createdtarget

WebTarget


Produces


• text/json

• application/xml

• text/xml

Tags

• Targets

Create a target 'AMQPBroker'

POST /api/v1/Targets/{nameOrId} -- AMQP Broker

Description

Specifies the connection information for the AMQP Broker server used for processes to run against.

Parameters


PathParameter nameOrId Name of thetarget

true string


BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'AMQPBroker'

true AMQPBrokerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'AMQPBroker'

PATCH /api/v1/Targets/{nameOrId} -- AMQP Broker

Description

Specifies the connection information for the AMQP Broker server used for processes to run against.

Parameters



true string


BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'AMQPBroker'

true AMQPBrokerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'ActiveDirectoryDomain'

POST /api/v1/Targets/{nameOrId} -- Active Directory Domain

Description

Specifies the connection information for the Active Directory Domain server used for processes to run

against.

Parameters



true string


BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'ActiveDirectoryDomain'

true ActiveDirectoryDomainTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'ActiveDirectoryDomain'

PATCH /api/v1/Targets/{nameOrId} -- Active Directory Domain

Description

Specifies the connection information for the Active Directory Domain server used for processes to run

against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'ActiveDirectoryDomain'

true ActiveDirectoryDomainTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'CiscoPrimeServiceCatalogServer'

POST /api/v1/Targets/{nameOrId} -- Cisco Prime Service Catalog Server

Description

Specifies the connection information for the Cisco Prime Service Catalog server used for processes to

run against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'CiscoPrimeServiceCatalogServer'

true PSCTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'CiscoPrimeServiceCatalogServer'

PATCH /api/v1/Targets/{nameOrId} -- Cisco Prime Service Catalog Server

Description

Specifies the connection information for the Cisco Prime Service Catalog server used for processes to

run against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'CiscoPrimeServiceCatalogServer'

true PSCTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'CiscoUCSDirectorServer'

POST /api/v1/Targets/{nameOrId} -- Cisco UCS Director Server

Description

Specifies the connection information for the Cisco UCS Director server used for processes to run

against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'CiscoUCSDirectorServer'

true UCSDirectorTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'CiscoUCSDirectorServer'

PATCH /api/v1/Targets/{nameOrId} -- Cisco UCS Director Server

Description

Specifies the connection information for the Cisco UCS Director server used for processes to run

against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'CiscoUCSDirectorServer'

true UCSDirectorTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'CiscoUCSManager'

POST /api/v1/Targets/{nameOrId} -- Cisco UCS Manager

Description

Specifies the connection information for the UCS Manager server used for processes to run against

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'CiscoUCSManager'

true UcsManagerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'CiscoUCSManager'

PATCH /api/v1/Targets/{nameOrId} -- Cisco UCS Manager

Description

Specifies the connection information for the UCS Manager server used for processes to run against

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'CiscoUCSManager'

true UcsManagerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'Email Account (IMAP)'

POST /api/v1/Targets/{nameOrId} -- Email Account (IMAP)

Description

Specifies the connection information to an IMAP email server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'EmailAccountIMAP'

true EmailIMAPTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'Email Account (IMAP)'

PATCH /api/v1/Targets/{nameOrId} -- Email Account (IMAP)

Description

Specifies the connection information to an IMAP email server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'EmailAccountIMAP'

true EmailIMAPTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'Email Account (POP3)'

POST /api/v1/Targets/{nameOrId} -- Email Account (POP3)

Description

Specifies the connection information to a POP3 email server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget 'EmailAccount(POP3)'

true EmailPOP3Target

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'Email Account (POP3)'

PATCH /api/v1/Targets/{nameOrId} -- Email Account (POP3)

Description

Specifies the connection information to a POP3 email server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget 'EmailAccount(POP3)'

true EmailPOP3Target

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'Email SMTP Server'

POST /api/v1/Targets/{nameOrId} -- Email SMTP Server

Description

Specifies the connection information to a SMTP email server.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget 'EmailSMTP Server'

true EmailSMTPTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'Email SMTP Server'

PATCH /api/v1/Targets/{nameOrId} -- Email SMTP Server

Description

Specifies the connection information to a SMTP email server.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget 'EmailSMTP Server'

true EmailSMTPTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'GenericService'

POST /api/v1/Targets/{nameOrId} -- Generic Service

Description

Creates a target that represents an IT or business service. The service target can be used by process

authors when creating content within Cisco Process Orchestrator. The Service target is a specialized

target that cannot be used against any activities or triggers in Cisco Process Orchestrator.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'GenericService'

true GenericServiceTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'GenericService'

PATCH /api/v1/Targets/{nameOrId} -- Generic Service

Description

Creates a target that represents an IT or business service. The service target can be used by process

authors when creating content within Cisco Process Orchestrator. The Service target is a specialized

target that cannot be used against any activities or triggers in Cisco Process Orchestrator.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'GenericService'

true GenericServiceTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'NetworkDeviceModule'

POST /api/v1/Targets/{nameOrId} -- Network Device Module

Description

Some Cisco network devices are chassis systems that can hold other network devices such as ACE,

FWSM, on boards that plug into the chassis. This method creates a network device module target

which can be used as a dependent of a terminal target, as well as, an independent network device

target that can be used by network processes for execution.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'NetworkDeviceModule'

true NetworkDeviceModule

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'NetworkDeviceModule'

PATCH /api/v1/Targets/{nameOrId} -- Network Device Module

Description

Some Cisco network devices are chassis systems that can hold other network devices such as ACE,

FWSM, on boards that plug into the chassis. This method creates a network device module target

which can be used as a dependent of a terminal target, as well as, an independent network device

target that can be used by network processes for execution.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'NetworkDeviceModule'

true NetworkDeviceModule

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'OpenStackServer'

POST /api/v1/Targets/{nameOrId} -- OpenStack Server

Description

Specifies the connection information to an OpenStack server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'OpenStackServer'

true OpenStackTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'OpenStackServer'

PATCH /api/v1/Targets/{nameOrId} -- OpenStack Server

Description

Specifies the connection information to an OpenStack server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'OpenStackServer'

true OpenStackTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'OracleDatabase'

POST /api/v1/Targets/{nameOrId} -- Oracle Database

Description

Specifies the connection information for the Oracle database used for processes to run against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'OracleDatabase'

true OracleDatabaseTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'OracleDatabase'

PATCH /api/v1/Targets/{nameOrId} -- Oracle Database

Description

Specifies the connection information for the Oracle database used for processes to run against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'OracleDatabase'

true OracleDatabaseTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'RemedyServer'

POST /api/v1/Targets/{nameOrId} -- Remedy Server

Description

Specify the connection information to a Remedy server which is used for processes to run against. It is

recommended that the Remedy target is defined before attempting to define any Remedy activities.

The Remedy target accesses the list of properties on the Remedy server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'RemedyServer'

true RemedyServerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'RemedyServer'

PATCH /api/v1/Targets/{nameOrId} -- Remedy Server

Description

Specify the connection information to a Remedy server which is used for processes to run against. It is

recommended that the Remedy target is defined before attempting to define any Remedy activities.

The Remedy target accesses the list of properties on the Remedy server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'RemedyServer'

true RemedyServerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'SNMP Device (Agent)'

POST /api/v1/Targets/{nameOrId} -- SNMP Device Agent

Description

Configures the host and operation and notification settings for accessing an SNMP agent.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget 'SNMPDevice (Agent)'

true SNMPAgentTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'SNMP Device (Agent)'

PATCH /api/v1/Targets/{nameOrId} -- SNMP Device Agent

Description

Configures the host and operation and notification settings for accessing an SNMP agent.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget 'SNMPDevice (Agent)'

true SNMPAgentTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'SNMP Server'

POST /api/v1/Targets/{nameOrId} -- SNMP Server

Description

Configures the host and security settings for sending traps to a SNMP server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget 'SNMPServer'

true SNMPManagerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'SNMP Server'

PATCH /api/v1/Targets/{nameOrId} -- SNMP Server

Description

Configures the host and security settings for sending traps to a SNMP server

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget 'SNMPServer'

true SNMPManagerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'Terminal'

POST /api/v1/Targets/{nameOrId} -- Terminal

Description

Specifies the connection information used to access the terminal host used for processes to run against

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'Terminal'

true TerminalTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'Terminal'

PATCH /api/v1/Targets/{nameOrId} -- Terminal

Description

Specifies the connection information used to access the terminal host used for processes to run against

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'Terminal'

true TerminalTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'UnixLinuxSystem'

POST /api/v1/Targets/{nameOrId} -- UnixLinuxSystem

Description

Specifies the connection information for the SSH server used for processes to run against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'UnixLinuxSystem'

true UnixTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'UnixLinuxSystem'

PATCH /api/v1/Targets/{nameOrId} -- UnixLinuxSystem

Description

Specifies the connection information for the SSH server used for processes to run against.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'UnixLinuxSystem'

true UnixTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'VMwareVirtualCenterServer'

POST /api/v1/Targets/{nameOrId} -- VMware Virtual Center Server

Description

Specifies the connection information to the VMware virtual center server target. Virtual Center Server

provides unified management of all the hosts and VMs in your datacenter from a single console with

an aggregate performance monitoring of clusters, hosts and VMs.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'VMwareVirtualCenterServer'

true VMwareVirtualCenterServerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'VMwareVirtualCenterServer'

PATCH /api/v1/Targets/{nameOrId} -- VMware Virtual Center Server

Description

Specifies the connection information to the VMware virtual center server target. Virtual Center Server

provides unified management of all the hosts and VMs in your datacenter from a single console with

an aggregate performance monitoring of clusters, hosts and VMs.

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'VMwareVirtualCenterServer'

true VMwareVirtualCenterServerTarget

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Create a target 'VMwarevCloudDirectorServer'

POST /api/v1/Targets/{nameOrId} -- VMware vCloud Director Server

Description

Specifies the connection information for the VCloud Director server used for processes to run against

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou createtarget'VMwarevCloudDirectorServer'

true VMwarevCloudDirectorServer

Responses



string


Consumes


• application/xml

• text/json

• text/xml

Tags

• Targets

Update a target 'VMwarevCloudDirectorServer'

PATCH /api/v1/Targets/{nameOrId} -- VMware vCloud Director Server

Description

Specifies the connection information for the VCloud Director server used for processes to run against

Parameters



true string

BodyParameter

jsonbody Parametersneed to beprovided whenyou updatetarget'VMwarevCloudDirectorServer'

true VMwarevCloudDirectorServer

Responses



string


Consumes


• application/xml

• text/json

• text/xml

T

cisco process orchestrator rest api service guide, 3.2 · get a global variable by its name or id,...

Documents