Jump to

• Request
• Response
• Examples

Export Details for Multiple Partner Organizations

post

/rest/v19/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

Body ()

Root Schema : companies-exportRequest

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "fileFormat":{
            "type":"string",
            "description":"File download format.",
            "title":"File Format",
            "enum":[
                "CSV",
                "XML"
            ]
        },
        "scheduledTime":{
            "type":"string",
            "description":"Time to schedule the task.",
            "title":"Scheduled Time"
        },
        "criteria":{
            "$ref":"#/definitions/criteria"
        }
    }
}

Nested Schema : criteria

Type: object

Show Source

• q: string
  Title: Filter Query

  Filter query in mongo format.

{
    "type":"object",
    "properties":{
        "q":{
            "type":"string",
            "description":"Filter query in mongo format.",
            "title":"Filter Query"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Companies Export Task details.

Body ()

Root Schema : Task Details

Type: object

Title: Task Details

Task details.

Show Source

• links: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable
• taskId: integer
  Title: Task Id

  Task id.

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "description":"Task id.",
            "title":"Task Id"
        },
        "links":{
            "$ref":"#/definitions/link"
        }
    },
    "title":"Task Details",
    "description":"Task details."
}

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

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

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 -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/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/v19/tasks/3022163950"
    }
  ]
}

Back to Top