Retrieve an ERP process and related parameters
/fscmRestApi/resources/11.13.18.05/erpProcesses
Request
-
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.
- application/json
object
-
OperationName: string
Title:
Operation Name
Operation name of the ERP process. -
ProcessInformation: string
Title:
Process Information
Process information of the ERP process. -
ProcessName: string
Title:
Process Name
Process name of the ERP process. -
ProcessType: string
Title:
Process Type
Process type of the ERP process.
Response
- application/json
Default Response
-
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.
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Operation Name
Operation name of the ERP process. -
ProcessInformation: string
Title:
Process Information
Process information of the ERP process. -
ProcessName: string
Title:
Process Name
Process name of the ERP process. -
ProcessType: string
Title:
Process Type
Process type of the ERP process.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
Example 1: Inbound Processes Operation
The inboundProcesses operation retrieves all the File Based Data Import processes and returns the String (JSON format) containing the process name and interface identifier. The following example shows how to fetch inbound processes by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpprocesses
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "OperationName":"inboundProcesses" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "OperationName": "inboundProcesses", "ProcessName": null, "ProcessInfo": "\"Inbound Processes\": [{\"InterfaceId\":\"9\",\"JobDisplayName\":\"Post Mass Additions\",\"UcmAccount\":\"fin/assets/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/assets/additions;PostMassAdditions\",\"JobDescription\":\"Creates assets from mass addition lines in the Post queue and adds mass addition lines in the Cost Adjustment queue to the existing assets.\"},{\"InterfaceId\":\"10\",\"JobDisplayName\":\"Post Mass Retirements\",\"UcmAccount\":\"fin/assets/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/assets/retirements/massRetirements;PostMassRetirements\",\"JobDescription\":\"Posts mass retirement transactions with a status of Post.\"},{\"InterfaceId\":\"11\",\"JobDisplayName\":\"Post Mass Transfers\",\"UcmAccount\":\"fin/assets/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/assets/tracking/massTransfers;PostMassTransfers\",\"JobDescription\":\"Posts mass transfer transactions with a status of Post.\"},{\"InterfaceId\":\"12\",\"JobDisplayName\":\"Post Mass Fixed Asset Financial Transactions\",\"UcmAccount\":\"fin/assets/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/assets/adjustments/workArea;PostMassFinTransactions\",\"JobDescription\":\"Posts all mass financial transactions in the interface table that are in a status of Post.\"},{\"InterfaceId\":\"112\",\"JobDisplayName\":\"Import Asset Leases\",\"UcmAccount\":\"fin/assets/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/assets/tracking/leases;ImportAssetLeases\",\"JobDescription\":\"Creates asset leases from the data in the lease open interface tables.\"},{\"InterfaceId\":\"80\",\"JobDisplayName\":\"Japanese Depreciable Assets Tax Summary Report\",\"UcmAccount\":\"fin/assets/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/assets/shared;JapaneseDepreciableAssetsTaxSummaryReport\",\"JobDescription\":\"Summarizes asset information by location as of January 1 for the selected calendar year. Calculates the evaluated and theoretical net book value for each asset type, and the decision cost, which is the larger of the two net book values.\"}]", "ProcessType": "Inbound", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/inboundProcesses", "name": "erpProcesses", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/inboundProcesses", "name": "erpProcesses", "kind": "item" } ] }
Example 2: Inbound Process Operation
The inboundProcess operation retrieves the interface identifier details for the input job and returns the String (JSON format) containing the process name and interface identifier. The following example shows how to fetch an inbound process by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpprocesses
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "OperationName":"inboundProcess", "ProcessName":"oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "OperationName": "inboundProcess", "ProcessName": "oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT", "ProcessInfo": "\"Inbound Process\": [{\"InterfaceId\":\"1\",\"JobDisplayName\":\"Import Payables Invoices\",\"UcmAccount\":\"fin/payables/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/payables/invoices/transactions;APXIIMPT\",\"JobDescription\":\"Creates Oracle Fusion Payables invoices from invoice data in the open interface tables.\"}]", "ProcessType": "Inbound", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/inboundProcess", "name": "erpProcesses", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/inboundProcess", "name": "erpProcesses", "kind": "item" } ] }
Example 3: Process Parameters Operation
The processParameters operation retrieves all the parameters corresponding to the given job definition and returns the String (JSON format) containing the parameter details. The following example shows how to fetch parameters for a given job by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpprocesses
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "OperationName":"processParameters", "ProcessName":"oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "OperationName": "processParameters", "ProcessName": "oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT", "ProcessInformation": "\"Parameters\": [{\"name\":\"ATTRIBUTE1\",\"label\":\"ATTRIBUTE1\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE2\",\"label\":\"ATTRIBUTE2\",\"type\":\"java.lang.Long\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"NUMERIC\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE3\",\"label\":\"ATTRIBUTE3\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"N\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE4\",\"label\":\"Accounting Date\",\"type\":\"java.sql.Date\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"DATE\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE5\",\"label\":\"Hold\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE6\",\"label\":\"Hold Reason\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE7\",\"label\":\"ATTRIBUTE7\",\"type\":\"java.lang.Long\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"NUMERIC\",\"required\":\"false\",\"defaultValue\":\"1000\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE8\",\"label\":\"Source\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"true\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE9\",\"label\":\"Import Set\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE10\",\"label\":\"Purge\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE11\",\"label\":\"Summarize Report\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE12\",\"label\":\"Ledger\",\"type\":\"java.math.BigDecimal\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"NUMERIC\",\"required\":\"true\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE13\",\"label\":\"Invoice Group\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE14\",\"label\":\"Number of Parallel Processes\",\"type\":\"java.lang.Integer\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"INTEGER\",\"required\":\"false\",\"defaultValue\":\"1\",\"displayHint\":\"Display\"},{\"name\":\"Ledger\",\"label\":\"Ledger\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"true\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"BUSINESSUNIT\",\"label\":\"Business Unit\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"HOLD\",\"label\":\"Hold\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"SOURCE\",\"label\":\"Source\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"SummarizeReport\",\"label\":\"SummarizeReport\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"Purge\",\"label\":\"Purge\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"}]", "ProcessType": "PlsqlJobType", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/processParameters", "name": "erpProcesses", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/processParameters", "name": "erpProcesses", "kind": "item" } ] }
Example 4: Inbound Process Details Operation
The inboundProcessDetails operation retrieves interface identifier details and the parameters details corresponding to the given job definition and returns the String (JSON format) containing the parameter details. The following example shows how to fetch interface identifier details and parameters for a given inbound process by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpprocesses
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "OperationName":"inboundProcessDetails", "ProcessName":"oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "OperationName": "inboundProcessDetails", "ProcessName": "oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT", "ProcessInfo": "\"Inbound Process\": [{\"InterfaceId\":\"1\",\"JobDisplayName\":\"Import Payables Invoices\",\"UcmAccount\":\"fin/payables/import\",\"ImportJobName\":\"/oracle/apps/ess/financials/payables/invoices/transactions;APXIIMPT\",\"JobDescription\":\"Creates Oracle Fusion Payables invoices from invoice data in the open interface tables.\"}]\"Parameters\": [{\"name\":\"ATTRIBUTE1\",\"label\":\"ATTRIBUTE1\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE2\",\"label\":\"ATTRIBUTE2\",\"type\":\"java.lang.Long\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"NUMERIC\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE3\",\"label\":\"ATTRIBUTE3\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"N\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE4\",\"label\":\"Accounting Date\",\"type\":\"java.sql.Date\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"DATE\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE5\",\"label\":\"Hold\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE6\",\"label\":\"Hold Reason\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE7\",\"label\":\"ATTRIBUTE7\",\"type\":\"java.lang.Long\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"NUMERIC\",\"required\":\"false\",\"defaultValue\":\"1000\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE8\",\"label\":\"Source\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"true\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE9\",\"label\":\"Import Set\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE10\",\"label\":\"Purge\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE11\",\"label\":\"Summarize Report\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE12\",\"label\":\"Ledger\",\"type\":\"java.math.BigDecimal\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"NUMERIC\",\"required\":\"true\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"ATTRIBUTE13\",\"label\":\"Invoice Group\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"ATTRIBUTE14\",\"label\":\"Number of Parallel Processes\",\"type\":\"java.lang.Integer\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"INTEGER\",\"required\":\"false\",\"defaultValue\":\"1\",\"displayHint\":\"Display\"},{\"name\":\"Ledger\",\"label\":\"Ledger\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"true\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"BUSINESSUNIT\",\"label\":\"Business Unit\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Display\"},{\"name\":\"HOLD\",\"label\":\"Hold\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"SOURCE\",\"label\":\"Source\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"SummarizeReport\",\"label\":\"SummarizeReport\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"},{\"name\":\"Purge\",\"label\":\"Purge\",\"type\":\"java.lang.String\",\"columnType\":\"VARCHAR2\",\"sqlType\":\"VARCHAR\",\"required\":\"false\",\"defaultValue\":\"\",\"displayHint\":\"Hide\"}]", "ProcessType": "PlsqlJobType", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/inboundProcessDetails", "name": "erpProcesses", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpProcesses/inboundProcessDetails", "name": "erpProcesses", "kind": "item" } ] }