Jump to

• Request
• Response
• Examples

Update a cost adjustment detail

patch

/fscmRestApi/resources/11.13.18.05/costAdjustments/{costAdjustmentsUniqID}/child/AdjustmentDetail/{UserAdjustmentId}

Request

Path Parameters

• UserAdjustmentId(required): integer(int64)
  Value that uniquely identifies the adjustment detail. The application generates this value.
• costAdjustmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Cost Adjustments resource and used to uniquely identify an instance of Cost Adjustments. The client should not generate the hash key value. Instead, the client should query on the Cost Adjustments collection resource in order to navigate to a specific instance of Cost Adjustments to get the hash key.

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

• NewCost: number
  Title: New Cost

  New cost of the cost element.
• UserComment: string
  Title: Comments

  Maximum Length: 240

  Optional comment entered by the user for the cost adjustment detail.

{
    "type":"object",
    "properties":{
        "NewCost":{
            "title":"New Cost",
            "type":"number",
            "description":"New cost of the cost element.",
            "nullable":false
        },
        "UserComment":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Optional comment entered by the user for the cost adjustment detail.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : costAdjustments-AdjustmentDetail-item-response

Type: object

Show Source

• AdjustmentHeaderId: integer (int64)
  Title: Adjustment Header ID

  Read Only: true

  Value that uniquely identifies the adjustment against which this adjustment detail is created.
• CostElement: string
  Title: Cost Element

  Maximum Length: 30

  Cost element to use when creating an adjustment detail. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Elements task.
• CostElementId: integer (int64)
  Title: Cost Element ID

  Value that uniquely identifies the cost element.
• ExpensePool: string
  Title: Expense Pool

  Read Only: true

  Maximum Length: 30

  Expense pool to use when creating an adjustment detail. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Expense Pools task.
• ExpensePoolId: integer (int64)
  Title: Expense Pool ID

  Value that uniquely identifies the expense pool.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewCost: number
  Title: New Cost

  New cost of the cost element.
• SourceTransactionCostId: integer (int64)
  Title: Source Transaction Cost ID

  Value that uniquely identifies the transaction cost identifier for which the adjustment detail is created.
• SourceTransactionId: integer (int64)
  Title: Source Transaction ID

  Value that uniquely identifies the transaction for which the adjustment is created.
• UnitCost: number
  Title: Unit Cost

  Unit cost of the cost element.
• UserAdjustmentId: integer (int64)
  Title: User Adjustment ID

  Read Only: true

  Value that uniquely identifies the adjustment detail. The application generates this value.
• UserComment: string
  Title: Comments

  Maximum Length: 240

  Optional comment entered by the user for the cost adjustment detail.
• UserDefinedFlag: boolean
  Title: User Defined

  Maximum Length: 5

  Contains one of the following values: true or false. If true, then adjustment detail is user defined. If false, then adjustment detail is generated from the existing cost elements associated with the item. The attribute does not have a default value.

{
    "type":"object",
    "properties":{
        "SourceTransactionCostId":{
            "title":"Source Transaction Cost ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction cost identifier for which the adjustment detail is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "title":"User Defined",
            "maxLength":5,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then adjustment detail is user defined. If false, then adjustment detail is generated from the existing cost elements associated with the item. The attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "NewCost":{
            "title":"New Cost",
            "type":"number",
            "description":"New cost of the cost element.",
            "nullable":false,
            "x-queryable":true
        },
        "UserAdjustmentId":{
            "title":"User Adjustment ID",
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment detail. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Optional comment entered by the user for the cost adjustment detail.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpensePool":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "description":"Expense pool to use when creating an adjustment detail. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Expense Pools task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitCost":{
            "title":"Unit Cost",
            "type":"number",
            "description":"Unit cost of the cost element.",
            "nullable":true,
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentHeaderId":{
            "title":"Adjustment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the adjustment against which this adjustment detail is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionId":{
            "title":"Source Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction for which the adjustment is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Cost element to use when creating an adjustment detail. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Cost Elements task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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 a cost adjustment detail.

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/costAdjustments/AdjustmentHeaderId/child/AdjustmentDetail/UserAdjustmentId"

For example, the following command updates cost adjustment detail for user adjustment 5067 with adjustment header identifier 4011:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/costAdjustments/4011/child/AdjustmentDetail/5067

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. For details, see the topic named Structuring Post, Patch, Delete, and Other Requests in the Getting Started section of the SCM REST API documentation website:

{
  "NewCost" : 20
}

Example Response Body

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

{
   "AdjustmentHeaderId": 4011,
   "CostElementId": 100000011624025,
   "ExpensePoolId": 0,
   "NewCost": 20,
   "SourceTransactionCostId": null,
   "SourceTransactionId": 333133,
   "UnitCost": 0,
   "UserAdjustmentId": 5067,
   "CostElement": "ZCST-VO-GAS",
   "ExpensePool": null,
   "UserDefinedFlag": true,
   ...
}

Back to Top