Page Comparison

...

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 Properties, below.

...

XML Request

JSON Request

Expand

title	XML Request

<peoplesoftConnection retainSysIds="true">
    <credentials>user 1</credentials>
    <description>description</description>
    <endpoint>upps.stone.branch:8080</endpoint>
    <name>PeopleSoft Connection 1</name>
    <opswiseGroups />
    <port>8080</port>
    <server>upps.stone.branch</server>
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
</peoplesoftConnection>

Expand

title	JSON Request

{
    "credentials": "user 1",
    "description": "description",
    "endpoint": "upps.stone.branch:8080",
    "name": "PeopleSoft Connection 1",
    "opswiseGroups": null,
    "port": "8080",
    "retainSysIds": true,
    "server": "upps.stone.branch",
    "sysId": "62701879a6264107bb757a952bcc65cc"
}

...

	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	Status 200 /OK PeopleSoft Connection deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `connectionname` and `connectionid` at the same time. Status 404 /Not Found a PeopleSoft Connection with {name/id} "test" does not exist.

...

	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 Properties 63543625.

Anchor

	List PeopleSoft Connections Example Response
	List PeopleSoft Connections Example Response

...

XML Response

JSON Response

Expand

title	XML Response

<peoplesoftConnections>
    <peoplesoftConnection exportReleaseLevel="7.2.0.0" exportTable="ops_peoplesoft_connection" version="7">
        <credentials>user 1</credentials>
        <description>description</description>
        <endpoint>upps.stone.branch:8080</endpoint>
        <name>PeopleSoft Connection 1</name>
        <opswiseGroups />
        <port>8080</port>
        <server>upps.stone.branch</server>
        <sysId>62701879a6264107bb757a952bcc65cc</sysId>
    </peoplesoftConnection>
    <peoplesoftConnection exportReleaseLevel="7.2.0.0" exportTable="ops_peoplesoft_connection" version="2">
        <credentials>user 2</credentials>
        <description>description</description>
        <endpoint>upps.stone.branch:8090</endpoint>
        <name>PeopleSoft Connection 2</name>
        <opswiseGroups />
        <port>8090</port>
        <server>upps.stone.branch</server>
        <sysId>3d7a03053ad64de1b21b6849e6deafd9</sysId>
    </peoplesoftConnection>
<peoplesoftConnections>

Expand

title	JSON Response

[ {
{
    "credentials": "user 1",
    "description": "description",
    "endpoint": "upps.stone.branch:8080",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_peoplesoft_connection",
    "name": "PeopleSoft Connection 1",
    "opswiseGroups": null,
    "port": "8080",
    "server": "upps.stone.branch",
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "version": 7
    },
    {
{
    "credentials": "user 2",
    "description": "description",
    "endpoint": "upps.stone.branch:80p0",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_peoplesoft_connection",
    "name": "PeopleSoft Connection 2",
    "opswiseGroups": null,
    "port": "8090",
    "server": "upps.stone.branch",
    "sysId": "3d7a03053ad64de1b21b6849e6deafd9",
    "version": 2
    }
]

...

	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 Properties.
Example Response	Status 200 /OK Successfully updated the PeopleSoft Connection with sysId <sysId> to version <version>.

...

XML Request

JSON Request

Expand

title	XML Request

<peoplesoftConnection>
    <credentials>user 1</credentials>
    <description>description</description>
    <endpoint>upps.stone.branch:8080</endpoint>
    <name>PeopleSoft Connection 1</name>
    <opswiseGroups />
    <port>8080</port>
    <server>upps.stone.branch</server>
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
</peoplesoftConnection>

Expand

title	JSON Request

{
    "credentials": "user 1",
    "description": "description",
    "endpoint": "upps.stone.branch:8080",
    "name": "PeopleSoft Connection 1",
    "opswiseGroups": null,
    "port": "8080",
    "server": "upps.stone.branch",
    "sysId": "62701879a6264107bb757a952bcc65cc"
}

...

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.

...

XML Response

JSON Response

Expand

title	XML Request

<peoplesoftConnection exportReleaseLevel="7.2.0.0" exportTable="ops_peoplesoft_connection" retainSysIds="true" version="1">
    <credentials>user 1</credentials>
    <description>description</description>
    <endpoint>upps.stone.branch:8080</endpoint>
    <name>PeopleSoft Connection 1</name>
    <opswiseGroups />
    <port>8080</port>
    <server>upps.stone.branch</server>
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
</peoplesoftConnection>

Expand

title	JSON Response

{
    "credentials": "user 1",
    "description": "description",
    "endpoint": "upps.stone.branch:8080",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_peoplesoft_connection",
    "name": "PeopleSoft Connection 1",
    "opswiseGroups": null,
    "port": "8080",
    "retainSysIds": true,
    "server": "upps.stone.branch",
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "version": 1
}

...

Versions Compared

Old Version 5

New Version 6

Key