Update a project expenditure batch
patch
/fscmRestApi/resources/11.13.18.05/projectExpenditureBatches/{BatchId}
Request
Path Parameters
-
BatchId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
BatchDescription: string
Title:
Expenditure Batch Description
Maximum Length:250
Description of the project expenditure batch. -
BatchStatus: string
Title:
Status
Maximum Length:80
Identifies the status of the project expenditure batch, for example, Submitted, Rejected, and so on. A list of valid values is defined in the lookup type PJC_TXN_BATCH_STATUS. -
BatchStatusCode: string
Title:
Status Code
Maximum Length:30
Code that identifies the status of the project expenditure batch, for example, SUBMITTED, REJECTED, and so on. A list of valid values is defined in the lookup type PJC_TXN_BATCH_STATUS.
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.
Root Schema : projectExpenditureBatches-item-response
Type:
Show Source
object
-
BatchDescription: string
Title:
Expenditure Batch Description
Maximum Length:250
Description of the project expenditure batch. -
BatchId: integer
(int64)
Read Only:
true
Identifier of the project expenditure batch. -
BatchName: string
Title:
Expenditure Batch
Read Only:true
Maximum Length:200
Name of the project expenditure batch. -
BatchStatus: string
Title:
Status
Maximum Length:80
Identifies the status of the project expenditure batch, for example, Submitted, Rejected, and so on. A list of valid values is defined in the lookup type PJC_TXN_BATCH_STATUS. -
BatchStatusCode: string
Title:
Status Code
Maximum Length:30
Code that identifies the status of the project expenditure batch, for example, SUBMITTED, REJECTED, and so on. A list of valid values is defined in the lookup type PJC_TXN_BATCH_STATUS. -
BusinessUnit: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the expenditure business unit that incurred the unprocessed costs in the project expenditure batch. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Identifier of the expenditure business unit that incurred the unprocessed costs in the project expenditure batch. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
Document: string
Title:
Document
Read Only:true
Maximum Length:240
Name of the document used to capture unprocessed costs in the project expenditure batch. -
DocumentId: integer
(int64)
Title:
Document ID
Read Only:true
Identifier of the document used to capture unprocessed costs in the project expenditure batch. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionSource: string
Title:
Transaction Source
Read Only:true
Maximum Length:240
Identifier of the application in which the expenditure batch was originally created. -
TransactionSourceId: integer
(int64)
Title:
Transaction Source ID
Read Only:true
Name of the application in which the expenditure batch was originally created.
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.
Examples
The following example shows how to update a project expenditure batch by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectExpenditureBatches/300100185238040
Request Body Example
The following shows an example of the request body in JSON format.
{ "BatchStatus": "Submitted" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "BatchId": 300100185238040, "BatchName": "MEB_Projects_2", "BatchDescription": "My batch 1 1 1", "BusinessUnitId": 204, "BusinessUnit": "Vision Operations", "TransactionSourceId": 100010023900191, "TransactionSource": "Oracle Fusion Projects", "DocumentId": 100010023900205, "Document": "Work-in-Progress Expenditure", "BatchStatusCode": "SUBMITTED", "BatchStatus": "Submitted", "CreatedBy": "ABRAHAM.MASON", "CreationDate": "2020-07-22T09:02:10.894+00:00", "LastUpdatedBy": "ABRAHAM.MASON", "LastUpdateDate": "2020-08-31T05:34:24+00:00", "links": [ { "rel": "self", "href": "your_organization:port/fscmRestApi/resources/11.13.18.05/projectExpenditureBatches/300100185238040", "name": "projectExpenditureBatches", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B78" } }, { "rel": "canonical", "href": "your_organization:port/fscmRestApi/resources/11.13.18.05/projectExpenditureBatches/300100185238040", "name": "projectExpenditureBatches", "kind": "item" } ] }