Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "BatchDescription":{
            "title":"Expenditure Batch Description",
            "maxLength":"250",
            "type":"string",
            "description":"Description of the project expenditure batch.",
            "nullable":true
        },
        "BatchStatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "BatchStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : projectExpenditureBatches-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionSource":{
            "title":"Transaction Source",
            "maxLength":"240",
            "type":"string",
            "description":"Identifier of the application in which the expenditure batch was originally created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchId":{
            "type":"integer",
            "description":"Identifier of the project expenditure batch.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Identifier of the expenditure business unit that incurred the unprocessed costs in the project expenditure batch.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"number_edit",
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "description":"Identifier of the document used to capture unprocessed costs in the project expenditure batch.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Document":{
            "title":"Document",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the document used to capture unprocessed costs in the project expenditure batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchDescription":{
            "title":"Expenditure Batch Description",
            "maxLength":"250",
            "type":"string",
            "description":"Description of the project expenditure batch.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchName":{
            "title":"Expenditure Batch",
            "maxLength":"200",
            "type":"string",
            "description":"Name of the project expenditure batch.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expenditure business unit that incurred the unprocessed costs in the project expenditure batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionSourceId":{
            "title":"Transaction Source ID",
            "type":"integer",
            "description":"Name of the application in which the expenditure batch was originally created.",
            "format":"int64",
            "nullable":false,
            "readOnly":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"
            }
        },
        "BatchStatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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

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"
    }
  ]
}

Back to Top