Create adjustment types

post

/fscmRestApi/resources/11.13.18.05/channelAdjustmentTypes

Request

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.
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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-post-request
Type: object
Show Source
  • Maximum Length: 120
    Name of the adjustment reason.
  • Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.
  • Value that uniquely identifies the adjustment type.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then set the adjustment reason as the default for the adjustment type. This attribute does not have a default value.
  • Maximum Length: 1000
    Description of the adjustment reason.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the adjustment reason is enabled for the adjustment type. If false, then the adjustment reason is not enabled. This attribute does not have a default value.
  • Maximum Length: 30
    Abbreviation that identifies the channel adjustment reason.
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
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
Back to Top

Examples

This example describes how to create adjustment types.

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.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/channelAdjustmentTypes"

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.

{
	"SetName": "Vision Operations Set",
	"Name": "Vendor Rejection",
	"AdjustmentTypeCode": "VENDOR_REJECTION",
	"PredefinedAdjustmentType": "Decrease Earned",
	"PredefinedAdjustmentTypeCode": "DECREASE_EARNED",
	"AdjustmentNumberPrefix": "VRD"

}

Example Response Body

The following example includes the contents 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