Jump to

• Request
• Response
• Examples

Create an inbound or outbound set of data

post

/fscmRestApi/resources/11.13.18.05/erpintegrations

Request

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

• CallbackURL: string
  Title: Callback URL

  The callback URL of the service implemented by a customer to receive the job status of an Enterprise Scheduling Service job upon its completion.
• Comments: string
  Title: Comments

  The action that appends the specified comments to a file.
• ContentType: string
  Title: Content Type

  The type of content within a data file to be processed by the ERP Integration Service.
• DocumentAccount: string
  Title: Document Account

  The account parameter to search for files corresponding to a specified security account.
• DocumentContent: string
  Title: Document Content

  The content of the file in Base64 encoded format.
• DocumentId: string
  Title: Document Identifier

  The unique identifier of a file associated with the row.
• ESSParameters: string
  Title: Parameters

  The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list should be blank when a given parameter is not passed.
• FileName: string
  Title: File Name

  The name of the data file to be processed by the ERP Integration Service.
• FileType: string
  Title: File Type

  The file type that determines the execution details to be downloaded. Specify LOG as the file type to download the log and output file. Specify OUT as the file type to download only the output file. If no file type is specified, both the log files and output files are downloaded.
• JobDefName: string
  Title: Job Definition Name

  The name of the Enterprise Scheduling Service job definition that must be submitted.
• JobName: string
  Title: Job Name

  The job name and job package name separated by a comma.
• JobOptions: string
  Title: Job Options

  A web service operation input parameter. It specifies the inbound bulk data processing variation and the output file type that is generated when the data is processed.
• JobPackageName: string
  Title: Job Package Name

  The name of the Enterprise Scheduling Service job package that must be submitted.
• LoadRequestId: string
  Title: Load Request Identifier

  The unique identifier of the load process that populates data in a product interface table.
• NotificationCode: string
  Title: Notification Code

  The two-digit code that determines the notification type and when the notification should be sent. Currently the bell and email notifications are supported only for loadAndImportData, ImportBulkData, ExportBulkData, and extractAndPurge operations.
• OperationName: string
  Title: Operation Name

  The name of the ERP Integration Service operations used to manage inbound and outbound data flows.
• ParameterList: string
  Title: Parameter List

  The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list must be blank when a given parameter is not passed.
• ProcessName: string
  Title: Process Name

  The name of a particular business application's data import process.
• ReqstId: string
  Title: Request Identifier

  The unique identifier of the submitted Enterprise Scheduling Service job request.
• RequestStatus: string
  Title: Request Status

  The current status of the Enterprise Scheduling Service job.
• StatusCode: string
  Title: Status Code

  The code representing the current status of the Enterprise Scheduling Service job.

{
    "type":"object",
    "properties":{
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"The name of a particular business application's data import process.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "type":"string",
            "description":"The type of content within a data file to be processed by the ERP Integration Service.",
            "nullable":true
        },
        "OperationName":{
            "title":"Operation Name",
            "type":"string",
            "description":"The name of the ERP Integration Service operations used to manage inbound and outbound data flows.",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"The action that appends the specified comments to a file.",
            "nullable":true
        },
        "FileName":{
            "title":"File Name",
            "type":"string",
            "description":"The name of the data file to be processed by the ERP Integration Service.",
            "nullable":true
        },
        "DocumentId":{
            "title":"Document Identifier",
            "type":"string",
            "description":"The unique identifier of a file associated with the row.",
            "nullable":true
        },
        "JobName":{
            "title":"Job Name",
            "type":"string",
            "description":"The job name and job package name separated by a comma.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The code representing the current status of the Enterprise Scheduling Service job.",
            "nullable":true
        },
        "JobDefName":{
            "title":"Job Definition Name",
            "type":"string",
            "description":"The name of the Enterprise Scheduling Service job definition that must be submitted.",
            "nullable":true
        },
        "CallbackURL":{
            "title":"Callback URL",
            "type":"string",
            "description":"The callback URL of the service implemented by a customer to receive the job status of an Enterprise Scheduling Service job upon its completion.",
            "nullable":true
        },
        "NotificationCode":{
            "title":"Notification Code",
            "type":"string",
            "description":"The two-digit code that determines the notification type and when the notification should be sent. Currently the bell and email notifications are supported only for loadAndImportData, ImportBulkData, ExportBulkData, and extractAndPurge operations.",
            "nullable":true
        },
        "FileType":{
            "title":"File Type",
            "type":"string",
            "description":"The file type that determines the execution details to be downloaded. Specify LOG as the file type to download the log and output file. Specify OUT as the file type to download only the output file. If no file type is specified, both the log files and output files are downloaded.",
            "nullable":true
        },
        "JobPackageName":{
            "title":"Job Package Name",
            "type":"string",
            "description":"The name of the Enterprise Scheduling Service job package that must be submitted.",
            "nullable":true
        },
        "DocumentContent":{
            "title":"Document Content",
            "type":"string",
            "description":"The content of the file in Base64 encoded format.",
            "nullable":true
        },
        "DocumentAccount":{
            "title":"Document Account",
            "type":"string",
            "description":"The account parameter to search for files corresponding to a specified security account.",
            "nullable":true
        },
        "LoadRequestId":{
            "title":"Load Request Identifier",
            "type":"string",
            "description":"The unique identifier of the load process that populates data in a product interface table.",
            "nullable":true
        },
        "ESSParameters":{
            "title":"Parameters",
            "type":"string",
            "description":"The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list should be blank when a given parameter is not passed.",
            "nullable":true
        },
        "JobOptions":{
            "title":"Job Options",
            "type":"string",
            "description":"A web service operation input parameter. It specifies the inbound bulk data processing variation and the output file type that is generated when the data is processed.",
            "nullable":true
        },
        "ParameterList":{
            "title":"Parameter List",
            "type":"string",
            "description":"The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list must be blank when a given parameter is not passed.",
            "nullable":true
        },
        "ReqstId":{
            "title":"Request Identifier",
            "type":"string",
            "description":"The unique identifier of the submitted Enterprise Scheduling Service job request.",
            "nullable":true
        },
        "RequestStatus":{
            "title":"Request Status",
            "type":"string",
            "description":"The current status of the Enterprise Scheduling Service job.",
            "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 : erpintegrations-item-response

Type: object

Show Source

• CallbackURL: string
  Title: Callback URL

  The callback URL of the service implemented by a customer to receive the job status of an Enterprise Scheduling Service job upon its completion.
• Comments: string
  Title: Comments

  The action that appends the specified comments to a file.
• ContentType: string
  Title: Content Type

  The type of content within a data file to be processed by the ERP Integration Service.
• DocumentAccount: string
  Title: Document Account

  The account parameter to search for files corresponding to a specified security account.
• DocumentContent: string
  Title: Document Content

  The content of the file in Base64 encoded format.
• DocumentId: string
  Title: Document Identifier

  The unique identifier of a file associated with the row.
• ESSParameters: string
  Title: Parameters

  The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list should be blank when a given parameter is not passed.
• FileName: string
  Title: File Name

  The name of the data file to be processed by the ERP Integration Service.
• FileType: string
  Title: File Type

  The file type that determines the execution details to be downloaded. Specify LOG as the file type to download the log and output file. Specify OUT as the file type to download only the output file. If no file type is specified, both the log files and output files are downloaded.
• JobDefName: string
  Title: Job Definition Name

  The name of the Enterprise Scheduling Service job definition that must be submitted.
• JobName: string
  Title: Job Name

  The job name and job package name separated by a comma.
• JobOptions: string
  Title: Job Options

  A web service operation input parameter. It specifies the inbound bulk data processing variation and the output file type that is generated when the data is processed.
• JobPackageName: string
  Title: Job Package Name

  The name of the Enterprise Scheduling Service job package that must be submitted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadRequestId: string
  Title: Load Request Identifier

  The unique identifier of the load process that populates data in a product interface table.
• NotificationCode: string
  Title: Notification Code

  The two-digit code that determines the notification type and when the notification should be sent. Currently the bell and email notifications are supported only for loadAndImportData, ImportBulkData, ExportBulkData, and extractAndPurge operations.
• OperationName: string
  Title: Operation Name

  The name of the ERP Integration Service operations used to manage inbound and outbound data flows.
• ParameterList: string
  Title: Parameter List

  The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list must be blank when a given parameter is not passed.
• ProcessName: string
  Title: Process Name

  The name of a particular business application's data import process.
• ReqstId: string
  Title: Request Identifier

  The unique identifier of the submitted Enterprise Scheduling Service job request.
• RequestStatus: string
  Title: Request Status

  The current status of the Enterprise Scheduling Service job.
• StatusCode: string
  Title: Status Code

  The code representing the current status of the Enterprise Scheduling Service job.

{
    "type":"object",
    "properties":{
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"The name of a particular business application's data import process.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "type":"string",
            "description":"The type of content within a data file to be processed by the ERP Integration Service.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Operation Name",
            "type":"string",
            "description":"The name of the ERP Integration Service operations used to manage inbound and outbound data flows.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"The action that appends the specified comments to a file.",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "type":"string",
            "description":"The name of the data file to be processed by the ERP Integration Service.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document Identifier",
            "type":"string",
            "description":"The unique identifier of a file associated with the row.",
            "nullable":true,
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "type":"string",
            "description":"The job name and job package name separated by a comma.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The code representing the current status of the Enterprise Scheduling Service job.",
            "nullable":true,
            "x-queryable":true
        },
        "JobDefName":{
            "title":"Job Definition Name",
            "type":"string",
            "description":"The name of the Enterprise Scheduling Service job definition that must be submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "CallbackURL":{
            "title":"Callback URL",
            "type":"string",
            "description":"The callback URL of the service implemented by a customer to receive the job status of an Enterprise Scheduling Service job upon its completion.",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationCode":{
            "title":"Notification Code",
            "type":"string",
            "description":"The two-digit code that determines the notification type and when the notification should be sent. Currently the bell and email notifications are supported only for loadAndImportData, ImportBulkData, ExportBulkData, and extractAndPurge operations.",
            "nullable":true,
            "x-queryable":true
        },
        "FileType":{
            "title":"File Type",
            "type":"string",
            "description":"The file type that determines the execution details to be downloaded. Specify LOG as the file type to download the log and output file. Specify OUT as the file type to download only the output file. If no file type is specified, both the log files and output files are downloaded.",
            "nullable":true,
            "x-queryable":true
        },
        "JobPackageName":{
            "title":"Job Package Name",
            "type":"string",
            "description":"The name of the Enterprise Scheduling Service job package that must be submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentContent":{
            "title":"Document Content",
            "type":"string",
            "description":"The content of the file in Base64 encoded format.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentAccount":{
            "title":"Document Account",
            "type":"string",
            "description":"The account parameter to search for files corresponding to a specified security account.",
            "nullable":true,
            "x-queryable":true
        },
        "LoadRequestId":{
            "title":"Load Request Identifier",
            "type":"string",
            "description":"The unique identifier of the load process that populates data in a product interface table.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSParameters":{
            "title":"Parameters",
            "type":"string",
            "description":"The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list should be blank when a given parameter is not passed.",
            "nullable":true,
            "x-queryable":true
        },
        "JobOptions":{
            "title":"Job Options",
            "type":"string",
            "description":"A web service operation input parameter. It specifies the inbound bulk data processing variation and the output file type that is generated when the data is processed.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterList":{
            "title":"Parameter List",
            "type":"string",
            "description":"The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list must be blank when a given parameter is not passed.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReqstId":{
            "title":"Request Identifier",
            "type":"string",
            "description":"The unique identifier of the submitted Enterprise Scheduling Service job request.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestStatus":{
            "title":"Request Status",
            "type":"string",
            "description":"The current status of the Enterprise Scheduling Service job.",
            "nullable":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

Example 1: ImportBulkData Operation

The importBulkData operation uploads a file to the Oracle Universal Content Management (UCM) server based on the document details specified and submits an ESS job to load and import the uploaded files to an application table.

The following example shows how to import bulk data 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/erpintegrations

Example Request Body

The following example shows the contents of the request body in JSON format:

{
   "OperationName":"importBulkData",
   "DocumentContent":"UEsDBBQAAAAIAHSsJUWkOHOwEwEAAHgDAAAXAAAAQXBJbnZvaWNlc0ludGVyZmFjZS5jc3bV0LFOwzAQBuAdiXewOjBdU5/ts+MxNICCIEKEIjEG4SEijUrsCMHT47ZEqpCyIBj6Tzf8urM/JETOORSXV+x88E3nvGerrgmwvMmK2wrGgraWJwIER7VAseAGgvPBdcH1m77xjj3X3Ss7Y6EffAAtSBmEVFhjJKyqHN4AqoeszLP7HID0HEmmljRk5RMU67V7aergIGa8IHE/x1NxPhwngsBjBBdG8jlCAn+XizI/PdlJSDtNNRZQUnzI90f4SLWph5aFiOR637qPSJRK5JBKo8SeqD4kknoutFWpmiCKa39LhAqJ4vp/IlJymmgskP5JNNsaPTauZXcJW9b+3bUtsOs+mW2ljKQolRKpndTn0Ut9AVBLAwQUAAAACAAze2pIXdvnRHQAAACpAAAAEQAAAEFQVEVTVC5QUk9QRVJUSUVTdYrBCoMwEER/Reg1sPQTQgklYFVoatvjNqSwEDYhK4J/b9CrXmYeMy8V9DEA5iwQROBPjOwJo0DGBX8xCBDPiXyFqSAL+okSi9LDx9rH4Co483Tq0r3aVo0k9W36HApu3r6fpu3G3t5Mc9fOvPX3wLjuvQJQSwECFAAUAAAACAB0rCVFpDhzsBMBAAB4AwAAFwAAAAAAAAAAACAAAAAAAAAAQXBJbnZvaWNlc0ludGVyZmFjZS5jc3ZQSwECFAAUAAAACAAze2pIXdvnRHQAAACpAAAAEQAAAAAAAAAAACAAAABIAQAAQVBURVNULlBST1BFUlRJRVNQSwUGAAAAAAIAAgCEAAAA6wEAAAAA",
   "ContentType":"zip",
   "FileName":"APTEST_0310.zip",
   "DocumentAccount":"fin$/payables$/import$",
   "JobName":"oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT",
   "ParameterList":"#NULL,Vision Operations,#NULL,#NULL,#NULL,#NULL,#NULL,INVOICE GATEWAY,#NULL,#NULL,#NULL,1,#NULL",
   "CallbackURL":"#NULL",
   "NotificationCode":"10",
   "JobOptions":"InterfaceDetails=1,ImportOption=Y ,PurgeOption = Y,ExtractFileType=ALL"
}

Example Response Body

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

{
   "OperationName":"importBulkData",
   "DocumentId":null,
   "DocumentContent":"UEsDBBQAAAAIAHSsJUWkOHOwEwEAAHgDAAAXAAAAQXBJbnZvaWNlc0ludGVyZmFjZS5jc3bV0LFOwzAQBuAdiXewOjBdU5/ts+MxNICCIEKEIjEG4SEijUrsCMHT47ZEqpCyIBj6Tzf8urM/JETOORSXV+x88E3nvGerrgmwvMmK2wrGgraWJwIER7VAseAGgvPBdcH1m77xjj3X3Ss7Y6EffAAtSBmEVFhjJKyqHN4AqoeszLP7HID0HEmmljRk5RMU67V7aergIGa8IHE/x1NxPhwngsBjBBdG8jlCAn+XizI/PdlJSDtNNRZQUnzI90f4SLWph5aFiOR637qPSJRK5JBKo8SeqD4kknoutFWpmiCKa39LhAqJ4vp/IlJymmgskP5JNNsaPTauZXcJW9b+3bUtsOs+mW2ljKQolRKpndTn0Ut9AVBLAwQUAAAACAAze2pIXdvnRHQAAACpAAAAEQAAAEFQVEVTVC5QUk9QRVJUSUVTdYrBCoMwEER/Reg1sPQTQgklYFVoatvjNqSwEDYhK4J/b9CrXmYeMy8V9DEA5iwQROBPjOwJo0DGBX8xCBDPiXyFqSAL+okSi9LDx9rH4Co483Tq0r3aVo0k9W36HApu3r6fpu3G3t5Mc9fOvPX3wLjuvQJQSwECFAAUAAAACAB0rCVFpDhzsBMBAAB4AwAAFwAAAAAAAAAAACAAAAAAAAAAQXBJbnZvaWNlc0ludGVyZmFjZS5jc3ZQSwECFAAUAAAACAAze2pIXdvnRHQAAACpAAAAEQAAAAAAAAAAACAAAABIAQAAQVBURVNULlBST1BFUlRJRVNQSwUGAAAAAAIAAgCEAAAA6wEAAAAA",
   "FileName":"APTEST_0310.zip",
   "ContentType":"zip",
   "FileType":null,
   "DocumentAccount":"fin$/payables$/import$",
   "Comments":null,
   "ProcessName":null,
   "LoadRequestId":null,
   "JobPackageName":null,
   "JobDefName":null,
   "ReqstId":"14258",
   "RequestStatus":null,
   "JobName":"oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT",
   "ParameterList":"#NULL,Vision Operations,#NULL,#NULL,#NULL,#NULL,#NULL,INVOICE GATEWAY,#NULL,#NULL,#NULL,1,#NULL",
   "NotificationCode":"10",
   "CallbackURL":"#NULL",
   "JobOptions":"InterfaceDetails=1,ImportOption=Y ,PurgeOption = Y,ExtractFileType=ALL",
   "StatusCode":null,
   "ESSParameters":null,
   "links":[
      {
         "rel":"self",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/importBulkData",
         "name":"erpintegrations",
         "kind":"item"
      },
      {
         "rel":"canonical",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/importBulkData",
         "name":"erpintegrations",
         "kind":"item"
      }
   ]
}

Example 2: UploadFileToUCM Operation

The uploadFileToUCM operation uploads a file to the UCM server based on the document specified.

The following example shows how to upload a file to UCM 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/erpintegrations

Example Request Body

The following example shows the contents of the request body in JSON format:

{
  "OperationName":"uploadFileToUCM",
  "DocumentContent":"UEsDBBQAAAAIABCInEgIHJSKCgAAAAgAAAAIAAAAdGVzdC50eHRzTEpWCEktLgEAUEsBAh8AFAAAAAgAEIicSAgclIoKAAAACAAAAAgAJAAAAAAAAAAgAAAAAAAAAHRlc3QudHh0CgAgAAAAAAABABgAW4FRYEGh0QEBIE9gQaHRAckeCWBBodEBUEsFBgAAAAABAAEAWgAAADAAAAAAAA==",
  "DocumentAccount":"fin$/payables$/import$",
  "ContentType":"zip",
  "FileName":"Test.zip",
  "DocumentId":null
}

Example Response Body

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

{
  "OperationName": "uploadFileToUCM",
  "DocumentId": "10621",
  "DocumentContent": "UEsDBBQAAAAIABCInEgIHJSKCgAAAAgAAAAIAAAAdGVzdC50eHRzTEpWCEktLgEAUEsBAh8AFAAAAAgAEIicSAgclIoKAAAACAAAAAgAJAAAAAAAAAAgAAAAAAAAAHRlc3QudHh0CgAgAAAAAAABABgAW4FRYEGh0QEBIE9gQaHRAckeCWBBodEBUEsFBgAAAAABAAEAWgAAADAAAAAAAA==",
  "FileName": "Test.zip",
  "ContentType": "zip",
  "FileType": null,
  "DocumentAccount": "fin$/payables$/import$",
  "Comments": null,
  "ProcessName": null,
  "LoadRequestId": null,
  "JobPackageName": null,
  "JobDefName": null,
  "ReqstId": null,
  "RequestStatus": null,
  "JobName": null,
  "ParameterList": null,
  "NotificationCode": null,
  "CallbackURL": null,
  "JobOptions": null,
  "StatusCode": null,
  "ESSParameters": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/uploadFileToUCM",
      "name": "erpintegrations",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/uploadFileToUCM",
      "name": "erpintegrations",
      "kind": "item"
    }
  ]
}

Example 3: SubmitESSJobRequest Operation

The submitESSJobRequest operation submits an ESS job request for the specified job definition and parameters.

The following example shows how to submit an ESS 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/erpintegrations

Example Request Body

The following example shows the contents of the request body in JSON format:

{
  "OperationName":"submitESSJobRequest",
  "JobPackageName":"oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader",
  "JobDefName":"InterfaceLoaderController",
  "ESSParameters":"1,10420,N,N"
}

Example Response Body

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

{
  "OperationName": "submitESSJobRequest",
  "DocumentId": null,
  "DocumentContent": null,
  "FileName": null,
  "ContentType": null,
  "FileType": null,
  "DocumentAccount": null,
  "Comments": null,
  "ProcessName": null,
  "LoadRequestId": null,
  "JobPackageName": "oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader",
  "JobDefName": "InterfaceLoaderController",
  "ReqstId": "14557",
  "RequestStatus": null,
  "JobName": null,
  "ParameterList": null,
  "NotificationCode": null,
  "CallbackURL": null,
  "JobOptions": null,
  "StatusCode": null,
  "ESSParameters": "1,10420,N,N",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/submitESSJobRequest",
      "name": "erpintegrations",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/submitESSJobRequest",
      "name": "erpintegrations",
      "kind": "item"
    }
  ]
}

Example 4: ExportBulkData Operation

The exportBulkData operation submits an ESS job request for the specified job definition and downloads the ESS job output and the logs as a zip file.

The following example shows how to export bulk data 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/erpintegrations

Example Request Body

The following example shows the contents of the request body in JSON format:

{
"OperationName" : "exportBulkData",
"JobName":"oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader,InterfaceLoaderPurge",
"ParameterList":"1,27921,#NULL,#NULL,#NULL,ORA_FBDI,USER,#NULL,#NULL",
"CallbackURL" : "#NULL",
"NotificationCode":"10",
"JobOptions":"ExtractFileType=ALL"
}

Example Response Body

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

{
  "OperationName": "exportBulkData",
  "DocumentId": null,
  "DocumentContent": null,
  "FileName": null,
  "ContentType": null,
  "FileType": null,
  "DocumentAccount": null,
  "Comments": null,
  "ProcessName": null,
  "LoadRequestId": null,
  "JobPackageName": null,
  "JobDefName": null,
  "ReqstId": "27957",
  "RequestStatus": null,
  "JobName": "oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader,InterfaceLoaderPurge",
  "ParameterList": "1,27921,#NULL,#NULL,#NULL,ORA_FBDI,USER,#NULL,#NULL",
  "NotificationCode": "10",
  "CallbackURL": "#NULL",
  "JobOptions": "ExtractFileType=ALL",
  "StatusCode": null,
  "ESSParameters": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/exportBulkData",
      "name": "erpintegrations",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/exportBulkData",
      "name": "erpintegrations",
      "kind": "item"
    }
  ]
}

Example 5: Purge Interface Tables

The following example shows how to delete data in AR interface tables used by FBDI:Upload Customers. The data is deleted by running an ESS 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/erpintegrations

Example Request Body

The following example shows the contents of the request body in JSON format:

{
	"OperationName":"submitESSJobRequest",
	"JobPackageName":"oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader",
	"JobDefName":"InterfaceLoaderPurge",
	"ESSParameters":"59,XXXXX,,,Y,ORA_FBDI"
}

Note:

You can check the ID of Load Interface File for Import (denoted by XXXXX in the Example Request Body) using this SQL:

Select LOAD_REQUEST_ID from AR_UPD_CUSTOMERS where BATCH_ID = &Batch ID -- Set your Batch ID

Example Response Body

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

204 Response
 
No content. The server successfully processed the request, but is not returning any content.

Note:

In this example, data in the following tables are purged:

• AR_UPD_CUSTOMERS
• AR_UPD_BANK_ACCOUNTS
• AR_UPD_CONTACTS
• AR_UPD_REF_ACCOUNTS

Back to Top