1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Channel Adjustment Types

Get one adjustment type

get

/fscmRestApi/resources/11.13.18.05/channelAdjustmentTypes/{AdjustmentTypeId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : channelAdjustmentTypes-item-response
Type: object
Show Source
  • Maximum Length: 5
    Prefix of the manual adjustment number when creating the manual adjustment. This attribute is not currently used.
  • Channel Adjustment Reasons
    Title: Channel Adjustment Reasons
    The Channel Adjustment Reasons resource manages various types of adjustment reasons related to adjustment types.
  • Maximum Length: 30
    Abbreviation that identifies the channel adjustment type.
  • Read Only: true
    Value that uniquely identifies the channel adjustment type. It is a primary key that the application generates when it creates the adjustment type.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the adjustment type will be enabled for the buy-side flows. If false, then the adjustment type will not be enabled for the buy-side flows. This attribute does not have a default value.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Date when the channel adjustment type becomes inactive.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Maximum Length: 120
    Name of the channel adjustment type.
  • Name of the predefined adjustment type. A list of accepted values is defined in the lookup type ORA_CJM_ADJUSTMENT_TYPE.
  • Maximum Length: 30
    Abbreviation that identifies the predefined adjustment type. A list of accepted values is defined in the lookup type ORA_CJM_ADJUSTMENT_TYPE.
  • Maximum Length: 1000
    Description of the channel adjustment type.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the adjustment type will be enabled for the sell-side flows. If false, then the adjustment type will not be enabled for the sell-side flows. This attribute does not have a default value.
  • Abbreviation that identifies the reference data set to which the channel adjustment type is assigned.
  • Value that uniquely identifies the reference data set to which the channel adjustment type is assigned.
  • Name of the reference data set to which the channel adjustment type is assigned.
  • Date when the channel adjustment type becomes active.
Nested Schema : Channel Adjustment Reasons
Type: array
Title: Channel Adjustment Reasons
The Channel Adjustment Reasons resource manages various types of adjustment reasons related to adjustment types.
Show Source
Nested Schema : channelAdjustmentTypes-adjustmentReasons-item-response
Type: object
Show Source
Links
adjustmentReasons
Parameters:
  • AdjustmentTypeId: $request.path.AdjustmentTypeId
The Channel Adjustment Reasons resource manages various types of adjustment reasons related to adjustment types.
Back to Top

Examples

This example describes how to get one adjustment type.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/AdjustmentTypeId"

For example, the following command gets one adjustment type:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"SetId": 204,
	"SetCode": "Vision Operations 204",
	"SetName": "Vision Operations Set",
	"PredefinedAdjustmentType": "Decrease Earned",
	"PredefinedAdjustmentTypeCode": "DECREASE_EARNED",
	"AdjustmentTypeId": 300100185735164,
	"Name": "Vendor Rejection",
	"Reason": null,
	"AdjustmentNumberPrefix": "VRD",
	"StartDate": null,
	"EndDate": null,
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-02T14:42:39+00:00",
	"LastUpdatedBy": "channel_user",
	"LastUpdateDate": "2020-06-02T14:42:39.214+00:00",
	"AdjustmentTypeCode": "VENDOR_REJECTION",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164",
		"name": "channelAdjustmentTypes",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164",
		"name": "channelAdjustmentTypes",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164/child/adjustmentReasons",
		"name": "adjustmentReasons",
		"kind": "collection"
	}
	]
}
Back to Top