Process API
{ urn:com.soa.rest.services.process } ProcessAPI
The API used to manage PM processes.
GET/processesgetProcesses
Returns the processes for the given organization key.
Request:
GET /rest/processes?organizationKey=uddi:e3d4ea51-f4ad-11e6-880d-9b52c44f1958 HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
[ {
"any" : {
"process" : {
"partnerLinks" : {
"partnerLink" : [ {
"otherAttributes" : {
},
"name" : "borrowerPartnerLink",
"partnerLinkType" : "{http://soa.com/processs}borrowerConsumer",
"myRole" : "Consumer"
} ],
"otherAttributes" : {
}
},
"variables" : {
"variable" : [ {
"name" : "message",
"messageType" : "{http://soa.com/process/activity}ActivityMessage",
"otherAttributes" : {
}
}, {
"name" : "fault",
"messageType" : "{http://soa.com/process/activity}ActivityMessage",
"otherAttributes" : {
}
} ],
"otherAttributes" : {
}
},
"faults" : {
"otherAttributes" : {
}
},
"sequence" : {
"activity" : [ {
"invoke" : {
"InvocationExt" : {
"IdentitySpec" : {
"UseInboundIdentities" : true,
"UseServiceIdentityForHTTPS" : false
},
"ParameterAssignments" : {
},
"service" : "{http://demo.soa.com}RESTBorrower",
"otherAttributes" : {
}
},
"otherAttributes" : {
},
"name" : "Invoke1",
"partnerLink" : "borrowerPartnerLink",
"portType" : "{http://demo.soa.com}borrower",
"operation" : "listBorrowers",
"inputVariable" : "message",
"outputVariable" : "message"
}
}, {
"reply" : {
"otherAttributes" : {
},
"name" : "Reply1",
"variable" : "message"
}
} ],
"otherAttributes" : {
}
},
"partnerLinkType" : {
"role" : [ {
"portType" : {
"name" : "{http://demo.soa.com}borrower"
},
"name" : "Consumer"
} ],
"name" : "borrowerConsumer"
},
"otherAttributes" : {
"{http://soa.com/bpel/ext}processKey" : "bpel:4c7eae8f-f578-11e6-a4d1-927c4aaab2be"
},
"name" : "p1",
"targetNamespace" : "http://soa.com/processs"
}
},
"BpelProcessKey" : "bpel:4c7eae8f-f578-11e6-a4d1-927c4aaab2be"
} ]
Parameters
Name
Type
Description
Model
organizationKey
query
The organizationKey.
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
Process
Process {
Description( string )
ResourceScope( string )
BpelProcessKey( string )
OperationKey( string )
any( anyType )
Name( string )
OrganizationKey( string )
}
POST/processesCreates a process
Adds the given process.
Request:
POST /rest/processes HTTP/1.1
Content-Type: application/json
Accept: application/json
{
"Name": "Aren Process",
"Description": "dddd",
"OrganizationKey": "uddi:e3d4ea51-f4ad-11e6-880d-9b52c44f1958"
}
Response:
HTTP/1.1 200 OK
{
"Name": "Aren Process",
"Description": "dddd",
"OrganizationKey": "uddi:e3d4ea51-f4ad-11e6-880d-9b52c44f1958",
"BpelProcessKey": "bpel:53f05434-0067-11e7-a7ce-d5bbd0b935f2"
}
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
body
entity
The process
Process
Process {
Description( string )
ResourceScope( string )
BpelProcessKey( string )
OperationKey( string )
any( anyType )
Name( string )
OrganizationKey( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
Process
Process {
Description( string )
ResourceScope( string )
BpelProcessKey( string )
OperationKey( string )
any( anyType )
Name( string )
OrganizationKey( string )
}
GET/processes/{processKey}getProcess
Returns the process.
Request:
GET /rest/processes/bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52 HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
{
"any" : {
"process" : {
"partnerLinks" : {
"partnerLink" : [ {
"otherAttributes" : {
},
"name" : "initial",
"partnerLinkType" : "{http://demo.soa.com}borrowerProvider",
"myRole" : "Provider"
}, {
"otherAttributes" : {
},
"name" : "nextHop",
"partnerLinkType" : "{http://demo.soa.com}borrowerConsumer",
"myRole" : "Consumer"
} ],
"otherAttributes" : {
}
},
"variables" : {
"variable" : [ {
"name" : "message",
"messageType" : "{http://soa.com/process/activity}ActivityMessage",
"otherAttributes" : {
}
}, {
"name" : "fault",
"messageType" : "{http://soa.com/process/activity}ActivityMessage",
"otherAttributes" : {
}
} ],
"otherAttributes" : {
}
},
"faultHandlers" : {
"catchAll" : {
"sequence" : {
"activity" : [ {
"reply" : {
"otherAttributes" : {
},
"name" : "FaultReply",
"partnerLink" : "initial",
"portType" : "{http://demo.soa.com}borrower",
"operation" : "listBorrowers",
"variable" : "fault",
"faultName" : "{http://soa.com/bpel/ext}ExistingFault"
}
} ],
"otherAttributes" : {
}
},
"otherAttributes" : {
}
},
"otherAttributes" : {
}
},
"sequence" : {
"activity" : [ {
"receive" : {
"otherAttributes" : {
},
"name" : "Receive",
"partnerLink" : "initial",
"portType" : "{http://demo.soa.com}borrower",
"operation" : "listBorrowers",
"variable" : "message",
"createInstance" : "yes"
}
}, {
"invoke" : {
"InvocationExt" : {
"service" : "{http://demo.soa.com}RESTBorrower",
"otherAttributes" : {
}
},
"otherAttributes" : {
},
"name" : "Invoke",
"partnerLink" : "nextHop",
"portType" : "{http://demo.soa.com}borrower",
"operation" : "listBorrowers",
"inputVariable" : "message",
"outputVariable" : "message"
}
}, {
"reply" : {
"otherAttributes" : {
},
"name" : "Reply",
"partnerLink" : "initial",
"portType" : "{http://demo.soa.com}borrower",
"operation" : "listBorrowers",
"variable" : "message"
}
} ],
"otherAttributes" : {
}
},
"partnerLinkType" : [ {
"role" : [ {
"portType" : {
"name" : "{http://demo.soa.com}borrower"
},
"name" : "Provider"
} ],
"name" : "borrowerProvider"
}, {
"role" : [ {
"portType" : {
"name" : "{http://demo.soa.com}borrower"
},
"name" : "Consumer"
} ],
"name" : "borrowerConsumer"
} ],
"otherAttributes" : {
"{http://soa.com/bpel/ext}processKey" : "bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52"
},
"name" : "listBorrowers",
"targetNamespace" : "http://demo.soa.com"
}
},
"BpelProcessKey" : "bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52"
}
Parameters
Name
Type
Description
Model
processKey
path
The process key
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
Process
Process {
Description( string )
ResourceScope( string )
BpelProcessKey( string )
OperationKey( string )
any( anyType )
Name( string )
OrganizationKey( string )
}
PUT/processes/{processKey}Updates a process
Updates the given process.
Request:
PUT /rest/processes/bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52 HTTP/1.1
Content-Type: application/json
Accept: application/json
{
"Name": "Aren Process updated",
"Description": "dddd",
"OrganizationKey": "uddi:e3d4ea51-f4ad-11e6-880d-9b52c44f1958",
"BpelProcessKey" : "bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52"
}
Response:
HTTP/1.1 200 OK
{
"Name": "Aren Process updated",
"Description": "dddd",
"OrganizationKey": "uddi:e3d4ea51-f4ad-11e6-880d-9b52c44f1958",
"BpelProcessKey" : "bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52"
}
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
processKey
path
The process key
string
body
entity
The process
Process
Process {
Description( string )
ResourceScope( string )
BpelProcessKey( string )
OperationKey( string )
any( anyType )
Name( string )
OrganizationKey( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
Process
Process {
Description( string )
ResourceScope( string )
BpelProcessKey( string )
OperationKey( string )
any( anyType )
Name( string )
OrganizationKey( string )
}
DELETE/processes/{processKey}deleteProcess
Returns the process key.
Request:
DELETE /rest/processes/bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52 HTTP/1.1
Accept: application/json
Response:
HTTP/1.1 200 OK
bpel:f6cd66d1-f56f-11e6-9e62-b6cb536b3f52
Parameters
Name
Type
Description
Model
processKey
path
The process key
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
