Update one relationship
patch
/fscmRestApi/resources/11.13.18.05/productProposals/{ProductProposalId}/child/Relationships/{RelationshipsUniqID}
Request
Path Parameters
-
ProductProposalId(required): integer(int64)
Value that uniquely identifies the product proposal.
-
RelationshipsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Relationships resource and used to uniquely identify an instance of Relationships. The client should not generate the hash key value. Instead, the client should query on the Relationships collection resource in order to navigate to a specific instance of Relationships to get the hash key.
Header Parameters
-
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-
Description: string
Description of the related object.
-
DestObjId: integer
(int64)
Value that uniquely identifies the destination object.
-
DestObjType: string
Maximum Length:
30Type of the destination object. -
LatestFlag: boolean
Contains one of the following values: true or false. If true, then the related object is the latest. If false, then the related object is not the latest. This attribute does not have a default value.
-
Name: string
Name of the related object.
-
ObjectSubType: string
Object subtype of the related object.
-
ObjectTypeValue: string
Display value of the object type.
-
OrganizationCode: string
Organization code of the related object.
-
RelationshipType: string
Title:
Relationship TypeMaximum Length:30Type of relationship. -
RelationshipTypeValue: string
Maximum Length:
255Display value of the relationship type. -
Revision: string
Maximum Length:
255Value that indicates the version or revision of the referenced object. -
SrcObjId: integer
(int64)
Value that uniquely identifies the source object.
-
SrcObjType: string
Maximum Length:
30Type of the source object. -
Status: string
Status of the related object.
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 : productProposals-Relationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the relationship. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the relationship. -
Description: string
Description of the related object.
-
DestObjId: integer
(int64)
Value that uniquely identifies the destination object.
-
DestObjType: string
Maximum Length:
30Type of the destination object. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the relationship. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the relationship. -
LatestFlag: boolean
Contains one of the following values: true or false. If true, then the related object is the latest. If false, then the related object is not the latest. This attribute does not have a default value.
-
LatestFlagName: string
Read Only:
trueName of the latest flag. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Name of the related object.
-
ObjectSubType: string
Object subtype of the related object.
-
ObjectTypeValue: string
Display value of the object type.
-
OrganizationCode: string
Organization code of the related object.
-
RelatedObjectPk1Value: integer
(int64)
Read Only:
trueFirst primary key identifier of the related object in the relationship. -
RelatedObjectPk2Value: integer
(int64)
Read Only:
trueSecond primary key identifier of the related object in the relationship. -
RelationshipId: integer
(int64)
Read Only:
trueValue that uniquely identifies the relationship. -
RelationshipType: string
Title:
Relationship TypeMaximum Length:30Type of relationship. -
RelationshipTypeValue: string
Maximum Length:
255Display value of the relationship type. -
Revision: string
Maximum Length:
255Value that indicates the version or revision of the referenced object. -
SrcObjId: integer
(int64)
Value that uniquely identifies the source object.
-
SrcObjType: string
Maximum Length:
30Type of the source object. -
Status: string
Status of the related object.
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.
Examples
This example describes how to update a relationship.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/productProposals/ProductProposalId/child/Relationships/RelationshipsUniqID"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"RelationshipType" : "ORA_IMPACTED_BY"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"RelationshipId": 300100231698008,
"RelationshipType": "ORA_IMPACTED_BY",
"CreatedBy": "PLM_AUTO",
"CreationDate": "2020-11-13T15:41:20+00:00",
"LastUpdateDate": "2020-11-13T15:45:17+00:00",
"LastUpdatedBy": "PRODUCT_MANAGER",
"DestObjType": "ORA_ACTION",
"DestObjId": 300100210593765,
"SrcObjType": "PROPOSAL",
"SrcObjId": 300100231710787,
"Name": "XYZ-202011031102",
"Description": "Test Data",
"Status": "Draft",
"LatestFlag": "true",
"LatestFlagName": "Yes",
"RelationshipTypeName": "Impacted by",
"DestObjTypeName": "Quality Actions",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100231710787/child/Relationships/300100231698008",
"name": "Relationships",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100231710787/child/Relationships/300100231698008",
"name": "Relationships",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/productProposals/300100231710787",
"name": "productProposals",
"kind": "item"
}
]
}