Jump to

• Request
• Response

Update one row on the relationship tab of a corrective action

patch

/fscmRestApi/resources/11.13.18.05/qualityCorrectiveAndPreventiveActions/{qualityCorrectiveAndPreventiveActionsUniqID}/child/correctiveActionRelationships/{correctiveActionRelationshipsUniqID}

Request

Path Parameters

• correctiveActionRelationshipsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Corrective Action Relationships resource and used to uniquely identify an instance of Corrective Action Relationships. The client should not generate the hash key value. Instead, the client should query on the Corrective Action Relationships collection resource in order to navigate to a specific instance of Corrective Action Relationships to get the hash key.
• qualityCorrectiveAndPreventiveActionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Quality Corrective and Preventive Actions resource and used to uniquely identify an instance of Quality Corrective and Preventive Actions. The client should not generate the hash key value. Instead, the client should query on the Quality Corrective and Preventive Actions collection resource in order to navigate to a specific instance of Quality Corrective and Preventive Actions 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 corrective and preventive action object relationships.
• LatestFlag: boolean
  The latest Boolean attribute of the relationship of the corrective and preventive action object relationships.
• Name: string
  The name of the relationship of the corrective and preventive action object relationships.
• relationshipRules: array Change Order Relationship Rules
  Title: Change Order Relationship Rules

  The Relationship Rules resource manages rules related to relationships on change orders.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  The relationship type of the corrective and preventive action object relationships.
• Status: string
  The status of relationship of the Corrective Action

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"The status of relationship of the Corrective Action",
            "nullable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type of the corrective and preventive action object relationships.",
            "nullable":true
        },
        "relationshipRules":{
            "title":"Change Order Relationship Rules",
            "type":"array",
            "description":"The Relationship Rules resource manages rules related to relationships on change orders.",
            "items":{
                "$ref":"#/components/schemas/qualityCorrectiveAndPreventiveActions-correctiveActionRelationships-relationshipRules-item-patch-request"
            }
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"The latest Boolean attribute of the relationship of the corrective and preventive action object relationships.",
            "nullable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the corrective and preventive action object relationships.",
            "nullable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the relationship of the corrective and preventive action object relationships.",
            "nullable":true
        }
    }
}

Nested Schema : Change Order Relationship Rules

Type: array

Title: Change Order Relationship Rules

The Relationship Rules resource manages rules related to relationships on change orders.

Show Source

• Array of: object schema

{
    "title":"Change Order Relationship Rules",
    "type":"array",
    "description":"The Relationship Rules resource manages rules related to relationships on change orders.",
    "items":{
        "$ref":"#/components/schemas/qualityCorrectiveAndPreventiveActions-correctiveActionRelationships-relationshipRules-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DestinationObjectType: string
  Maximum Length: 30

  Destination object type of the change order object relationship.
• DestinationRuleStatus: string
  Maximum Length: 255

  Destination object workflow status defined in the relationship rule.
• RelationshipId: integer (int64)
  Relationship ID of the change order object relationship.
• SourceObjectType: string
  Maximum Length: 30

  Source object type of the change order object relationship.
• SourceRuleStatus: string
  Maximum Length: 255

  Source object workflow status defined in the relationship rule.

{
    "type":"object",
    "properties":{
        "DestinationObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Destination object type of the change order object relationship.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DestinationRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Destination object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SourceRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Source object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Relationship ID of the change order object relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "SourceObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Source object type of the change order object relationship.",
            "nullable":false
        }
    }
}

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 : qualityCorrectiveAndPreventiveActions-correctiveActionRelationships-item-response

Type: object

Show Source

• ChangeNotice: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the corrective and preventive action object relationships.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the corrective and preventive action object relationships.
• CreationDateTime: string (date-time)
  Read Only: true

  Date when the corrective and preventive action object relationships was created.
• Description: string
  Description of the corrective and preventive action object relationships.
• DestinationObjectId: integer
  The destination object identifier of the relationship of the Corrective Action.
• DestinationObjectType: string
  The destination object type of the relationship of the Corrective Action.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date when the corrective and preventive action object relationships was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the corrective and preventive action object relationships.
• LatestFlag: boolean
  The latest Boolean attribute of the relationship of the corrective and preventive action object relationships.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  The name of the relationship of the corrective and preventive action object relationships.
• RelationshipId: integer (int64)
  Read Only: true

  The relationship identifier of the corrective action and preventive action object relationships.
• relationshipRules: array Change Order Relationship Rules
  Title: Change Order Relationship Rules

  The Relationship Rules resource manages rules related to relationships on change orders.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  The relationship type of the corrective and preventive action object relationships.
• SourceObjectId: integer
  Read Only: true

  The source object identifier of relationship of the corrective action.
• SourceObjectType: string
  Read Only: true

  The source object type of the relationship of the corrective action.
• Status: string
  The status of relationship of the Corrective Action

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the corrective and preventive action object relationships.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of relationship of the Corrective Action",
            "nullable":true,
            "x-queryable":true
        },
        "relationshipRules":{
            "title":"Change Order Relationship Rules",
            "type":"array",
            "description":"The Relationship Rules resource manages rules related to relationships on change orders.",
            "items":{
                "$ref":"#/components/schemas/qualityCorrectiveAndPreventiveActions-correctiveActionRelationships-relationshipRules-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the corrective and preventive action object relationships.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the corrective and preventive action object relationships.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when the corrective and preventive action object relationships was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The relationship type of the corrective and preventive action object relationships.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"The latest Boolean attribute of the relationship of the corrective and preventive action object relationships.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationObjectType":{
            "type":"string",
            "description":"The destination object type of the relationship of the Corrective Action.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectType":{
            "type":"string",
            "description":"The source object type of the relationship of the corrective action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the relationship of the corrective and preventive action object relationships.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The source object identifier of relationship of the corrective action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date when the corrective and preventive action object relationships was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The relationship identifier of the corrective action and preventive action object relationships.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the corrective and preventive action object relationships.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DestinationObjectId":{
            "type":"integer",
            "description":"The destination object identifier of the relationship of the Corrective Action.",
            "nullable":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 : Change Order Relationship Rules

Type: array

Title: Change Order Relationship Rules

The Relationship Rules resource manages rules related to relationships on change orders.

Show Source

• Array of: object qualityCorrectiveAndPreventiveActions-correctiveActionRelationships-relationshipRules-item-response

{
    "title":"Change Order Relationship Rules",
    "type":"array",
    "description":"The Relationship Rules resource manages rules related to relationships on change orders.",
    "items":{
        "$ref":"#/components/schemas/qualityCorrectiveAndPreventiveActions-correctiveActionRelationships-relationshipRules-item-response"
    }
}

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."
        }
    }
}

Nested Schema : qualityCorrectiveAndPreventiveActions-correctiveActionRelationships-relationshipRules-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the relationship rule was created.
• DestinationObjectID: integer (int64)
  Read Only: true

  Destination object ID of the relationship of the change order object.
• DestinationObjectNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the destination object.
• DestinationObjectType: string
  Maximum Length: 30

  Destination object type of the change order object relationship.
• DestinationRuleStatus: string
  Maximum Length: 255

  Destination object workflow status defined in the relationship rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the relationship rule.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the relationship rule was updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelationshipId: integer (int64)
  Relationship ID of the change order object relationship.
• RelationshipRuleId: integer (int64)
  Relationship rule ID of the change order object relationship.
• SourceObjectId: integer (int64)
  Read Only: true

  Source object ID of the relationship of the change order object.
• SourceObjectNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the source object.
• SourceObjectType: string
  Maximum Length: 30

  Source object type of the change order object relationship.
• SourceRuleStatus: string
  Maximum Length: 255

  Source object workflow status defined in the relationship rule.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date when the relationship rule was updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the relationship rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the relationship rule.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DestinationRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Destination object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "RelationshipRuleId":{
            "type":"integer",
            "description":"Relationship rule ID of the change order object relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DestinationObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Destination object type of the change order object relationship.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SourceRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Source object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SourceObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Source object type of the change order object relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"Source object ID of the relationship of the change order object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DestinationObjectNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the destination object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Relationship ID of the change order object relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SourceObjectNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the source object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DestinationObjectID":{
            "type":"integer",
            "description":"Destination object ID of the relationship of the change order object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the relationship rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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"
    }
}

Links

relationshipRules

Operation: /fscmRestApi/resources/11.13.18.05/qualityCorrectiveAndPreventiveActions/{qualityCorrectiveAndPreventiveActionsUniqID}/child/correctiveActionRelationships/{correctiveActionRelationshipsUniqID}/child/relationshipRules

Parameters:

• correctiveActionRelationshipsUniqID: $request.path.correctiveActionRelationshipsUniqID
• qualityCorrectiveAndPreventiveActionsUniqID: $request.path.qualityCorrectiveAndPreventiveActionsUniqID

The Relationship Rules resource manages rules related to relationships on change orders.

Back to Top