D
Doug S.
I'm new to ruby and new to accessing api's over the web. Below, I've
pasted a few examples of api calls. Can someone direct me to a url
where I might learn about how to exercise an api with ruby? Thanks.
-----------------------------------------------
Description: Authenticate to a workspace on the host and create a
session. The name of the workspace for GG_userName is often the same as
the user name, but not in all cases. Therefore the workspace name is
returned in the result. 'userHostAdmin' indicates whether 'userName' is
an admin on the host. Admin users can perform operations in workspaces
other than the one authenticated to.
Example: http://localhost:8080/portal/web/host/createHostSession
Parameters - GG_hostId: host id returned by host/list operation.
GG_userInstanceId: The user instance ID returned by getPortalUser
GG_userName: username to authenticate.
GG_userPW: password.
GG_userDomain: user domain of workspace.
Returns: <?xml version=3D'1.0' encoding=3D'UTF-8' ?>
<session workspace=3D=E2=80=99name=E2=80=99 started=3D'true'
userHostAdmin=3D'true'>sessionNum</session>
------------------------------------------------
Description: Get a list of host drives (admin user only) & workspaces &
top level of files (for authenticated workspace only)
Example: http://localhost:8080/portal/web/host/get
Parameters - GG_hostId: host id returned by host/list operation.
GG_userInstanceId: The user instance ID returned by createHostSession
GG_userName: The username used when creating a session.
Returns: <?xml version=3D'1.0' encoding=3D'UTF-8' ?>
<items>
<item name=3D'itemName' id=3D'itemId' type=3D'itemType'
itemUrl=3D'itemUrl'/>
</items>
------------------------------------------------
Description: Register a host on the portal.
Example: http://localhost:8080/portal/web/host/register
Parameters - GG_hostAddress: The address of the host being registered.
GG_displayName: The user-friendly display name of the host being
registered.
GG_hardwareKey: The hardware key of the host being registered.
Returns: <?xml version=3D'1.0' encoding=3D'UTF-8' ?>
<item OS=3D=E2=80=9DOS=E2=80=9D displayName=3D=E2=80=9DdisplayName=E2=80=9D=
id=3D=E2=80=9Did=E2=80=9D name=3D=E2=80=9Dname=E2=80=9D
owner=3D=E2=80=9Downer=E2=80=9D smiAddress=3D=E2=80=9DsmiAddress=E2=80=9D=
smiPort=3D=E2=80=9DsmiPort=E2=80=9D
smiTransport=3D=E2=80=9DsmiTransport=E2=80=9D state=3D=E2=80=9Dstate=E2=80=
=9D uuid=3D=E2=80=9Duuid=E2=80=9D/>
pasted a few examples of api calls. Can someone direct me to a url
where I might learn about how to exercise an api with ruby? Thanks.
-----------------------------------------------
Description: Authenticate to a workspace on the host and create a
session. The name of the workspace for GG_userName is often the same as
the user name, but not in all cases. Therefore the workspace name is
returned in the result. 'userHostAdmin' indicates whether 'userName' is
an admin on the host. Admin users can perform operations in workspaces
other than the one authenticated to.
Example: http://localhost:8080/portal/web/host/createHostSession
Parameters - GG_hostId: host id returned by host/list operation.
GG_userInstanceId: The user instance ID returned by getPortalUser
GG_userName: username to authenticate.
GG_userPW: password.
GG_userDomain: user domain of workspace.
Returns: <?xml version=3D'1.0' encoding=3D'UTF-8' ?>
<session workspace=3D=E2=80=99name=E2=80=99 started=3D'true'
userHostAdmin=3D'true'>sessionNum</session>
------------------------------------------------
Description: Get a list of host drives (admin user only) & workspaces &
top level of files (for authenticated workspace only)
Example: http://localhost:8080/portal/web/host/get
Parameters - GG_hostId: host id returned by host/list operation.
GG_userInstanceId: The user instance ID returned by createHostSession
GG_userName: The username used when creating a session.
Returns: <?xml version=3D'1.0' encoding=3D'UTF-8' ?>
<items>
<item name=3D'itemName' id=3D'itemId' type=3D'itemType'
itemUrl=3D'itemUrl'/>
</items>
------------------------------------------------
Description: Register a host on the portal.
Example: http://localhost:8080/portal/web/host/register
Parameters - GG_hostAddress: The address of the host being registered.
GG_displayName: The user-friendly display name of the host being
registered.
GG_hardwareKey: The hardware key of the host being registered.
Returns: <?xml version=3D'1.0' encoding=3D'UTF-8' ?>
<item OS=3D=E2=80=9DOS=E2=80=9D displayName=3D=E2=80=9DdisplayName=E2=80=9D=
id=3D=E2=80=9Did=E2=80=9D name=3D=E2=80=9Dname=E2=80=9D
owner=3D=E2=80=9Downer=E2=80=9D smiAddress=3D=E2=80=9DsmiAddress=E2=80=9D=
smiPort=3D=E2=80=9DsmiPort=E2=80=9D
smiTransport=3D=E2=80=9DsmiTransport=E2=80=9D state=3D=E2=80=9Dstate=E2=80=
=9D uuid=3D=E2=80=9Duuid=E2=80=9D/>