Update a characteristic group association
patch
/fscmRestApi/resources/11.13.18.05/inspectionCharacteristics/{CharacteristicId}/child/inspectionCharacteristicGroupAssociations/{GroupAssociationId}
Request
Path Parameters
-
CharacteristicId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
GroupAssociationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
CharacteristicId: integer
(int64)
Value that uniquely identifies the associated characteristic.
-
Description: string
Title:
Description
Maximum Length:240
Translatable description of characteristic group. -
GroupAssociationId: integer
(int64)
Value that uniquely identifies the characteristic group association.
-
GroupId: integer
(int64)
Value that uniquely identifies the characteristic group.
-
Name: string
Title:
Name
Maximum Length:80
Translatable name of characteristic group.
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 : inspectionCharacteristics-inspectionCharacteristicGroupAssociations-item-response
Type:
Show Source
object
-
CharacteristicId: integer
(int64)
Value that uniquely identifies the associated characteristic.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the characteristic group association. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the characteristic group association was created. -
Description: string
Title:
Description
Maximum Length:240
Translatable description of characteristic group. -
GroupAssociationId: integer
(int64)
Value that uniquely identifies the characteristic group association.
-
GroupId: integer
(int64)
Value that uniquely identifies the characteristic group.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the characteristic group association was last updated by the user. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who most recently updated the characteristic group association. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:80
Translatable name of characteristic group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CharacteristicGroupRestVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: Name; Target Attribute: Name
- Display Attribute: Name, Description
Examples
This example describes how to update a characteristic group association.
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/inspectionCharacteristics/CharacteristicId/child/inspectionCharacteristicGroupAssociations/GroupAssociationId"
For
example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inspectionCharacteristics/300100642135969/child/inspectionCharacteristicGroupAssociations/300100642135969"
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.
{ "GroupId":300100122347613 }
Example Response Body
The following example includes the contents of the response
body in JSON format:
{ "CharacteristicId": 300100642135969, "GroupAssociationId": 300100643265992, "GroupId": 300100122347613, "CreatedBy": "QUALITY_ENGINEER", "CreationDate": "2022-06-17T07:43:38+00:00", "LastUpdatedBy": "QUALITY_ENGINEER", "LastUpdateDate": "2022-06-17T07:45:54.004+00:00", "Name": "NonValCharGroup", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100642135969/child/inspectionCharacteristicGroupAssociations/300100643265992", "name": "inspectionCharacteristicGroupAssociations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100642135969/child/inspectionCharacteristicGroupAssociations/300100643265992", "name": "inspectionCharacteristicGroupAssociations", "kind": "item" }, { "rel": "parent", "href": "https://server/fscmRestApi/resources/version/inspectionCharacteristics/300100642135969", "name": "inspectionCharacteristics", "kind": "item" } ] }