Versions Compared

Old Version 2

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version 3

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Universal Controller supports the following RESTful-based web services for PeopleSoft Connection operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about property requirements, are provided.

...


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

  • Status 200 /OK
    Successfully created the PeopleSoft Connection with sysId {sysId}.
  • Status 400 /Bad Request
    Create PeopleSoft Connection failed. A duplicate value has been detected. Name must be unique.

PeopleSoft Connection Properties

See PeopleSoft Connection Web Services#PeopleSoft Connection Properties, below.

Anchor
Create a PeopleSoft Connection Example Request
Create a PeopleSoft Connection Example Request
Create a PeopleSoft Connection: Example Request

...

<ul> <li> If <b>retainSysIds</b>
  • If retainSysIds="true"
  • and
<code>sysId</code>
  • sysId is
  • included
  • in
  • the
  • request/response,
<code>sysId</code>
  • sysId will
  • be
  • persisted
  • to
  • the
  • database.
<li> If <b>retainSysIds</b>
  • If retainSysIds="false"
and <code>sysId</code> is included in the
  • and sysId is included in the request/response,
<code>sysId</code>
  • sysId will
  • be
  • ignored;
  • it
  • will
  • be
  • autogenerated
  • by
  • the
  • Controller.
</ul>


Property

UI Field Name

Description

Specifications

Required

Anchor
credentials - PeopleSoft
credentials - PeopleSoft
credentials

Credentials

Credentials for the PeopleSoft connection.


N

Anchor
description - PeopleSoft
description - PeopleSoft
description

Description

User-defined; description of this record.


N

Anchor
exportReleaseLevel - PeopleSoft
exportReleaseLevel - PeopleSoft
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - PeopleSoft
exportTable - PeopleSoft
exportTable

n/aRecord table information.read onlyN

Anchor
name - PeopleSoft
name - PeopleSoft
name

Connection Name

Name used within the Controller to identify this PeopleSoft Connection.


Y

Anchor
endpoint - PeopleSoft
endpoint - PeopleSoft
endpoint

Endpoint

Web service endpoint for the PROCESSREQUEST service.


Y

Anchor
opswiseGroups - PeopleSoft
opswiseGroups - PeopleSoft
opswiseGroups

Member of Business Services

Business Services that this record belongs to.
 
XML


Panel


Html bobswift
<pre>
&lt;opswiseGroups&gt;
      &lt;opswiseGroup&gt;group1&lt;/opswiseGroup&gt;
      &lt;opswiseGroup&gt;group2&lt;/opswiseGroup&gt;
&lt;/opswiseGroups&gt;
</pre>



 
JSON


Panel


Html bobswift
<pre>
"opswiseGroups": ["group1","group2"]
</pre>




N

Anchor
port - PeopleSoft
port - PeopleSoft
port

Port

Port number for the PeopleSoft application server.


N

Anchor
retainSysIds - PeopleSoft
retainSysIds - PeopleSoft
retainSysIds

n/a

Specification for whether or not the Create a PeopleSoft Connection web service will persist the sysId property.

Html bobswift
Note
titleNote

In XML web services, retainSysIds is specified as an attribute in the <PeopleSoftConnection> element.


Valid values: true/false (default is true).

N

Anchor
server - PeopleSoft
server - PeopleSoft
server

Server

Host name of the Name or IP address of the PeopleSoft application server.


Y

Anchor
sysId - PeopleSoft
sysId - PeopleSoft
sysId

n/a

System ID field in the database for this PeopleSoft Connection record.

Persisted only if retainSysIds is set to true.

N

...


Description

URI

http://host_name/uc/resources/peoplesoftconnection/list

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

See PeopleSoft Connection Web Services#PeopleSoft Connection Properties.

Anchor
List PeopleSoft Connections Example Response
List PeopleSoft Connections Example Response
List PeopleSoft Connections: Example Response

...


Description

URI

http://host_name/uc/resources/peoplesoftconnection

HTTP Method

PUT

Description

Modifies the PeopleSoft Connection specified by the sysId.

Example URI

http://localhost:8080/uc/resources/peoplesoftconnection

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 Web Services#PeopleSoft Connection Properties.

Example Response

  • Status 200 /OK
    Successfully updated the PeopleSoft Connection with sysId <sysId> to version <version>.

...

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 Web Services#PeopleSoft Connection Properties.

Anchor
Read a PeopleSoft Connection URI Parameters
Read a PeopleSoft Connection URI Parameters
Read a PeopleSoft Connection: URI Parameters

...