Export Details for Multiple Partner Organizations
post
/rest/v16/companies/actions/bulkExport
This endpoint exports details for multiple partner organizations. This operation triggers a task to return a list of partner organizations as a zip file.
Request
Supported Media Types
- application/json
Root Schema : companies-exportRequest
Type:
Show Source
object
-
criteria:
object criteria
-
fileFormat:
string
Title:
File Format
Allowed Values:[ "CSV", "XML" ]
File download format. -
scheduledTime:
string
Title:
Scheduled Time
Time to schedule the task.
Nested Schema : criteria
Type:
Show Source
object
-
q:
string
Title:
Filter Query
Filter query in mongo format.
Response
Supported Media Types
- application/json
Default Response
Companies Export Task details.
Root Schema : Task details
Type:
object
Title:
Task details
Task details
Show Source
-
links:
array Links
Title:
Links
Links to the related objects. -
taskId:
integer
Title:
Task Id
The status log task Id.
Nested Schema : Links
Type:
array
Title:
Links
Links to the related objects.
Show Source
-
Array of:
object Reference Links
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Reference Links
Type:
object
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
href
URL to the related object -
rel:
string
Title:
Link
Link relationship to the current object
Examples
The following example shows how to export details for multiple partner organizations by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/companies/actions/bulkExport
Request Body Sample
{ "fileFormat": "csv", "scheduledTime": "2023-12-11T05:50:00Z", "criteria": { "q": "{'login' :{'$like':'%po%'}}" } }
Response Body Sample
{ "taskId": 3022163950, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v16/tasks/3022163950" } ] }