Get Roles from the Master Rate Sheet
GET /ws/rest/service/v2/rate/sheet/roles?source={sourceApplication}
Purpose
Retrieve the list of roles synced from a source application based on source provided in the request.
Prerequisites
The user has access to fetch the data.
Sample Success Request
https://<SERVER_URL>/rest1/ws/rest/service/v2/rate/sheet?source="Primavera Cloud"
Sample Success Response For Oracle Primavera Cloud
{
"data": [
{
"roleCurrency": "USD",
"unitsPerTime": 1.0,
"roleCode": "Root1",
"workspaceCode": "Workspace1",
"rates": [
{
"ratesBreakdown": [
{
"roleStandardRate": 30.5,
"rateType": "Direct",
"costType": "Food",
"id": 1100
},
{
"roleStandardRate": 100.0,
"rateType": "Indirect",
"costType": "Food",
"id": 1101
}
],
"id": 1014,
"roleEffectiveDate": "2020-02-03T00:00:00"
}
],
"roleName": "Root1",
"id": 28,
"parentRoleCode": "",
"roleStatus": "Active"
},
{
"roleCurrency": "USD",
"unitsPerTime": 1.0,
"roleCode": "ChildRole1",
"workspaceCode": "Workspace1",
"rates": [
{
"ratesBreakdown": [
{
"roleStandardRate": 30.5,
"rateType": "Direct",
"costType": "Standard",
"id": 1098
},
{
"roleStandardRate": 100.0,
"rateType": "Indirect",
"costType": "Food",
"id": 1099
}
],
"id": 1013,
"roleEffectiveDate": "2020-02-03T00:00:00"
}
],
"roleName": "ChildRoleupdate2",
"id": 27,
"parentRoleCode": "Root1",
"roleStatus": "Active"
}
],
"message": [
"success"
],
"status": 200,
"rest_audit_id": 1932
}
Sample Success Response For P6
{
"data": [
{
"roleCurrency": "USD",
"unitsPerTime": 10.0,
"roleCode": "APIP6Role2C1",
"rates": [
{
"ratesBreakdown": [
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Food",
"id": 1165
},
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Standard",
"id": 1166
}
],
"id": 1053,
"roleEffectiveDate": "2020-02-01T00:00:00"
}
],
"roleName": "APIP6Role2C1update",
"id": 49,
"parentRoleCode": "APIP6Role2",
"roleStatus": "Active"
},
{
"roleCurrency": "USD",
"unitsPerTime": 200.0,
"roleCode": "APIP6Role2",
"rates": [
{
"ratesBreakdown": [
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Food",
"id": 1169
},
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Standard",
"id": 1170
}
],
"id": 1055,
"roleEffectiveDate": "2020-02-01T00:00:00"
}
],
"roleName": "APIP6Role2update",
"id": 50,
"parentRoleCode": "",
"roleStatus": "Active"
}
],
"message": [
"success"
],
"status": 200,
"rest_audit_id": 1933
}
Sample Success Response For Other Applications
{
"data": [
{
"roleCurrency": "USD",
"unitsPerTime": 150.0,
"roleCode": "r1",
"rates": [
{
"ratesBreakdown": [
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Food",
"id": 1288
},
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Standard",
"id": 1289
}
],
"id": 1118,
"roleEffectiveDate": "2020-02-01T00:00:00"
},
{
"ratesBreakdown": [
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Food",
"id": 1290
},
{
"roleStandardRate": 100.0,
"rateType": "Direct",
"costType": "Standard",
"id": 1291
}
],
"id": 1119,
"roleEffectiveDate": "2018-02-01T00:00:00"
}
],
"roleName": "Role1 update",
"id": 3,
"parentRoleCode": "r2",
"roleStatus": "Active"
}
],
"message": [
"success"
],
"status": 200,
"rest_audit_id": 1934
}
Sample Failed Response
{
"data": [],
"message": [
"Invalid value was found in a field: 'source'. Allowed values: [Primavera Cloud]"
],
"status": 12008,
"rest_audit_id": 4633
}
Related Topics
Create and Update Resources in the Master Rate Sheet
Create and Update Roles in the Master Rate Sheet
Get Resources from the Master Rate Sheet
Last Published Wednesday, April 9, 2025