Update a resource in a planning resource breakdown structure
patch
/fscmRestApi/resources/11.13.18.05/projectPlanningRbs/{projectPlanningRbsUniqID}/child/Elements/{ElementsUniqID}
Request
Path Parameters
-
ElementsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Elements resource and used to uniquely identify an instance of Elements. The client should not generate the hash key value. Instead, the client should query on the Elements collection resource in order to navigate to a specific instance of Elements to get the hash key.
-
projectPlanningRbsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Planning Resource Breakdown Structures for Projects resource and used to uniquely identify an instance of Planning Resource Breakdown Structures for Projects. The client should not generate the hash key value. Instead, the client should query on the Planning Resource Breakdown Structures for Projects collection resource in order to navigate to a specific instance of Planning Resource Breakdown Structures for Projects to get the hash key.
Header Parameters
-
Effective-Of:
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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DisabledFlag: boolean
Title:
Disabled
Maximum Length:1
Indicates if the resource is disabled for use in planning. -
InventoryItemNumber: string
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. -
ResourceClassId: integer
(int64)
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. -
ResourceClassName: string
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. -
ResourceName: string
Title:
Resource
Maximum Length:240
User defined short name for the resource breakdown structure element. -
SpreadCurveId: integer
(int64)
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. -
SpreadCurveName: string
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-Elements-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DisabledFlag: boolean
Title:
Disabled
Maximum Length:1
Indicates if the resource is disabled for use in planning. -
EventTypeId: integer
(int64)
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. -
EventTypeName: string
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. -
ExpenditureCategoryId: integer
(int64)
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. -
ExpenditureCategoryName: string
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. -
ExpenditureTypeId: integer
(int64)
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. -
ExpenditureTypeName: string
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. -
FormatId: integer
(int64)
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. -
FormatName: string
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. -
InventoryItemId: integer
(int64)
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. -
InventoryItemNumber: string
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. -
ItemCategoryCode: string
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. -
ItemCategoryId: integer
(int64)
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. -
ItemCategoryName: string
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. -
JobCode: string
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. -
JobId: integer
(int64)
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. -
JobName: string
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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonlaborResourceId: integer
(int64)
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. -
NonlaborResourceName: string
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. -
OrganizationId: integer
(int64)
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. -
OrganizationName: string
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. -
PersonEmail: string
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. -
PersonId: integer
(int64)
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. -
PersonName: string
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. -
PersonType: string
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. -
PersonTypeCode: string
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. -
ProjectRoleId: integer
(int64)
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. -
ProjectRoleName: string
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. -
ResourceClassId: integer
(int64)
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. -
ResourceClassName: string
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. -
ResourceElementId: integer
(int64)
Title:
Resource Element ID
Read Only:true
Unique identifier of the resource breakdown structure element. -
ResourceName: string
Title:
Resource
Maximum Length:240
User defined short name for the resource breakdown structure element. -
RevenueCategoryCode: string
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. -
RevenueCategoryName: string
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. -
SpreadCurveId: integer
(int64)
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. -
SpreadCurveName: string
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. -
SupplierId: integer
(int64)
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. -
SupplierName: string
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. -
SupplierNumber: string
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. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:80
Name of the default unit of measure of costing or planning transactions. -
UnitOfMeasureCode: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.