Update a credit category
patch
/fscmRestApi/resources/11.13.18.05/creditCategories/{CreditCategoryId}
Request
Path Parameters
-
CreditCategoryId(required): integer(int64)
The unique identifier of the credit category.
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
-
Description: string
Title:
Description
Maximum Length:1000
The credit category description as entered by the user while creating the credit category. -
Name: string
Title:
Name
Maximum Length:160
The name of a user-defined business category used to classify a transaction and credit for compensation purposes.
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 : creditCategories-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the credit category. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the credit category was created. -
CreditCategoryId: integer
(int64)
Read Only:
true
The unique identifier of the credit category. -
Description: string
Title:
Description
Maximum Length:1000
The credit category description as entered by the user while creating the credit category. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the credit category role was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the credit category. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated with the user who last updated the credit category. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:160
The name of a user-defined business category used to classify a transaction and credit for compensation purposes. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit.
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
- BusinessUnitPVO
-
The unique identifier of the business unit.
The following properties are defined on the LOV link relation:- Source Attribute: OrgId; Target Attribute: OrganizationId
- Display Attribute: Name
Examples
The following example shows how to update a credit category by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/creditCategories/300100090305805
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "Description" : "Credit Category for all tablets in the US" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "Name": "Tablets", "OrgId": 204, "Description": "Credit Category for all tablets in the US", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-02T04:31:41-07:00", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "LastUpdateDate": "2017-06-02T04:37:55-07:00", "LastUpdateLogin": "50681DC23D6C61CAE0532DD6F00A717E", "CreditCategoryId": 300100090305805, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/creditCategories/300100090305805", "name": "creditCategories", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/creditCategories/300100090305805", "name": "creditCategories", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/creditCategories/300100090305805/lov/BusinessUnitPVO", "name": "BusinessUnitPVO", "kind": "collection" } ], }