Panel | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Overview
Universal Controller supports the following RESTful-based web services for PeopleSoft Connection operations, which are listed alphabetically on this page.
- Create a PeopleSoft Connection
- Delete a PeopleSoft Connection
- List PeopleSoft Connections
- Modify a PeopleSoft Connection
- Read a PeopleSoft Connection
Formatting specifications for each web service, including details about property requirements, are provided.
Anchor | ||||
---|---|---|---|---|
|
Create a PeopleSoft Connection
Description | |
---|---|
URI | http://host_name/uc/resources/peoplesoftconnection |
HTTP Method | POST |
Description | Creates a PeopleSoft Connection. |
Example URI | http://localhost:8080/uc/resources/peoplesoftconnection |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a PeopleSoft Connection: Example Request, below. |
Example Response |
|
PeopleSoft Connection Properties | See PeopleSoft Connection Properties, below. |
Anchor | ||||
---|---|---|---|---|
|
Create a PeopleSoft Connection: Example Request
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
PeopleSoft Connection Properties
Property | UI Field Name | Description | Specifications | Required | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials | Credentials | Credentials for the PeopleSoft connection. | N | ||||||||||||
description | Description | User-defined; description of this record. | N | ||||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||
exportTable | n/a | Record table information. | read only | N | |||||||||||
name | Connection Name | Name used within the Controller to identify this PeopleSoft Connection. | Y | ||||||||||||
endpoint | Endpoint | Web service endpoint for the PROCESSREQUEST service. | Y | ||||||||||||
opswiseGroups | Member of Business Services | Business Services that this record belongs to.
| N | ||||||||||||
port | Port | Port number for the PeopleSoft application server. | N | ||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a PeopleSoft Connection web service will persist the
| Valid values: true/false (default is true). | N | |||||||||||
server | Server | Host name of the Name or IP address of the PeopleSoft application server. | Y | ||||||||||||
sysId | n/a | System ID field in the database for this PeopleSoft Connection record. | Persisted only if retainSysIds is set to true. | N |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/peoplesoftconnection |
HTTP Method | DELETE |
Description | Deletes a PeopleSoft Connection. |
URI Parameters | See Delete a PeopleSoft Connection: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/peoplesoftconnection?connectionname=Test4 |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Delete a PeopleSoft Connection: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this PeopleSoft Connection. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this PeopleSoft Connection. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
List PeopleSoft Connections
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on all PeopleSoft Connections. |
Example URI | http://localhost:8080/uc/resources/peoplesoftconnection/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List PeopleSoft Connections: Example Response, below. |
PeopleSoft Connection Properties |
Anchor | ||||
---|---|---|---|---|
|
List PeopleSoft Connections: Example Response
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Modify a PeopleSoft Connection
Description | |
---|---|
URI | http://host_name/uc/resources/peoplesoftconnection |
HTTP Method | PUT |
Description | Modifies the PeopleSoft Connection specified by the |
Example URI | |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Modify a PeopleSoft Connection: Example Request, below. |
PeopleSoft Connection Properties | See PeopleSoft Connection Properties. |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Modify a PeopleSoft Connection: Example Request
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Read a PeopleSoft Connection
URI | http://host_name/uc/resources/peoplesoftconnection |
HTTP Method | GET |
Description | Retrieves information on a specific PeopleSoft Connection. |
URI Parameters | See Read a PeopleSoft Connection: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/peoplesoftconnection?connectionname=Test4 |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See Read a PeopleSoft Connection: Example Response, below. |
PeopleSoft Connection Properties | See PeopleSoft Connection Properties. |
Anchor | ||||
---|---|---|---|---|
|
Read a PeopleSoft Connection: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this PeopleSoft Connection. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this PeopleSoft Connection. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Read a PeopleSoft Connection: Example Response
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|