Get Shell

GET /ws/rest/service/v2/admin/shell

Purpose

Get all existing shells with additional properties such as Options, Links, and Currency. Get Shell REST service supports all options available through the user interface, including:

All currencies you added
Options such as Phase, Email Address, Send Notifications To (list of emails), Document Manager Attribute Form, E-Signature Type, Time Zone, Financial Period, Template Name, Shell Manager Attribute Form
Links you added
Default Calendar
Custom Print Template
Primavera Gateway integration
Primavera Cloud integration
View Forms such as Form Name, Permission Structure

Request Format

Send a GET request as a JSON map with the following structure:

{

"options":{"filter": {"shell_type" : "Buildings"}

}

Supported Request Parameter

The following request parameter can be included:

Request Parameters	Required?	Data Type	Description
filter > shelltype	No	String	Filters the shell data based on the shell type. If a filter condition is not provided, then the response displays all shells (not shell templates) with an Active status. If a filter condition is specified, then the response returns shells of the specified shell type only. Only one value for shell_type is supported.

Request Parameters

Required?

Data Type

Description

filter > shelltype

String

Filters the shell data based on the shell type.

If a filter condition is not provided, then the response displays all shells (not shell templates) with an Active status.

If a filter condition is specified, then the response returns shells of the specified shell type only.

Only one value for shell_type is supported.

Response Format

A JSON object is returned in the following format:

{

"data": [],

"message": [<list of messages>],

"status": <REST status code value>,

"rest_audit_id": "Value"

}

Sample Success Response

This is an example of a response that fetches two shells in an active status, with a success status code 200.

{

"data": [{

"uuu_latitude": null,

"upropYrBuiltPD": null,

"description": "Desc is updated",

"ulseLocationBuildingAreaIA": 0,

"LEED_Cert_Dateonly": null,

"uuu_longitude": null,

"upropOwnStatusPD": null,

"ugenPropertySubClass": null,

"ugenPropertyClass": null,

"LEED_Total_Score": 0.0,

"ugenCityTXT50": null,

"ugenZipCodeTXT16": null,

"ugenAddress3TXT120": null,

"uBuildingNumber": "BLDCBS - 0002",

"uuu_administrator": "Company Administrator",

"uuu_location": "/All Properties",

"uuu_address_code": "United States of America",

"ugenAddress1TXT120": null,

"uBuildingName": "W_BUILDING_CBS 0002",

"LEED_level_name": null,

"uuu_shell_status": "Active",

"ugenAddress2TXT120": null,

"ulvlUOMPD": "Sq Ft",

"ugenCountryPD": "United States of America",

"ugenStatePD": null,

"uRegionName": null,

"uSiteName": null,

"uSiteID": null,

"shell_type": "Building Properties - CBS",

"shell_model_name": "us_xbpcb",

"shell_number": "BLDCBS - 0002",

shell_name": "W_BUILDING_CBS 0002",

"shell_phase": "Preplanning",

"shell_location": "/All Properties",

"latitude": null,

"longitude": null,

"shell_id": 5074,

"uuu_shell_addl_props": {

"cloud": [{

"ext_project_id": "OPC02",

"ext_workspace_code": "OPCWORKSPACE",

"ext_project_name": "OPC02",

"ext_intg_type": 0,

"integration_type": "Primavera Cloud Cash Flow"

},

{

"ext_project_id": "OPC02",

"ext_workspace_code": "OPCWORKSPACE",

"ext_project_name": "OPC02",

"ext_intg_type": 1,

"integration_type": "Primavera Cloud Schedule"

},

{

"ext_project_id": "OPC_INT02",

"ext_workspace_code": "OPCWORKSPACE",

"ext_project_name": "OPC_INT02",

"ext_intg_type": 1,

"integration_type": "Primavera Cloud Schedule"

}],

"images": {

"shell_images": [{"id": 28608,

"file_name": "CICD Environment.png",

"file_size": 742909}

],

"shell_images_from_dm": []

},

"options": {"projectPhase": "Preplanning",

"timezone": "(UTC-12:00) International Date Line West",

"projectEmail": "127+5055232@internal-mail-router.oracle.com",

"financialPeriod": "FP1",

"dmFormUsed": "Folder and Document Attributes",

"notification": {"users": ["Company Administrator"],"groups": []},

"eSign": "None"

},

"links": [{"orderId": 1, "name": "Googles","url": "https://www.google.com"},

{"orderId": 2, "name": "Yahoo","url": "https://www.yahoo.com"}],

"currency": [{"rateType": "PEG",

"comments": "Metadata for the currency value",

"currencyName": "Indian Rupee (INR)",

"rate": 150.232,

"enableHedge": 0,

"currencySymbol": "",

"hedgeamount": 0.0,

"currencyCode": "INR",

isfloatpeg": 1,

"isProjectCurrency": "Yes",

"hedgerate": 0.0 },

{

"rateType": "FLOAT",

"comments": "",

"currencyName": "United States Dollar (USD)",

"rate": 1.0,

"enableHedge": 0,

"currencySymbol": "$",

"hedgeamount": 0.0,

"currencyCode": "USD",

"isfloatpeg": 0,

"isProjectCurrency": "No",

"hedgerate": 0.0

}],

"gateway": [{"p6_project_id": "Shell2","p6_project_name": null,"schedule_type": null},

{"p6_project_id": "EVM239","p6_project_name": null,"schedule_type": null},

{"p6_project_id": "EVM239","p6_project_name": null,"schedule_type": null}

]

}

},

{

"uuu_latitude": null,

"upropYrBuiltPD": null,

"description": null,

"ulseLocationBuildingAreaIA": 0,

"LEED_Cert_Dateonly": null,

"uuu_longitude": null,

"upropOwnStatusPD": null,

"ugenPropertySubClass": null,

"ugenPropertyClass": null,

"LEED_Total_Score": 0.0,

"ugenCityTXT50": null,

"ugenZipCodeTXT16": null,

"ugenAddress3TXT120": null,

"uBuildingNumber": "BLDCBS - 0003",

"uuu_administrator": "Company Administrator",

"uuu_location": "/All Properties",

"uuu_address_code": "United States of America",

"ugenAddress1TXT120": null,

"uBuildingName": "W_BUILDING_CBS 0003",

"LEED_level_name": null,

"uuu_shell_status": "Active",

"ugenAddress2TXT120": null,

"ulvlUOMPD": "Sq Ft",

"ugenCountryPD": "United States of America",

"ugenStatePD": null,

"uRegionName": null,

"uSiteName": null,

"uSiteID": null,

"shell_type": "Building Properties - CBS",

"shell_model_name": "us_xbpcb",

"shell_number": "BLDCBS - 0003",

"shell_name": "W_BUILDING_CBS 0003",

"shell_phase": "Preplanning",

"shell_location": "/All Properties",

"latitude": null,

"longitude": null,

"shell_id": 5141,

"uuu_shell_addl_props": {"cloud": [],

"images": {"shell_images": [],"shell_images_from_dm": []},

"options": {

"projectPhase": "Preplanning",

"timezone": "(UTC-12:00) International Date Line West",

"projectEmail": "127+5141@internal-mail-router.oracle.com",

"financialPeriod": "FP1",

"dmFormUsed": "Folder and Document Attributes",

"notification": {"users": [],"groups": []},

"eSign": "None"

},

"links": [{"orderId": 1,"name": "Google","url": "http://www.google.com"}],

"currency": [{"rateType": "FLOAT",

"comments": "",

"currencyName": "Afghani (AFN)",

"rate": 110.0,

"enableHedge": 0,

"currencySymbol": "؋",

"hedgeamount": 0.0,

"currencyCode": "AFN",

"isfloatpeg": 0,

"isProjectCurrency": "Yes",

"hedgerate": 0.0

},

{

"rateType": "FLOAT",

"comments": "",

"currencyName": "Indian Rupee (INR)",

"rate": 300.0,

"enableHedge": 0,

"currencySymbol": "",

"hedgeamount": 0.0,

"currencyCode": "INR",

"isfloatpeg": 0,

"isProjectCurrency": "No",

"hedgerate": 0.0

},

{

"rateType": "FLOAT",

"comments": "",

"currencyName": "United States Dollar (USD)",

"rate": 1.0,

"enableHedge": 0,

"currencySymbol": "$",

"hedgeamount": 0.0,

"currencyCode": "USD",

"isfloatpeg": 0,

"isProjectCurrency": "No",

"hedgerate": 0.0

}],

"gateway": [

{"p6_project_id": "EVM238","p6_project_name": null,"schedule_type": null}

]

}

],

"message": ["success"],

"status": 200,

"rest_audit_id": 9082

}

Sample Failed Response

If an incorrect shell_type is provided in the filter condition, status code 2051 displays with the following message in the response.

{

"data":[],

"message":[ "Invalid Shell Type : Buildings_1"],

"status":2051

}

Purpose

Request Format

Supported Request Parameter

Response Format

Sample Success Response

Sample Failed Response

Related Topics