Update a project set
patch
/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}
Request
Path Parameters
-
projectSetId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
description: string
Title:
DescriptionMaximum Length:240The description of the project set. -
filterSetFilters: array
Filter Sets and Filters
Title:
Filter Sets and FiltersThe filter sets and filters resource is used to view filter sets and their filters for a project set. -
filterSets: array
Filter Sets
Title:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set. -
jointVenture: string
Title:
Joint VentureMaximum Length:30The name of the joint venture. -
projectSetDFF: array
projectSetDFF
-
status: string
Title:
StatusMaximum Length:80The status of the project set.
Nested Schema : Filter Sets and Filters
Type:
arrayTitle:
Filter Sets and FiltersThe filter sets and filters resource is used to view filter sets and their filters for a project set.
Show Source
Nested Schema : Filter Sets
Type:
arrayTitle:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set.
Show Source
Nested Schema : jointVentureProjectSets-filterSetFilters-item-patch-request
Type:
Show Source
objectNested Schema : jointVentureProjectSets-filterSets-item-patch-request
Type:
Show Source
object-
description: string
Title:
DescriptionMaximum Length:240The description of the filter set. -
filters: array
Filters
Title:
FiltersThe filters resource is used to view, create, update, or delete filters for a filter set. -
projectFilterSetDFF: array
projectFilterSetDFF
Nested Schema : Filters
Type:
arrayTitle:
FiltersThe filters resource is used to view, create, update, or delete filters for a filter set.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-item-patch-request
Type:
Show Source
object-
attribute: string
Title:
AttributeThe attribute of the filter. -
filterValues: array
Filter Values
Title:
Filter ValuesThe filter values resource is used to view, create, update, or delete filter values. -
highValue: string
Title:
Value 2Maximum Length:255The second value of the filter. -
lowValue: string
Title:
Value 1Maximum Length:255The first value of the filter. -
operator: string
Title:
OperatorThe operator of the filter. -
projectFilterDFF: array
projectFilterDFF
Nested Schema : Filter Values
Type:
arrayTitle:
Filter ValuesThe filter values resource is used to view, create, update, or delete filter values.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-item-patch-request
Type:
Show Source
object-
projectFilterValueDFF: array
projectFilterValueDFF
-
value: string
Title:
ValueMaximum Length:255The value to include in a filter's list of values.
Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment
Nested Schema : jointVentureProjectSets-filterSets-filters-projectFilterDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment
Nested Schema : jointVentureProjectSets-filterSets-projectFilterSetDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment
Nested Schema : jointVentureProjectSets-projectSetDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment
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 : jointVentureProjectSets-item-response
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
description: string
Title:
DescriptionMaximum Length:240The description of the project set. -
filterSetFilters: array
Filter Sets and Filters
Title:
Filter Sets and FiltersThe filter sets and filters resource is used to view filter sets and their filters for a project set. -
filterSets: array
Filter Sets
Title:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set. -
jointVenture: string
Title:
Joint VentureMaximum Length:30The name of the joint venture. -
jointVentureDescription: string
Title:
DescriptionRead Only:trueThe description of the joint venture. -
language: string
Title:
Entered LanguageMaximum Length:4The language associated with the project set. -
languageDescription: string
Title:
Language NameRead Only:trueMaximum Length:255The description of the language associated with the project set. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectSet: string
Title:
Project SetMaximum Length:30The name of the project set. -
projectSetDFF: array
projectSetDFF
-
projectSetId: integer
(int64)
Title:
Project Set IDRead Only:trueThe unique identifier of the project set. -
status: string
Title:
StatusMaximum Length:80The status of the project set.
Nested Schema : Filter Sets and Filters
Type:
arrayTitle:
Filter Sets and FiltersThe filter sets and filters resource is used to view filter sets and their filters for a project set.
Show Source
Nested Schema : Filter Sets
Type:
arrayTitle:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSetFilters-item-response
Type:
Show Source
object-
attribute: string
Title:
AttributeRead Only:trueMaximum Length:80The attribute of the filter. -
description: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the filter set. -
filterCreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource item. -
filterCreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
filterId: integer
(int64)
Title:
Filter IDRead Only:trueThe unique identifier of the filter. -
filterLastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
filterLastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
filterSet: string
Title:
Filter SetRead Only:trueMaximum Length:30The unique name of the filter set. -
filterSetCreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource item. -
filterSetCreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
filterSetId: integer
(int64)
Title:
Filter Set IDRead Only:trueThe unique identifier of the filter set. -
filterSetLastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
filterSetLastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
filterValueCount: integer
Title:
Filter Value CountRead Only:trueThe number of filter values for a Matches Any filter. -
highValue: string
Title:
Value 2Read Only:trueMaximum Length:255The second value of the filter. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lowValue: string
Title:
Value 1Read Only:trueMaximum Length:255The first value of the filter. -
operator: string
Title:
OperatorRead Only:trueMaximum Length:80The operator of the filter.
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 : jointVentureProjectSets-filterSets-item-response
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
description: string
Title:
DescriptionMaximum Length:240The description of the filter set. -
filters: array
Filters
Title:
FiltersThe filters resource is used to view, create, update, or delete filters for a filter set. -
filterSet: string
Title:
Filter SetMaximum Length:30The unique name of the filter set. -
filterSetId: integer
(int64)
Title:
Filter Set IDThe unique identifier of the filter set. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectFilterSetDFF: array
projectFilterSetDFF
Nested Schema : Filters
Type:
arrayTitle:
FiltersThe filters resource is used to view, create, update, or delete filters for a filter set.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-item-response
Type:
Show Source
object-
attribute: string
Title:
AttributeThe attribute of the filter. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
filterId: integer
(int64)
Title:
Filter IDThe unique identifier of the filter. -
filterValues: array
Filter Values
Title:
Filter ValuesThe filter values resource is used to view, create, update, or delete filter values. -
highValue: string
Title:
Value 2Maximum Length:255The second value of the filter. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lowValue: string
Title:
Value 1Maximum Length:255The first value of the filter. -
operator: string
Title:
OperatorThe operator of the filter. -
projectFilterDFF: array
projectFilterDFF
Nested Schema : Filter Values
Type:
arrayTitle:
Filter ValuesThe filter values resource is used to view, create, update, or delete filter values.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-item-response
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the resource item was created. -
filterValueId: integer
(int64)
Title:
Filter Value IDThe unique identifier of the filter value. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the resource item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectFilterValueDFF: array
projectFilterValueDFF
-
value: string
Title:
ValueMaximum Length:255The value to include in a filter's list of values.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
FilterValueId: integer
(int64)
Title:
Filter Value ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-projectFilterDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
FilterId: integer
(int64)
Title:
Filter ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-projectFilterSetDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
FilterSetId: integer
(int64)
Title:
Filter Set ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-projectSetDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProjectSetId: integer
(int64)
Title:
Project Set ID
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- filterSetFilters
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSetFiltersParameters:
- projectSetId:
$request.path.projectSetId
The filter sets and filters resource is used to view filter sets and their filters for a project set. - projectSetId:
- filterSets
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSetsParameters:
- projectSetId:
$request.path.projectSetId
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set. - projectSetId:
- projectSetDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/projectSetDFFParameters:
- projectSetId:
$request.path.projectSetId
- projectSetId:
Examples
The following example shows how to update a project set by submitting a PATCH request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X PATCH "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556"
Example Request Body
The following shows an example of the request body in JSON format.
{
"description": "Project set for utility expenses-fuel only",
"status": "Editing",
"language":"US"
}
Example Response Body
The following shows an example of the response body in JSON format.
{
"projectSetId": 300100591586556,
"projectSet": "JV1UTILITIES",
"description": "Project set for utility expenses-fuel only",
"language": "US",
"languageDescription": "American English",
"status": "Editing",
"jointVenture": "JV1BASIN",
"jointVentureDescription": "Joint venture for permian basin",
"createdBy": "username",
"creationDate": "2024-05-22T05:30:41+00:00",
"lastUpdatedBy": "username",
"lastUpdateDate": "2024-05-22T05:58:03+00:00",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556",
"name": "jointVentureProjectSets",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556",
"name": "jointVentureProjectSets",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSetFilters",
"name": "filterSetFilters",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets",
"name": "filterSets",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/projectSetDFF",
"name": "projectSetDFF",
"kind": "collection"
}
]
}