Jump to

• Request
• Response
• Examples

Update one relationship

patch

/fscmRestApi/resources/11.13.18.05/qualityActions/{ActionId}/child/Relationships/{RelationshipsUniqID}

Request

Path Parameters

• ActionId(required): integer(int64)
  Value that uniquely identifies the quality action.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Description of the related object.
• DestObjId: integer (int64)
  Value that uniquely identifies the destination object.
• DestObjType: string
  Maximum Length: 30

  Type 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.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Type of relationship.
• SrcObjId: integer (int64)
  Value that uniquely identifies the source object.
• SrcObjType: string
  Maximum Length: 30

  Type of the source object.
• Status: string
  Status of the related object.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Status of the related object.",
            "nullable":true
        },
        "SrcObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "type":"string",
            "description":"Description of the related object.",
            "nullable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of relationship.",
            "nullable":true
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "DestObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DestObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the destination object.",
            "nullable":true
        },
        "SrcObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the source object.",
            "nullable":false
        },
        "Name":{
            "type":"string",
            "description":"Name of the related object.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : qualityActions-Relationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the relationship.
• CreationDate: string (date-time)
  Read Only: true

  Date 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: 30

  Type of the destination object.
• DestObjTypeName: string
  Read Only: true

  Name of the destination object type.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the relationship.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User 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: true

  Name of the latest flag.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the related object.
• RelationshipId: integer (int64)
  Read Only: true

  Value that uniquely identifies the relationship.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Type of relationship.
• RelationshipTypeName: string
  Read Only: true

  Name of the relationship type.
• SrcObjId: integer (int64)
  Value that uniquely identifies the source object.
• SrcObjType: string
  Maximum Length: 30

  Type of the source object.
• Status: string
  Status of the related object.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DestObjTypeName":{
            "type":"string",
            "description":"Name of the destination object type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the destination object.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeName":{
            "type":"string",
            "description":"Name of the relationship type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrcObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the source object.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DestObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LatestFlagName":{
            "type":"string",
            "description":"Name of the latest flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

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/qualityActions/ActionId/child/Relationships/RelationshipsUniqID"

For example, the following command updates a relationship:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/qualityActions/300100111060019/child/Relationships/300100238393104"

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" : 300100238393104,
	"RelationshipType" : "ORA_IMPACTED_BY",
	"CreatedBy" : "PLM_AUTO",
	"CreationDate" : "2020-03-05T12:08:22.366+00:00",
	"LastUpdateDate" : "2020-03-05T12:20:38+00:00",
	"LastUpdatedBy" : "PLM_AUTO",
	"DestObjType" : "ORA_ACTION",
	"DestObjId" : 300100171077730,
	"SrcObjType" : "CHANGE",
	"SrcObjId" : 300100238393092,
	"Name" : "Analyze AS54999",
	"Description" : "ACTION13",
	"Status" : "Draft",
	"LatestFlag" : "true",
	"LatestFlagName" : "Yes",
	"RelationshipTypeName" : "Impacted by",
	"DestObjTypeName" : "Quality Actions",
	...
}

Back to Top