Jump to

• Request
• Response
• Examples

Update an adjustment reason

patch

/fscmRestApi/resources/11.13.18.05/channelAdjustmentTypes/{AdjustmentTypeId}/child/adjustmentReasons/{AdjustmentReasonId}

Request

Path Parameters

• AdjustmentReasonId(required): integer(int64)
  Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.
• AdjustmentTypeId(required): integer(int64)
  Value that uniquely identifies the channel adjustment type. It is a primary key that the application generates when it creates the adjustment type.

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

• AdjustmentReason: string
  Maximum Length: 120

  Name of the adjustment reason.
• AdjustmentReasonId: integer (int64)
  Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.
• AdjustmentTypeId: integer (int64)
  Value that uniquely identifies the adjustment type.
• DefaultFlag: boolean
  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.
• Description: string
  Maximum Length: 1000

  Description of the adjustment reason.
• EnabledFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "AdjustmentTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the adjustment reason.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentReason":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the adjustment reason.",
            "nullable":false
        },
        "AdjustmentReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":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:
  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.

Body ()

Root Schema : channelAdjustmentTypes-adjustmentReasons-item-response

Type: object

Show Source

• AdjustmentReason: string
  Maximum Length: 120

  Name of the adjustment reason.
• AdjustmentReasonId: integer (int64)
  Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.
• AdjustmentTypeId: integer (int64)
  Value that uniquely identifies the adjustment type.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• DefaultFlag: boolean
  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.
• Description: string
  Maximum Length: 1000

  Description of the adjustment reason.
• EnabledFlag: boolean
  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.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login details of user who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the channel adjustment reason.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the adjustment reason.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment reason. It is a primary key that the application generates when it creates the adjustment reason.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the channel adjustment reason.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentReason":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the adjustment reason.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login details of user who most recently updated the record.",
            "nullable":true,
            "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 an adjustment reason.

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/channelAdjustmentTypes/300100185735164//child/adjustmentReasons/300100185735250"

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.

{
	"DefaultFlag": "true"
}

Example Response Body

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

{
	"AdjustmentReasonId": 300100185735250,
	"AdjustmentReason": "Quantity Mismatch",
	"AdjustmentTypeId": 300100185735164,
	"DefaultFlag": true,
	"EnabledFlag": true,
	"Description": "Quantity Mismatch",
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-02T15:37:47+00:00",
	"LastUpdatedBy": "channel_user",
	"LastUpdateDate": "2020-06-02T15:37:47.022+00:00",
	"LastUpdateLogin": "A6B20DCF2794DABDE053368AF00ABE94",
	"ReasonCode": "QUANTITY_MISMATCH",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164/child/adjustmentReasons/300100185735250",
		"name": "adjustmentReasons",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164/child/adjustmentReasons/300100185735250",
		"name": "adjustmentReasons",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/channelAdjustmentTypes/300100185735164",
		"name": "channelAdjustmentTypes",
		"kind": "item"
	}
	]
}

Back to Top