Jump to

• Request
• Response
• Examples

Update one affected object

patch

/fscmRestApi/resources/11.13.18.05/qualityActions/{ActionId}/child/AffectedObjects/{AffectedObjectId}

Request

Path Parameters

• ActionId(required): integer(int64)
  Value that uniquely identifies the quality action.
• AffectedObjectId(required): integer(int64)
  Value that uniquely identifies the affected object.

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

• ContextCode: string
  Abbreviation that identifies the context of the affected object.
• ImpactType: string
  Title: Impact Type

  Maximum Length: 30

  Type of impact the affected object causes.
• Status: string
  Title: Relation Status

  Maximum Length: 30

  Status of the affected object.
• SubContextCode: string
  Abbreviation that identifies the subcontext of the affected object.
• SubContextTwoCode: string
  Abbreviation that identifies the second subcontext of the affected object.
• SupportedEntityCode: string
  Abbreviation that identifies the type of affected object.
• SupportedEntityName: string
  Name of the supported entity.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Relation Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the affected object.",
            "nullable":false
        },
        "SubContextCode":{
            "type":"string",
            "description":"Abbreviation that identifies the subcontext of the affected object.",
            "nullable":true
        },
        "SupportedEntityName":{
            "type":"string",
            "description":"Name of the supported entity.",
            "nullable":true
        },
        "SubContextTwoCode":{
            "type":"string",
            "description":"Abbreviation that identifies the second subcontext of the affected object.",
            "nullable":true
        },
        "ContextCode":{
            "type":"string",
            "description":"Abbreviation that identifies the context of the affected object.",
            "nullable":true
        },
        "SupportedEntityCode":{
            "type":"string",
            "description":"Abbreviation that identifies the type of affected object.",
            "nullable":true
        },
        "ImpactType":{
            "title":"Impact Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of impact the affected object causes.",
            "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 : qualityActions-AffectedObjects-item-response

Type: object

Show Source

• AffectedObjectId: integer (int64)
  Title: Affected Object

  Value that uniquely identifies the affected object.
• ContextCode: string
  Abbreviation that identifies the context of the affected object.
• ContextId: integer (int64)
  Value that uniquely identifies the context of the affected object.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the affected object.
• CreationDate: string (date-time)
  Read Only: true

  Date when the application added the affected object.
• Description: string
  Title: Description

  Maximum Length: 400

  Description of the affected object.
• ImpactType: string
  Title: Impact Type

  Maximum Length: 30

  Type of impact the affected object causes.
• ImpactTypeName: string
  Read Only: true

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

  Date when the application most recently updated the affected object.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object

  Value that identifies the affected object.
• Status: string
  Title: Relation Status

  Maximum Length: 30

  Status of the affected object.
• StatusName: string
  Read Only: true

  Name of the status.
• SubContextCode: string
  Abbreviation that identifies the subcontext of the affected object.
• SubContextFiveId: string
  Maximum Length: 80

  Value that uniquely identifies the fifth subcontext of the affected object.
• SubContextFourId: integer (int64)
  Value that uniquely identifies the fourth subcontext of the affected object.
• SubContextId: integer (int64)
  Value that uniquely identifies the subcontext of the affected object.
• SubContextSixId: string
  Maximum Length: 80

  Value that uniquely identifies the sixth subcontext of the affected object.
• SubContextThreeId: integer (int64)
  Value that uniquely identifies the third subcontext of the affected object.
• SubContextTwoCode: string
  Abbreviation that identifies the second subcontext of the affected object.
• SubContextTwoId: integer (int64)
  Value that uniquely identifies the second subcontext of the affected object.
• SupportedEntityCode: string
  Abbreviation that identifies the type of affected object.
• SupportedEntityId: integer (int64)
  Value that identifies the type of affected object.
• SupportedEntityName: string
  Name of the supported entity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the application added the affected object.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"Description of the affected object.",
            "nullable":true,
            "x-queryable":true
        },
        "SubContextId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subcontext of the affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubContextFourId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fourth subcontext of the affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImpactType":{
            "title":"Impact Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of impact the affected object causes.",
            "nullable":false,
            "x-queryable":true
        },
        "SubContextFiveId":{
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the fifth subcontext of the affected object.",
            "nullable":true,
            "x-queryable":true
        },
        "SupportedEntityName":{
            "type":"string",
            "description":"Name of the supported entity.",
            "nullable":true,
            "x-queryable":true
        },
        "SubContextTwoCode":{
            "type":"string",
            "description":"Abbreviation that identifies the second subcontext of the affected object.",
            "nullable":true,
            "x-queryable":true
        },
        "SupportedEntityId":{
            "type":"integer",
            "description":"Value that identifies the type of affected object.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "ContextCode":{
            "type":"string",
            "description":"Abbreviation that identifies the context of the affected object.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Relation Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the affected object.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the affected object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AffectedObjectId":{
            "title":"Affected Object",
            "type":"integer",
            "description":"Value that uniquely identifies the affected object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object",
            "type":"integer",
            "description":"Value that identifies the affected object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusName":{
            "type":"string",
            "description":"Name of the status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubContextCode":{
            "type":"string",
            "description":"Abbreviation that identifies the subcontext of the affected object.",
            "nullable":true,
            "x-queryable":true
        },
        "ImpactTypeName":{
            "type":"string",
            "description":"Name of the impact type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubContextTwoId":{
            "type":"integer",
            "description":"Value that uniquely identifies the second subcontext of the affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubContextThreeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the third subcontext of the affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubContextSixId":{
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the sixth subcontext of the affected object.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextId":{
            "type":"integer",
            "description":"Value that uniquely identifies the context of the affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupportedEntityCode":{
            "type":"string",
            "description":"Abbreviation that identifies the type of affected object.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the application most recently updated the affected object.",
            "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 one affected object in one quality action.

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/AffectedObjects/AffectedObjectId"

For example, the following command updates the ImpactType attribute in affected object 300100111228323 in quality action 300100111060019:

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/AffectedObjects/300100111228323

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.

{"ImpactType":"ORA_PRIMARY"}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "AffectedObjectId" : 300100111291528,
  "Description" : null,
  "ImpactType" : "ORA_PRIMARY",
  "ObjectId" : 300100111291525,
  "Status" : "ORA_OPEN",
  "SupportedEntityId" : 1002,
  "SupportedEntityCode" : "ORA_WORK_OPERATION",
  "ContextId" : 300100111285614,
  "ContextCode" : "M1-1103 - 10",
...
}

Back to Top