Create a planning resource breakdown structure assignment to a project
post
/fscmRestApi/resources/11.13.18.05/projectPlanningRbs
Request
Header Parameters
-
Effective-Of: string
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. -
Metadata-Context: string
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".
-
REST-Framework-Version: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AllowChangingPrimaryPrbsFlag: boolean
Indicates if the primary planning resource breakdown structure should be changed even though there are baselined versions using the exising one.
-
AssignedToProjectId(required): integer
(int64)
Title:
Assigned to Project IDUnique identifier of the project to which the resource breakdown structure is associated. -
AssignedToProjectName(required): string
Title:
Assigned to Project NameMaximum Length:240Name of the project to which the resource breakdown structure is associated. -
AssignedToProjectNumber(required): string
Title:
Assigned to Project NumberMaximum Length:25Number of the project to which the resource breakdown structure is associated. -
AutoAddResourceFlag: boolean
Title:
Automatically add resources on incurring actual amountsMaximum Length:1Indicates whether to automatically add resources on incurring actual amounts. By default, the resources will be copied from setup level resource breakdown structure. -
Elements: array
Elements
Title:
ElementsThe Elements resource is used to view and create resources in a planning resource breakdown structure. -
Formats: array
Formats
Title:
FormatsThe Formats resource is used to view all resource formats supported by a planning resource breakdown structure. -
PlanningUsageFlag(required): boolean
Title:
PlanningMaximum Length:1Indicates if the resource breakdown structure can be used for planning purposes. -
PrimaryPlanningFlag(required): boolean
Title:
Primary PlanningMaximum Length:1Indicates if the resource breakdown structure is used as default in financial and project planning. -
PrimaryReportingRbsFlag(required): boolean
Title:
Primary ReportingMaximum Length:1Indicates if a resource breakdown structure is the primary reporting resource breakdown structure for a project. -
RbsHeaderId(required): integer
(int64)
Title:
Resource Breakdown Structure IDUnique identifier of the resource breakdown structure. -
RbsName: string
Title:
Resource Breakdown Structure NameMaximum Length:240Name of the resource breakdown structure. -
RbsVersionId(required): integer
(int64)
Title:
Resource Breakdown Structure Version IDUnique identifier of the resource breakdown structure version. -
ReportingUsageFlag(required): boolean
Title:
ReportingMaximum Length:1Indicates if a resource breakdown structure can be used for reporting purposes.
Nested Schema : Elements
Type:
arrayTitle:
ElementsThe Elements resource is used to view and create resources in a planning resource breakdown structure.
Show Source
Nested Schema : Formats
Type:
arrayTitle:
FormatsThe Formats resource is used to view all resource formats supported by a planning resource breakdown structure.
Show Source
Nested Schema : projectPlanningRbs-Elements-item-post-request
Type:
Show Source
object-
DisabledFlag: boolean
Title:
DisabledMaximum Length:1Indicates if the resource is disabled for use in planning. -
EventTypeId: integer
(int64)
Title:
Event Type IDUnique 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. -
EventTypeName: string
Title:
Event TypeMaximum Length:240Name 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. -
ExpenditureCategoryId: integer
(int64)
Title:
Expenditure Category IDUnique 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. -
ExpenditureCategoryName: string
Title:
Expenditure CategoryMaximum Length:240Name 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. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type IDUnique 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. -
ExpenditureTypeName: string
Title:
Expenditure TypeMaximum Length:240Name 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. -
FormatId: integer
(int64)
Title:
Format IDUnique identifier of the resource format. You must enter a value for either this attribute or Format but not both while creating a resource element. -
FormatName: string
Title:
FormatMaximum Length:240Name of the resource format. You must enter a value for either this attribute or Format ID but not both while creating a resource element. -
InventoryItemId: integer
(int64)
Title:
Inventory Item IDUnique 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. -
InventoryItemNumber: string
Title:
Inventory Item NumberMaximum Length:300Number 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. -
ItemCategoryCode: string
Title:
Item Category CodeMaximum Length:820Code 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. -
ItemCategoryId: integer
(int64)
Title:
Item Category IDUnique 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. -
ItemCategoryName: string
Title:
Item CategoryMaximum Length:2400Name 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. -
JobCode: string
Title:
Job CodeMaximum Length:30Code 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. -
JobId: integer
(int64)
Title:
Job IDUnique 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. -
JobName: string
Title:
JobMaximum Length:240Name 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. -
NonlaborResourceId: integer
(int64)
Title:
Nonlabor Resource IDUnique 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. -
NonlaborResourceName: string
Title:
Nonlabor ResourceMaximum Length:240Name 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. -
OrganizationId: integer
(int64)
Title:
Organization IDUnique 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. -
OrganizationName: string
Title:
OrganizationMaximum Length:240Name 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. -
PersonEmail: string
Title:
Person EmailMaximum Length:240Email 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. -
PersonId: integer
(int64)
Title:
Person IDUnique 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. -
PersonName: string
Title:
PersonMaximum Length:4000Name 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. -
PersonType: string
Title:
Person TypeMaximum Length:80Type 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. -
PersonTypeCode: string
Title:
Person Type CodeMaximum Length:255Code 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. -
ProjectRoleId: integer
(int64)
Title:
Project Role IDUnique 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. -
ProjectRoleName: string
Title:
Project RoleMaximum Length:240Name 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. -
ResourceClassId: integer
(int64)
Title:
Resource Class IDUnique 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. -
ResourceClassName: string
Title:
Resource ClassMaximum Length:240Name 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. -
ResourceName: string
Title:
ResourceMaximum Length:240User defined short name for the resource breakdown structure element. -
RevenueCategoryCode: string
Title:
Revenue Category CodeMaximum Length:255Code 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. -
RevenueCategoryName: string
Title:
Revenue CategoryMaximum Length:80Name 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. -
SpreadCurveId: integer
(int64)
Title:
Spread Curve IDUnique 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. -
SpreadCurveName: string
Title:
Spread CurveMaximum Length:240Name 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. -
SupplierId: integer
(int64)
Title:
Supplier IDUnique 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. -
SupplierName: string
Title:
SupplierMaximum Length:360Name 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. -
SupplierNumber: string
Title:
Supplier NumberMaximum Length:30Number 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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : projectPlanningRbs-item-response
Type:
Show Source
object-
AllowChangingPrimaryPrbsFlag: boolean
Indicates if the primary planning resource breakdown structure should be changed even though there are baselined versions using the exising one.
-
AllowResourceChangesFlag: boolean
Title:
Allow Resource ChangesRead Only:trueMaximum Length:1Indicates if new resources specific to the project can be added to the planning resource breakdown structure. -
AssignedToProjectId: integer
(int64)
Title:
Assigned to Project IDUnique identifier of the project to which the resource breakdown structure is associated. -
AssignedToProjectName: string
Title:
Assigned to Project NameMaximum Length:240Name of the project to which the resource breakdown structure is associated. -
AssignedToProjectNumber: string
Title:
Assigned to Project NumberMaximum Length:25Number of the project to which the resource breakdown structure is associated. -
AutoAddResourceFlag: boolean
Title:
Automatically add resources on incurring actual amountsMaximum Length:1Indicates whether to automatically add resources on incurring actual amounts. By default, the resources will be copied from setup level resource breakdown structure. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:2000Description of the resource breakdown structure. -
Elements: array
Elements
Title:
ElementsThe Elements resource is used to view and create resources in a planning resource breakdown structure. -
Formats: array
Formats
Title:
FormatsThe Formats resource is used to view all resource formats supported by a planning resource breakdown structure. -
JobSetId: integer
(int64)
Title:
Job Set IDRead Only:trueUnique identifier of the job set. -
JobSetName: string
Title:
Job SetRead Only:trueMaximum Length:80Name of the job set. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PlanningUsageFlag: boolean
Title:
PlanningMaximum Length:1Indicates if the resource breakdown structure can be used for planning purposes. -
PrimaryPlanningFlag: boolean
Title:
Primary PlanningMaximum Length:1Indicates if the resource breakdown structure is used as default in financial and project planning. -
PrimaryReportingRbsFlag: boolean
Title:
Primary ReportingMaximum Length:1Indicates if a resource breakdown structure is the primary reporting resource breakdown structure for a project. -
ProjectUnitId: integer
(int64)
Title:
Project Unit IDRead Only:trueUnique identifier of the project unit. -
ProjectUnitName: string
Title:
Project UnitRead Only:trueMaximum Length:240Name of the project unit. -
RbsEndDate: string
(date)
Title:
End DateRead Only:trueEnd date of the resource breakdown structure. -
RbsHeaderId: integer
(int64)
Title:
Resource Breakdown Structure IDUnique identifier of the resource breakdown structure. -
RbsName: string
Title:
Resource Breakdown Structure NameMaximum Length:240Name of the resource breakdown structure. -
RbsPrjAssignmentId: integer
(int64)
Title:
Resource Breakdown Structure Version Assignment to Project IDRead Only:trueUnique identifier of the assignment of the resource breakdown structure version to the project. -
RbsStartDate: string
(date)
Title:
Start DateRead Only:trueStart date of the resource breakdown structure. -
RbsVersionId: integer
(int64)
Title:
Resource Breakdown Structure Version IDUnique identifier of the resource breakdown structure version. -
ReportingUsageFlag: boolean
Title:
ReportingMaximum Length:1Indicates if a resource breakdown structure can be used for reporting purposes. -
TemplateFlag: boolean
Title:
Project TemplateRead Only:trueMaximum Length:1Indicates if a resource breakdown structure is assigned to a project template.
Nested Schema : Elements
Type:
arrayTitle:
ElementsThe Elements resource is used to view and create resources in a planning resource breakdown structure.
Show Source
Nested Schema : Formats
Type:
arrayTitle:
FormatsThe Formats resource is used to view all resource formats supported by a planning resource breakdown structure.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : projectPlanningRbs-Elements-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DisabledFlag: boolean
Title:
DisabledMaximum Length:1Indicates if the resource is disabled for use in planning. -
EventTypeId: integer
(int64)
Title:
Event Type IDUnique 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. -
EventTypeName: string
Title:
Event TypeMaximum Length:240Name 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. -
ExpenditureCategoryId: integer
(int64)
Title:
Expenditure Category IDUnique 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. -
ExpenditureCategoryName: string
Title:
Expenditure CategoryMaximum Length:240Name 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. -
ExpenditureTypeId: integer
(int64)
Title:
Expenditure Type IDUnique 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. -
ExpenditureTypeName: string
Title:
Expenditure TypeMaximum Length:240Name 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. -
FormatId: integer
(int64)
Title:
Format IDUnique identifier of the resource format. You must enter a value for either this attribute or Format but not both while creating a resource element. -
FormatName: string
Title:
FormatMaximum Length:240Name of the resource format. You must enter a value for either this attribute or Format ID but not both while creating a resource element. -
InventoryItemId: integer
(int64)
Title:
Inventory Item IDUnique 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. -
InventoryItemNumber: string
Title:
Inventory Item NumberMaximum Length:300Number 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. -
ItemCategoryCode: string
Title:
Item Category CodeMaximum Length:820Code 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. -
ItemCategoryId: integer
(int64)
Title:
Item Category IDUnique 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. -
ItemCategoryName: string
Title:
Item CategoryMaximum Length:2400Name 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. -
JobCode: string
Title:
Job CodeMaximum Length:30Code 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. -
JobId: integer
(int64)
Title:
Job IDUnique 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. -
JobName: string
Title:
JobMaximum Length:240Name 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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NonlaborResourceId: integer
(int64)
Title:
Nonlabor Resource IDUnique 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. -
NonlaborResourceName: string
Title:
Nonlabor ResourceMaximum Length:240Name 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. -
OrganizationId: integer
(int64)
Title:
Organization IDUnique 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. -
OrganizationName: string
Title:
OrganizationMaximum Length:240Name 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. -
PersonEmail: string
Title:
Person EmailMaximum Length:240Email 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. -
PersonId: integer
(int64)
Title:
Person IDUnique 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. -
PersonName: string
Title:
PersonMaximum Length:4000Name 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. -
PersonType: string
Title:
Person TypeMaximum Length:80Type 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. -
PersonTypeCode: string
Title:
Person Type CodeMaximum Length:255Code 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. -
ProjectRoleId: integer
(int64)
Title:
Project Role IDUnique 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. -
ProjectRoleName: string
Title:
Project RoleMaximum Length:240Name 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. -
ResourceClassId: integer
(int64)
Title:
Resource Class IDUnique 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. -
ResourceClassName: string
Title:
Resource ClassMaximum Length:240Name 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. -
ResourceElementId: integer
(int64)
Title:
Resource Element IDRead Only:trueUnique identifier of the resource breakdown structure element. -
ResourceName: string
Title:
ResourceMaximum Length:240User defined short name for the resource breakdown structure element. -
RevenueCategoryCode: string
Title:
Revenue Category CodeMaximum Length:255Code 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. -
RevenueCategoryName: string
Title:
Revenue CategoryMaximum Length:80Name 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. -
SpreadCurveId: integer
(int64)
Title:
Spread Curve IDUnique 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. -
SpreadCurveName: string
Title:
Spread CurveMaximum Length:240Name 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. -
SupplierId: integer
(int64)
Title:
Supplier IDUnique 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. -
SupplierName: string
Title:
SupplierMaximum Length:360Name 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. -
SupplierNumber: string
Title:
Supplier NumberMaximum Length:30Number 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. -
UnitOfMeasure: string
Title:
Unit of MeasureRead Only:trueMaximum Length:80Name of the default unit of measure of costing or planning transactions. -
UnitOfMeasureCode: string
Title:
Unit of Measure CodeRead Only:trueMaximum Length:30Code of the default unit of measure of costing or planning transactions.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : projectPlanningRbs-Formats-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
EquipmentFlag: boolean
Title:
EquipmentRead Only:trueMaximum Length:1Indicates if the resource format supports the Equipment resource class. -
FinancialResourcesFlag: boolean
Title:
Financial ResourcesRead Only:trueMaximum Length:1Indicates if the resource format supports the Financial Resources resource class. -
FormatId: integer
(int64)
Title:
Format IDRead Only:trueUnique identifier of the resource format. -
FormatName: string
Title:
FormatRead Only:trueMaximum Length:240Name of the resource format. -
LaborFlag: boolean
Title:
LaborRead Only:trueMaximum Length:1Indicates if the resource format supports the Labor resource class. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaterialItemsFlag: boolean
Title:
MaterialRead Only:trueMaximum Length:1Indicates if the resource format supports the Material Items resource class. -
RbsFormatId: integer
(int64)
Title:
Resource Breakdown Structure Format IDRead Only:trueUnique identifier of the association of a resource format to the resource breakdown structure.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Elements
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/ElementsParameters:
- projectPlanningRbsUniqID:
$request.path.projectPlanningRbsUniqID
The Elements resource is used to view and create resources in a planning resource breakdown structure. - projectPlanningRbsUniqID:
- Formats
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/FormatsParameters:
- projectPlanningRbsUniqID:
$request.path.projectPlanningRbsUniqID
The Formats resource is used to view all resource formats supported by a planning resource breakdown structure. - projectPlanningRbsUniqID:
Examples
The following example shows how to create a planning resource breakdown structure assignment to a project by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs
Request Body Example
The following shows an example of the request body in JSON format.
{
"AssignedToProjectNumber": "PJS Admin Proj1",
"RbsName": "sr_PRBS_NCC1",
"PrimaryPlanningFlag": "true",
"ReportingUsageFlag": "true",
"PrimaryReportingRbsFlag": "true",
"AllowChangingPrimaryPrbsFlag": "true"
}Response Body Example
The following shows an example of the response body in JSON format.
{
"AllowResourceChangesFlag": null,
"AssignedToProjectId": 300100167188229,
"AssignedToProjectName": "PJS Admin Proj1",
"AssignedToProjectNumber": "PJS Admin Proj1",
"Description": null,
"JobSetId": null,
"JobSetName": null,
"PlanningUsageFlag": true,
"PrimaryPlanningFlag": true,
"PrimaryReportingRbsFlag": true,
"ProjectUnitId": 100010023900163,
"ProjectUnitName": "Project Operations",
"RbsEndDate": null,
"RbsHeaderId": 300100184338390,
"RbsName": "sr_PRBS_NCC1",
"RbsPrjAssignmentId": 300100184338389,
"RbsStartDate": "2019-11-15",
"RbsVersionId": 300100184338391,
"ReportingUsageFlag": true,
"TemplateFlag": false,
"CreatedBy": "Ravi.Patel",
"CreationDate": "2019-11-15T05:59:23.001+05:30",
"LastUpdateDate": "2019-11-15T05:59:36.649+05:30",
"LastUpdatedBy": "Ravi.Patel",
"AllowChangingPrimaryPrbsFlag": true,
"links": [
{
"rel": "self",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338389",
"name": "projectPlanningRbs",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338389",
"name": "projectPlanningRbs",
"kind": "item"
},
{
"rel": "lov",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338389/lov/Projects",
"name": "Projects",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338389/lov/ProjectResourceBreakdownStructures",
"name": "ProjectResourceBreakdownStructures",
"kind": "collection"
},
{
"rel": "child",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338389/child/Elements",
"name": "Elements",
"kind": "collection"
},
{
"rel": "child",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338389/child/Formats",
"name": "Formats",
"kind": "collection"
}
]
}The following example shows how to create more than one planning resource breakdown structure assignments to a project by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/
Request Body Example
The following shows an example of the request body in JSON format.
{
"parts" : [
{
"id" : "part0", "path" : "/projectPlanningRbs", "operation" : "create",
"payload" : {
"AssignedToProjectNumber": "PJS Admin Proj1",
"RbsName": "sr_PRBS_CC1",
"ReportingUsageFlag": "true"
}
},
{
"id" : "part1", "path" : "/projectPlanningRbs", "operation" : "create",
"payload" : {
"AssignedToProjectNumber": "PJS Admin Proj1",
"RbsName": "sr_PRBS_NCC1",
"PrimaryPlanningFlag": "true",
"ReportingUsageFlag": "true",
"PrimaryReportingRbsFlag": "false",
"AllowChangingPrimaryPrbsFlag": "true"
}
}
]
}Response Body Example
The following shows an example of the response body in JSON format.
{
"parts": [
{
"id": "part0",
"path": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs",
"operation": "create",
"payload": {
"AllowResourceChangesFlag": false,
"AssignedToProjectId": 300100167188229,
"AssignedToProjectName": "PJS Admin Proj1",
"AssignedToProjectNumber": "PJS Admin Proj1",
"Description": null,
"JobSetId": null,
"JobSetName": null,
"PlanningUsageFlag": true,
"PrimaryPlanningFlag": false,
"PrimaryReportingRbsFlag": false,
"ProjectUnitId": 100010023900163,
"ProjectUnitName": "Project Operations",
"RbsEndDate": null,
"RbsHeaderId": 300100184337389,
"RbsName": "sr_PRBS_CC1",
"RbsPrjAssignmentId": 300100184338396,
"RbsStartDate": "2019-11-15",
"RbsVersionId": 300100184337390,
"ReportingUsageFlag": true,
"TemplateFlag": false,
"CreatedBy": "ABRAHAM.MASON",
"CreationDate": "2019-11-15T07:10:49+05:30",
"LastUpdateDate": "2019-11-15T07:10:49.209+05:30",
"LastUpdatedBy": "ABRAHAM.MASON",
"AllowChangingPrimaryPrbsFlag": null,
"links": [
{
"rel": "self",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338396",
"name": "projectPlanningRbs",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338396",
"name": "projectPlanningRbs",
"kind": "item"
},
{
"rel": "lov",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338396/lov/Projects",
"name": "Projects",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338396/lov/ProjectResourceBreakdownStructures",
"name": "ProjectResourceBreakdownStructures",
"kind": "collection"
},
{
"rel": "child",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338396/child/Elements",
"name": "Elements",
"kind": "collection"
},
{
"rel": "child",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338396/child/Formats",
"name": "Formats",
"kind": "collection"
}
]
}
},
{
"id": "part1",
"path": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs",
"operation": "create",
"payload": {
"AllowResourceChangesFlag": true,
"AssignedToProjectId": 300100167188229,
"AssignedToProjectName": "PJS Admin Proj1",
"AssignedToProjectNumber": "PJS Admin Proj1",
"Description": null,
"JobSetId": null,
"JobSetName": null,
"PlanningUsageFlag": true,
"PrimaryPlanningFlag": true,
"PrimaryReportingRbsFlag": false,
"ProjectUnitId": 100010023900163,
"ProjectUnitName": "Project Operations",
"RbsEndDate": null,
"RbsHeaderId": 300100184338398,
"RbsName": "sr_PRBS_NCC1",
"RbsPrjAssignmentId": 300100184338397,
"RbsStartDate": "2019-11-15",
"RbsVersionId": 300100184338399,
"ReportingUsageFlag": true,
"TemplateFlag": false,
"CreatedBy": "ABRAHAM.MASON",
"CreationDate": "2019-11-15T07:10:49.113+05:30",
"LastUpdateDate": "2019-11-15T07:10:49.443+05:30",
"LastUpdatedBy": "ABRAHAM.MASON",
"AllowChangingPrimaryPrbsFlag": null,
"links": [
{
"rel": "self",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338397",
"name": "projectPlanningRbs",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338397",
"name": "projectPlanningRbs",
"kind": "item"
},
{
"rel": "lov",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338397/lov/Projects",
"name": "Projects",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338397/lov/ProjectResourceBreakdownStructures",
"name": "ProjectResourceBreakdownStructures",
"kind": "collection"
},
{
"rel": "child",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338397/child/Elements",
"name": "Elements",
"kind": "collection"
},
{
"rel": "child",
"href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/300100184338397/child/Formats",
"name": "Formats",
"kind": "collection"
}
]
}
}
]
}