1. Oracle Prime Projects REST API
  2. Tasks
  3. Workspace

View a Workspace by Code

get

/primeapi/restapi/workspace/code/{code}

This endpoint returns workspaces that meet the following requirements:
  • The object has a name that matches the value of the {name} path parameter.

Request

Path Parameters

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : ApiEntityWorkspace
Type: object
Show Source
Nested Schema : ApiEntityWorkspaceImage
Type: object
Show Source
Nested Schema : workspaceAutonumSettings
Type: array
Unique Items Required: true
An object containing workspace autonumber settings.
Show Source
Nested Schema : workspaceSettings
Type: array
Unique Items Required: true
An object containing workspace settings.
Show Source
Nested Schema : image
Type: array
An image object represented in binary format.
Show Source
Nested Schema : ApiEntityWorkspaceAutonumSetting
Type: object
Show Source
Nested Schema : ApiEntityWorkspaceSetting
Type: object
Show Source

204 Response

Successful operation with no content.

404 Response

The requested work package does not exist or you do not have access to it.

Examples

The following examples show how to use the API to view a workspace by code.

Using cURL

Use cURL command line options to form and submit a request to the Prime server.

cURL Command

curl -X GET -H "Accept:application/json" -u "Molly Abraham:password123" https://localhost:7001/primeapi/restapi/workspace/code/infrastructure

Using Node JS

Use the Node JS https class interface to form and send an HTTP request to the Oracle Prime API server. Write a Node JS script that forms and sends an HTTP request, then execute the script with node to interact with the server.

Node JS Script

var https = require('https'); 
      var options = { 
          hostname: "localhost", 
          port: 7001, 
          method: 'GET', 
          path: "/primeapi/restapi/workspace/infrastructure", 
          auth: "Molly Abraham :password123" 
      } 
      var request = https.request(options, function(result){ 
          result.setEncoding('utf8'); 
          result.on('data', function(response){ 
              console.log(response); 
          }); 
      }); 
      request.end();

Example Response

When the command executes, the Oracle Prime server returns an HTTP response of content-type application/json:

Example of Response Header

HTTP/1.1 200 OK
Date: Thu, 22 Dec 2016 19:04:45 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

{ 
      		"securityGuid": "4F3AB071AE3D571BE05394B8580A3958", 
      		"workspaceSettings": [{ 
      				"workspaceId": 408, 
      				"workspaceSettingId": 1830, 
      				"settingName": "WorkPackageCodeCurrentSuffix", 
      				"settingValue": "0", 
      				"updateDate": "2017-05-10T23:27:55" 
      			}, { 
      				"workspaceId": 408, 
      				"workspaceSettingId": 1837, 
      				"settingName": "ProjectNameSepChar", 
      				"settingValue": ".", 
      				"updateDate": "2017-05-10T23:27:55" 
      			},  
      			//...more workspaceAutonumSettings objects 
      		], 
      		"parentWorkspace": 407, 
      		"workspaceCode": "road", 
      		"workspaceAutonumSettings": [{ 
      				"suffixIncrement": 1, 
      				"suffix": "10", 
      				"workspaceId": 408, 
      				"autonumId": 534, 
      				"prefix": "SI", 
      				"updateDate": "2017-05-10T23:27:55" 
      			}, { 
      				"suffixIncrement": 1, 
      				"suffix": "001", 
      				"workspaceId": 408, 
      				"autonumId": 528, 
      				"prefix": "PA", 
      				"updateDate": "2017-05-10T23:27:55" 
      			},  
      			//...more workspaceAutonumSettings objects. 
      		], 
      		"workspaceId": 408, 
      		"sequenceNumber": 10, 
      		"workspaceName": "road", 
      		"updateDate": "2017-05-10T23:27:55" 
      }