Export Details for Multiple Partner Organizations
post
/rest/v18/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
Title:
Criteria
Criteria to Filter Users -
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:
object
Title:
Criteria
Criteria to Filter Users
Show Source
-
q:
string
Title:
Filter String
Filter String
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 to the related objects
Title:
Links to the related objects
Links to the related objects -
taskId:
integer
Title:
Task Id
Task Id
Nested Schema : Links to the related objects
Type:
array
Title:
Links to the related objects
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:
URL to the related object
URL to the related object -
rel:
string
Title:
Link Relationship to the current object
Link Relationship to the current object