Get job details
/fscmRestApi/resources/11.13.18.05/erpintegrations/{OperationName}
Request
-
OperationName(required): string
The name of the ERP Integration Service operations used to manage inbound and outbound data flows.
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
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.
There's no request body for this operation.
Back to TopResponse
- 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
-
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.
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: DownloadESSJobExecutionDetails Operation
The downloadESSJobExecutionDetails operation downloads the ESS job output and the logs as a zip file.
The following example shows how to download ESS job execution details by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations?finder=ESSJobExecutionDetailsRF;requestId=14557,fileType=ALL
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "OperationName": "downloadESSJobExecutionDetails", "DocumentId": null, "DocumentContent": "UEsDBBQACAgIADdT4VAAAAAAAAAAAAAAAAAJAAAAMTQ1NTcubG9n1VZNbxs3EL3vr5ijXbRaOW4aQEkDuLINbGBHC0mGjgbFnZVYU+SGH0qUX98Z7q5sAY5r9dJWEGSLmiFn3nvzuDdWVHA1LaEwAV0tJEKxaawL8MkuYYpfIvoAxeUIzn59+/ZddvNi/CSGJgZYWPcAl8qhDNbtRnkcnuUXZXkzn5S5Mj4IIzFH73NXV3naN7cxZL+8+nVM6HiN8kGZFagaboWisg2fD39SvcqDl2usosYqe+ZHoR2Kavck6FpphFmUksqvo9Y7mDthfI3OYQW1sxu4G99ms7jcqBBoif7bw3ht3Qhy64TUmIum8QmEWvGZSmifS7vZWHNr+Syf+7WgTbvFXPWAMwXo3heH3y/8zkjm4KsKa3CHxP02zDJo8YCFUIHhsAbGa6UrKJ3lbn6Q2MEIWVYYShTcUzpr7ayx0Sfeg4XQwQA1ITT4G538Z3XVFzZFHzfUqaipGpAJp6bDifhoNAZFAJ4kOfQK4FJPQYQRLCj1U9QwPIOz4Yjf53A3H8Ob4ZshHFPPfI3wXTUJVDrYBNKoh0oE0S4lzpTZCq0qwG8kX091jcrppLyazour2XHNi4qVQY026IJC3wp61qnfAZqtIto3aMJBVKK8T38hiNT/Q86ou1qt8ifZg8fsY9r4af+63ONkxAZhNBpdNIXZWkU87nU2kH6bFRWdp2pFvI0JZWc1XKd6n00I+mkCzU8VZYC5bSi+vKfOsrFtdozFqzZLKB+quY7MY7II+tBKCtZb8gpayJfKENyNFjJNspSR7IeA9GDr/QirvkSXZNJP2sK18/+60oJ9ibP9nB3DT+c3XEMi6IUCiJnOSTlaJ6NL3kyG049jrUVoSabFvUlCEEvy0MG/4MSzL1pXrnOvZ031/J+68XmHIbnx/9Rg2/sziE3D7ur7dulm/WwDyaCoIZDnpWofK01ZtXV9yT33dEXjN5SR6Y1JUZzcBf0R9UOrsIRlGd0KYdIk47btMT0eK5fmC2botiRBOFEDHKSIBS73qxMyozbud1DpDD6CTzj9mYNNykjmHNaCudcalggNn9w9HHBE0xnGo1iFIfd2jhpsZdum1soRhbQBGTsplZvkwNikQajSrcvbCbJIGbVwcGfUFp0XOk03G/CtMGKFyYtP6MHkFDw1Q0MkpLSRFhlU3kSZSm1VFSl1X94h1qklAjwSWYOMeNrZCAbbOhzS/ccO1FbUNvxcf4xOBxbnpz77TYTsDkJ+hmpJT9TxSm21tl+ZYvJy/kP3xZYNjq476Cjv6bj/0H4nZX8m4/94/4H11M1EUX0c0JWa/QVQSwcI1ixg884DAAD6CgAAUEsDBBQACAgIADdT4VAAAAAAAAAAAAAAAAAXAAAAQXBJbnZvaWNlc0ludGVyZmFjZS5jc3bV0U9LwzAYBvC74HcIO3h61+XN/xzrqlLRItYJHivmUOzKbFJEP73p1sEQymDgwef0HB5I8gtKREop5Nc35LL3deu8J6u2DrC8S/P7EnAcKGtpwoBRFAtkC6ohOB9cG1y36WrvyGvVvpMLErreB1BMCo1gmNWaw6rM4AOgfEqLLH3MAKSao+TGSgVp8QL5eu3e6io4iNmfwHHsVA/9oE4EId6TMso0p3OEZGp3Qq6K7PxsK8HtEao4QC4Hsd1D6J5qU/UNCRHJdb5xX5HIcKRguBZsR1QdEnE1Z8oKI6aIRosTiFCgjD/A/ohI8CNEcSDVb6LZYPRcu4Y8JGRZ+U/XNEBuu2Q2SGkuo5SRUmylvv+91A9QSwcIpDhzsBQBAAB4AwAAUEsDBBQACAgIADdT4VAAAAAAAAAAAAAAAAARAAAAQVBURVNULlBST1BFUlRJRVN1isEKwyAQRH8lkKuw9BOkSBHSJBCbpseNWFiQVdxQ6N9X8NpcZh4zLxX0MQDmLBBE4E2M7AmjQMYv7jEIEH8S+QpHQRb0ByUWpefN2vvsKjizONWPj2FQK0l9uymHgs1r+1nacZ3s1XQ37cxTv/4Yl9Y/UEsHCF3b50RzAAAAqQAAAFBLAwQUAAgICAA3U+FQAAAAAAAAAAAAAAAACQAAADE0NTYwLmxvZz2QUWrDMBBE/32KPYCpbDVumv45kQ2FQk3iC2ytdSIqVqm0psntq5KQr4HHzjA7dKFpEXo7jO1+LAwlcYziAkPvPIFxkSYJ8QpqqWrVDsPH+Dkox0mQJ1KUkoqzVfWqadYqLFLs6WfJKfBuIMOX6gF2gYUucqMlzOgTlcCL9yW0m2b3Wm/7Tq+zrPquap7NZlv3umr7zuTzWpegK12AQUGY/7udMAH6SGiv8EXEYMMv+4CW7BMcvt357PgIciKQiJxmijcfSoYuQX7hSFDQfYGObfEHUEsHCKAq5j3UAAAADgEAAFBLAwQUAAgICAA3U+FQAAAAAAAAAAAAAAAACQAAADE0NTYzLmxvZ82c7XOiOhfAv/NXZPZLu3d6LfjWl28IqeUuAgvY3c48MwzF2OVZBAewvf3vb4IvVUlidaXIWMdCOPnlcHJyToAIznf9Lz3xRyi9BTaKkJ8hIEkNqSE2rhoi+BtYaTKaBXmYxAB/fqAR+GcWAQlI4i35dEFTbIqCoCTTtzR8/pWD8+ArkG6umxf4iHh1AczUDyLUAECOIlAUyUCKMpS+oFGDnBjnaRKBuzBCtwCAy5koXcqWpbumdRnGWe7HAbpEWXaZjkeXUrvTbV3KUy1+ScIAZVqco3TsB6gR5JGg+rm/EvRBWcksp8vLXgQAev5oTeBH5RW/vCd/1Mj/zbEUNcwCP11K2k/KaH4ukQQEcI6VmLwCH6tycSD7KgjGbPKEUpAnIMKX8hbIur62L/sdTm+BKMA0TdKMnJu8IlyqIwq9MB4BP039t3kDu22QJq/ZBZj4/4aT2QQkY9DsdEVRBE9vOcqKqxXGM5/YQ3FKnMQIZFMUhOMQjQTLz3+BWUbEFxsu/4JiUtqPBMH1nyIEZMvTjAdTU6CDf7jQvpMVeFGgY+sap8kEoBeUvuE9z2HgY6NBQYI1IGgxtpocJNPCGsMYoPEYBTkYJ7idv8IM5EQ+br5lQUMVXFvWdM3oA2Oo64qpO6UzBaFAjGaTGBj+BIHSZiVZWJwDgI7wt4vSCYBxEAFia/nbFAl/czew/RNsfpU2YaEbT1PLOMvtTrMdt/j1F/67AMA8//IVKPeyLStYoetFBdOCtuxiPXhDQ3MZAg3486PyHHNoK5DNtq+8ZXuN4eCo8uSBOTSO0F7yhb0kyPI0jJ8LYwvmJnMLvoxnsUcM1wuXjsOb5WGUedPfz40UTSOyZ4R7x8SPvOCXn57fbvJ9/bICVmWXrdZjAbtmUc87BvnvApw94u1yMLhU1TOM9ID7j2l7hjzgXOg9kJbyeJf4AHmO5kJPMVU65AE2owxtGxrKI1XoHvIs+XEADfdo8lToKLZmuZpp7NRfsy3ulEe+mCZiQ0vHHvn8dq1WbCH/i88uzgRiHX3bHFpc/7Rf65badx8t6Omm+Q1LLylsD3k67Mu6h/WvuY9MG95DnjJ0XM+Gfc1xiSc1DWLIvc1CfyaPYh57yCtGA8+SbdzcbcxD5Ln3mq0eUx60B84OZ7K/PK67rMBhvtdacpd901QdrCoFag9QZZAdHYhSa4ls2bW4bJWNLXy2vr7rGlaiNZ1Os3TZA+jemypjVNlvCPDmjpLl0Y7YOm4YEvxCwW8vnkXLCISKhlUAfyr60MEXzFsq406X+yeBTEfDzPMoyiPplKbIPR2PIvhKa46yHvzVGO1x+YjZ4dEWX46jRUYLeTjv4UTUNepji+9dA0RDj8ygvX7idb53ar4PO7rz2qyV6e01A/cWHL15i/Ib3XgPKNzr7mWjjx05rq0Iz/6skSt5PL9/dKVt1FrS2UYbq2Y6wPw2+IjDUxTXIV6w8Nr4y1DwAQP/qQfxqqbiEQl906anKZ/W/pLTL6GRzNQcKvdwRyq5B64Nvw+hg/d68yiaGqUeJE+XWeIOkwcHlm4+Qppb3yuT1PEoSvSJrcqA+gmFJVQ0fMl7svGN7LNxJ+hB2d5KvOpELqNhXhsONJcM886QjPqQOo9SDy8djc5c7mAnw1zEDav9sqra0KEnmDUjr6Ot5RiWrZm25j5S7LjeUGeLDyM70HV1uIO6Hi1T0DDw0NCwx/SKS+DKRjGRTqaC7rQ1kuVUWae7E3hoa7iHQ+Ubjtr7rPnzA6YGbSg79Jmf2hRKQVsz2tXeAfnXOQHg1UQlA3Ft0nLpL+YWMcB9Uu5DqTrFr9AotW7MpZaPN2uhau6gatVC1dqgkn+4i3kLzlxiPV1nE434zXvNIiOAbioyc9p+nzlP+edyqhgnoHaNQ0ep7dtouPU4ch8WPdIZ9lh5456t996TW3zUkHXPgd8PlbcKJdYFb0/qH8hnQ8W0VXK/dSvLPf6MNLPWUpZLbfB2Fn50QGatfD5WSl5jZMTmIyOkabueeUfuOLFz6H3uD5k2vpxFl3rESQVFWL3K2OLDGljbY0Eci1FvDe5zR3BQ6HTlRij32/5IHnX+6fi3QSi1lixfMbHVmPrJPq6wyUeAZV0puoGKQ2Psbxat3LxVsAcwzpEKcVht2EXgemi3HfaR57q21huSJwMWc0cVKnQVu5Rr3QxdlocpMecnQEl0GEqo+QkwTToMJcL8BJgWHaZdC0ybDtOpBaZDh+nWAtOlw1zVAnNFh7muBeaaDnNTC8wNw+mJdcBIIoOG44MrpGH4YInjhCukYThhieOFK6RheGGJ44YrpGG4YYnjh+c0EnlQ+tg0DD+8iImptlzn8w7bfBRmqsWfEHOTwkztFyfE3KIwU3vPCTG3KczUPnZCzJ0NZpLRMUaTo2eTW7WWEsnN44xRpWKq5g4qxuhSMVVrBxVjlKmYqr2DijHaVEzVoTymafZknP9z0+qjj8bMWjefRN8qVeloyGSTuEyVjnZMpiaXqdLRjMnU4jJVOloxmdpcpkpHIyZTh8tETcArZ+pymah5eOVMV1wmajpeOdM1l4malVfOdMP3mbTkvHqfKfKhaJ68eii+J6em6tVD8V05NWOvHorvy6mJe/VQfGdOzd+rh+J7c4nmzquH4rtziebPq4fi+3OJ5tCrh+I7dInm0auH4nv0Zi0evcn36NT5qhoTexYfG7154uhNNnrrxNFbbPT2iaO32eidE0fv0NBpU1oVvIRJq3X31ANtZutz4MozW9Ri28HY58CVJ7ioxbaDss+BK89zUYttB2efA1ee7tIGMnlVbPnMztDWQHmbw7U/cruneA1oaJHKPvC68/oGf1rk5QHNNPgtzN6yPJygLPcn0y/r9alej/6cKH1TTMNxZcMtanvwoxkCYQbO7jRj6ODR5WyjKbrZ1zhrUXxMtHzTuRNbUlO+FrtdRW5CsdNSb3rSXVOUe52OeCYoNpw/W7qf6sCh2ivq21dxvCa+a8/s/QMV13uAtsNYQmJP0RK+IqaseotXxHYtyPExme1O5+pMEF6KPWQhp0JdtvnDAVM/9ScIjzkAjyrx83Ktpm6bLDLV5a7udIuraQE7ec1ANgsClGXjWRS9LdZ8auCj4vxonOTLhaBGGAALHpE1vVCxdBW93BMKfAxarIn14x4aIIjI/xl4RSkCYz+MWDWsnzkOUTRanEOebW4IguBM8VBarJcV+PlCE09bK2atb83mzc1Ve75S1nm3WEnrq2Ajf4SPPc3GY6y54tgtkMT2deeK6CzJ/WhroausWLFrulpDi2wio2SK/NEmSItZ8v8oyNeFsmQuFhZbKyoKgj2Lsb6e/Y1V4MTtZeBIKRQT3VJLXS0Wi4ORPyWmRToeePWzeUWieFt8Gs2WoFjDraMbJcQr4T9QSwcInvxvIvcJAAC6TgAAUEsBAhQAFAAICAgAN1PhUNYsYPPOAwAA+goAAAkAAAAAAAAAAAAAAAAAAAAAADE0NTU3LmxvZ1BLAQIUABQACAgIADdT4VCkOHOwFAEAAHgDAAAXAAAAAAAAAAAAAAAAAAUEAABBcEludm9pY2VzSW50ZXJmYWNlLmNzdlBLAQIUABQACAgIADdT4VBd2+dEcwAAAKkAAAARAAAAAAAAAAAAAAAAAF4FAABBUFRFU1QuUFJPUEVSVElFU1BLAQIUABQACAgIADdT4VCgKuY91AAAAA4BAAAJAAAAAAAAAAAAAAAAABAGAAAxNDU2MC5sb2dQSwECFAAUAAgICAA3U+FQnvxvIvcJAAC6TgAACQAAAAAAAAAAAAAAAAAbBwAAMTQ1NjMubG9nUEsFBgAAAAAFAAUAKQEAAEkRAAAAAA==", "FileName": null, "ContentType": null, "FileType": "ALL", "DocumentAccount": null, "Comments": null, "ProcessName": null, "LoadRequestId": null, "JobPackageName": null, "JobDefName": null, "ReqstId": "14557", "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/downloadESSJobExecutionDetails", "name": "erpintegrations", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/downloadESSJobExecutionDetails", "name": "erpintegrations", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations", "name": "erpintegrations", "kind": "collection" } ] }
Example 2: GetEssExecutionDetails Operation
The getEssExecutionDetails operation obtains Job Path, Name, Status and all related child job details for a specified request ID.
The following example shows how to get ESS job execution details by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations?finder=ESSExecutionDetailsRF;requestId=14557
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "OperationName": "getESSExecutionDetails", "DocumentId": null, "DocumentContent": null, "FileName": null, "ContentType": null, "FileType": null, "DocumentAccount": null, "Comments": null, "ProcessName": null, "LoadRequestId": null, "JobPackageName": null, "JobDefName": null, "ReqstId": "14557", "RequestStatus": "{\"JOBS\":{\"JOBNAME\":\"Load Interface File for Import\",\"JOBPATH\":\"/oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader\",\"REQUESTID\":\"14557\",\"STATUS\":\"SUCCEEDED\",\"CHILD\":[{\"JOBNAME\":\"Transfer File\",\"JOBPATH\":\"/oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader\",\"REQUESTID\":\"14560\",\"STATUS\":\"SUCCEEDED\"},{\"JOBNAME\":\"Load File to Interface\",\"JOBPATH\":\"/oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader\",\"REQUESTID\":\"14563\",\"STATUS\":\"SUCCEEDED\"}]}}", "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/getESSExecutionDetails", "name": "erpintegrations", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/getESSExecutionDetails", "name": "erpintegrations", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations", "name": "erpintegrations", "kind": "collection" } ] }
Example 3: GetEssJobStatus Operation
The getEssJobStatus operation obtains the execution status of the submitted ESS job.
The following example shows how to get an ESS job status by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations?finder=ESSJobStatusRF;requestId=14557
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "OperationName": "getESSJobStatus", "DocumentId": null, "DocumentContent": null, "FileName": null, "ContentType": null, "FileType": null, "DocumentAccount": null, "Comments": null, "ProcessName": null, "LoadRequestId": null, "JobPackageName": null, "JobDefName": null, "ReqstId": "14557", "RequestStatus": "SUCCEEDED", "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/getESSJobStatus", "name": "erpintegrations", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/getESSJobStatus", "name": "erpintegrations", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations", "name": "erpintegrations", "kind": "collection" } ] }
Example 4: GetDocumentIdsForFilePrefix Operation
The getDocumentIdsForFilePrefix
operation returns all the
documentId
that match the provided file name prefix and UCM document
account. This excludes documents having a comment that starts with the provided comment. The
operation limits the search to only FAFusionImportExport
security group if
UCM document account is passed and limits the search to only attachment security group if
UCM document account is passed as "%23NULL"
.
The following example shows how to retrieve document IDs for a specified file name prefix by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations?finder=DocumentIdsByFilePrefixRF;filePrefix=GlInterface,docAccount=fin%2FgeneralLedger%2Fimport,comment=NotMyComment
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "OperationName": "getDocumentIdsForFilePrefix", "DocumentId": "233799", "DocumentContent": null, "FileName": "GlDaily", "ContentType": null, "FileType": null, "DocumentAccount": "fin/generalLedger/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/getDocumentIdsForFilePrefix", "name": "erpintegrations", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/getDocumentIdsForFilePrefix", "name": "erpintegrations", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations", "name": "erpintegrations", "kind": "collection" } ] }
Example 5: GetDocumentForDocumentId Operation
The getDocumentForDocumentId
operation returns the document that matches
the provided documentId
.
The following example shows how to retrieve a document that matches the provided document ID by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations?finder=DocumentRF;docId=233799
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "OperationName": "getDocumentForDocumentId", "DocumentId": "233799", "DocumentContent": "VVNELElOUiwyMDE3LzAxLzAxLDIwMTcvMDEvMDEsQ29ycG9yYXRlLDYwLCwgDQpVU0QsRVVSLDIwMTcvMDEvMDEsMjAxNy8wMS8wMSxDb3Jwb3JhdGUsNjAsLCANCg==", "FileName": null, "ContentType": null, "FileType": null, "DocumentAccount": null, "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/getDocumentForDocumentId", "name": "erpintegrations", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations/getDocumentForDocumentId", "name": "erpintegrations", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpintegrations", "name": "erpintegrations", "kind": "collection" } ] }