Create an affected object
/fscmRestApi/resources/11.13.18.05/qualityActions/{ActionId}/child/AffectedObjects
Request
-
ActionId(required): integer(int64)
Value that uniquely identifies the quality action.
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
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.
-
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. -
ObjectId: integer
(int64)
Title:
Object
Value that identifies the affected object. -
Status: string
Title:
Relation Status
Maximum Length:30
Status of the affected object. -
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.
Response
- application/json
Default Response
-
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.
object
-
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.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create one affected object in one quality action.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/qualityActions/ActionId/child/AffectedObjects"
For example, the following command creates affected object 300100115930201 in quality action 300100111060019:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/qualityActions/300100111060019/child/AffectedObjects"
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 creates.
{ "Status" : "ORA_OPEN", "SupportedEntityCode" : "ORA_COMPONENT", "ContextId" : 300100111243548, "SubContextId" : 204, "SubContextTwoId" : 300100111257323 }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AffectedObjectId" : 300100115930201, "Description" : null, "ImpactType" : "ORA_PRIMARY", "ObjectId" : 300100111060019, "Status" : "ORA_OPEN", "SupportedEntityId" : 1004, "SupportedEntityCode" : "ORA_COMPONENT", "ContextId" : 300100111243548, "ContextCode" : "ITEM_GSE_2017/08/11 04:52:44.117", "SubContextId" : 204, "SubContextCode" : "V1", "SubContextTwoId" : 300100111257323, "SubContextTwoCode" : "B", "SubContextThreeId" : null, "SubContextFourId" : null, "CreatedBy" : "PRODUCT_MANAGER", "CreationDate" : "2017-09-08T07:56:52+00:00", "LastUpdateDate" : "2017-09-08T07:56:52.034+00:00", "LastUpdatedBy" : "PRODUCT_MANAGER", ... }