1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Planning Resource Breakdown Structures for Projects

Get all planning resource breakdown structures assigned to projects

get

/fscmRestApi/resources/11.13.18.05/projectPlanningRbs

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the assignment of a resource breakdown structure version to a project with the specified value of Resource Break Structure Version Assignment to Project ID.
      Finder Variables:
      • RbsPrjAssignmentId; integer; Unique identifier of the assignment of the resource breakdown structure version to the project.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AllowResourceChangesFlag; boolean; Indicates if new resources specific to the project can be added to the planning resource breakdown structure.
    • AssignedToProjectId; integer; Unique identifier of the project to which the resource breakdown structure is associated.
    • AssignedToProjectName; string; Name of the project to which the resource breakdown structure is associated.
    • AssignedToProjectNumber; string; Number of the project to which the resource breakdown structure is associated.
    • AutoAddResourceFlag; boolean; Indicates whether to automatically add resources on incurring actual amounts. By default, the resources will be copied from setup level resource breakdown structure.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • Description; string; Description of the resource breakdown structure.
    • JobSetId; integer; Unique identifier of the job set.
    • JobSetName; string; Name of the job set.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • PlanningUsageFlag; boolean; Indicates if the resource breakdown structure can be used for planning purposes.
    • PrimaryPlanningFlag; boolean; Indicates if the resource breakdown structure is used as default in financial and project planning.
    • PrimaryReportingRbsFlag; boolean; Indicates if a resource breakdown structure is the primary reporting resource breakdown structure for a project.
    • ProjectUnitId; integer; Unique identifier of the project unit.
    • ProjectUnitName; string; Name of the project unit.
    • RbsEndDate; string; End date of the resource breakdown structure.
    • RbsHeaderId; integer; Unique identifier of the resource breakdown structure.
    • RbsName; string; Name of the resource breakdown structure.
    • RbsPrjAssignmentId; integer; Unique identifier of the assignment of the resource breakdown structure version to the project.
    • RbsStartDate; string; Start date of the resource breakdown structure.
    • RbsVersionId; integer; Unique identifier of the resource breakdown structure version.
    • ReportingUsageFlag; boolean; Indicates if a resource breakdown structure can be used for reporting purposes.
    • TemplateFlag; boolean; Indicates if a resource breakdown structure is assigned to a project template.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : projectPlanningRbs
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectPlanningRbs-item-response
Type: object
Show Source
Nested Schema : Elements
Type: array
Title: Elements
The Elements resource is used to view and create resources in a planning resource breakdown structure.
Show Source
Nested Schema : Formats
Type: array
Title: Formats
The Formats resource is used to view all resource formats supported by a planning resource breakdown structure.
Show Source
Nested Schema : projectPlanningRbs-Elements-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Disabled
    Maximum Length: 1
    Indicates if the resource is disabled for use in planning.
  • Title: Event Type ID
    Unique identifier of the event type. If the format has Event Type, then you must enter a value for either this attribute or Event Type but not both while creating a resource element.
  • Title: Event Type
    Maximum Length: 240
    Name of the event type. If the format has Event Type, then you must enter a value for either this attribute or Event Type ID but not both while creating a resource element.
  • Title: Expenditure Category ID
    Unique identifier of the expenditure category. If the format has Expenditure Category, then you must enter a value for either this attribute or Expenditure Category but not both while creating a resource element.
  • Title: Expenditure Category
    Maximum Length: 240
    Name of the expenditure category. If the format has Expenditure Category, then you must enter a value for either this attribute or Expenditure Category ID but not both while creating a resource element.
  • Title: Expenditure Type ID
    Unique identifier of the expenditure type. If the format has Expenditure Type, then you must enter a value for either this attribute or Expenditure Type but not both while creating a resource element.
  • Title: Expenditure Type
    Maximum Length: 240
    Name of the expenditure type. If the format has Expenditure Type, then you must enter a value for either this attribute or Expenditure Type ID but not both while creating a resource element.
  • Title: Format ID
    Unique identifier of the resource format. You must enter a value for either this attribute or Format but not both while creating a resource element.
  • Title: Format
    Maximum Length: 240
    Name of the resource format. You must enter a value for either this attribute or Format ID but not both while creating a resource element.
  • Title: Inventory Item ID
    Unique identifier of the inventory item. If the format has Inventory Item, then you must enter a value for either this attribute or Inventory Item Number but not both while creating a resource element.
  • Title: Inventory Item Number
    Maximum Length: 300
    Number assigned to the inventory item. If the format has Inventory Item, then you must enter a value for either this attribute or Inventory Item ID but not both while creating a resource element.
  • Title: Item Category Code
    Maximum Length: 820
    Code of the item category. If the format has Item Category, then you must enter a value for only one from among this attribute, Item Category ID, and Item Category but not all three or a combination of them while creating a resource element.
  • Title: Item Category ID
    Unique identifier of the item category. If the format has Item Category, then you must enter a value for only one from among this attribute, Item Category Code, and Item Category but not all three or a combination of them while creating a resource element.
  • Title: Item Category
    Maximum Length: 2400
    Name of the item category. If the format has Item Category, then you must enter a value for only one from among this attribute, Item Category ID, and Item Category Code but not all three or a combination of them while creating a resource element.
  • Title: Job Code
    Maximum Length: 30
    Code of the job. If the format has Job, then you must enter a value for only one from among this attribute, Job ID, and Job but not all three or a combination of them while creating a resource element.
  • Title: Job ID
    Unique identifier of the job. If the format has Job, then you must enter a value for only one from among this attribute, Job Code, and Job but not all three or a combination of them while creating a resource element.
  • Title: Job
    Maximum Length: 240
    Name of the job. If the format has Job, then you must enter a value for only one from among this attribute, Job ID, and Job Code but not all three or a combination of them while creating a resource element.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Nonlabor Resource ID
    Unique identifier of the nonlabor resource. If the format has Project Nonlabor Resource, then you must enter a value for either this attribute or Nonlabor Resource but not both while creating a resource element.
  • Title: Nonlabor Resource
    Maximum Length: 240
    Name of the nonlabor resource. If the format has Project Nonlabor Resource, then you must enter a value for either this attribute or Nonlabor Resource ID but not both while creating a resource element.
  • Title: Organization ID
    Unique identifier of the organization. If the format has Organization, then you must enter a value for either this attribute or Organization but not both while creating a resource element.
  • Title: Organization
    Maximum Length: 240
    Name of the organization. If the format has Organization, then you must enter a value for either this attribute or Organization ID but not both while creating a resource element.
  • Title: Person Email
    Maximum Length: 240
    Email of the person. If the format has Named Person, then you must enter a value for only one from among this attribute, Person ID, and Person but not all three or a combination of them while creating a resource element.
  • Title: Person ID
    Unique identifier of the person. If the format has Named Person, then you must enter a value for only one from among this attribute, Person Email, and Person but not all three or a combination of them while creating a resource element.
  • Title: Person
    Maximum Length: 4000
    Name of the person. If the format has Named Person, then you must enter a value for only one from among this attribute, Person ID, and Person Email but not all three or a combination of them while creating a resource element.
  • Title: Person Type
    Maximum Length: 80
    Type of the person. If the format has System Person Type, then you must enter a value for either this attribute or Person Type Code but not both while creating a resource element.
  • Title: Person Type Code
    Maximum Length: 255
    Code of the person type. If the format has System Person Type, then you must enter a value for either this attribute or Person Type but not both while creating a resource element.
  • Title: Project Role ID
    Unique identifier of the project role. If the format has Project Role, then you must pass a value for Project Role ID or Project Role Name but not both values while creating a resource element.
  • Title: Project Role
    Maximum Length: 240
    Name of the project role. If the format has Project Role, then you must pass a value for Project Role ID or Project Role Name but not both values while creating a resource element.
  • Title: Resource Class ID
    Unique identifier of the resource class. You must enter a value for either this attribute or Resource Class but not both while creating a resource element.
  • Title: Resource Class
    Maximum Length: 240
    Name of the resource class. You must enter a value for either this attribute or Resource Class ID but not both while creating a resource element.
  • Title: Resource Element ID
    Read Only: true
    Unique identifier of the resource breakdown structure element.
  • Title: Resource
    Maximum Length: 240
    User defined short name for the resource breakdown structure element.
  • Title: Revenue Category Code
    Maximum Length: 255
    Code of the revenue category. If the format has Revenue Category, then you must enter a value for either this attribute or Revenue Category but not both while creating a resource element.
  • Title: Revenue Category
    Maximum Length: 80
    Name of the revenue category. If the format has Revenue Category, then you must enter a value for either this attribute or Revenue Category ID but not both while creating a resource element.
  • Title: Spread Curve ID
    Unique identifier of the spread curve. If you want to specify the spread curve, then you must enter a value for either this attribute or Spread Curve but not both while creating a resource element.
  • Title: Spread Curve
    Maximum Length: 240
    Name of the spread curve. If you want to specify the spread curve, then you must enter a value for either this attribute or Spread Curve ID but not both while creating a resource element.
  • Title: Supplier ID
    Unique identifier of the supplier. If the format has Supplier, then you must enter a value for only one from among this attribute, Supplier Number, and Supplier but not all three or a combination of them while creating a resource element.
  • Title: Supplier
    Maximum Length: 360
    Name of the supplier. If the format has Supplier, then you must enter a value for only one from among this attribute, Supplier ID, and Supplier Number but not all three or a combination of them while creating a resource element.
  • Title: Supplier Number
    Maximum Length: 30
    Number assigned to the supplier. If the format has Supplier, then you must enter a value for only one from among this attribute, Supplier ID, and Supplier but not all three or a combination of them while creating a resource element.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 80
    Name of the default unit of measure of costing or planning transactions.
  • Title: Unit of Measure Code
    Read Only: true
    Maximum Length: 30
    Code of the default unit of measure of costing or planning transactions.
Nested Schema : projectPlanningRbs-Formats-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all planning resource breakdown structures assigned to projects by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs

Response Body Example

The following shows an example of the response body in JSON format.

{
"items": [
  {
"AllowResourceChangesFlag": false,
"AssignedToProjectId": 300100170133655,
"AssignedToProjectName": "ProServ Fin Consulting",
"AssignedToProjectNumber": "11",
"Description": "An internal planning resource breakdown structure.",
"JobSetId": null,
"JobSetName": null,
"PrimaryPlanningFlag": false,
"ProjectUnitId": 300100038013245,
"ProjectUnitName": "Projects Common",
"RbsEndDate": null,
"RbsHeaderId": 300100048186853,
"RbsName": "Default - Projects Common",
"RbsPrjAssignmentId": 300100170133657,
"RbsStartDate": "2009-05-29",
"RbsVersionId": 300100048186854,
"CreatedBy": "Daniel.Parker",
"CreationDate": "2018-12-10T05:33:07.915+00:00",
"LastUpdateDate": "2018-12-10T05:33:28.715+00:00",
"LastUpdatedBy": "Daniel.Parker"
}
]
}
Back to Top