Jump to

• Request
• Response

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

Body ()

Root Schema : companies-exportRequest

Type: object

Show Source

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

{
    "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

Title: Criteria

Criteria to Filter Users

Show Source

• q: string
  Title: Filter String

  Filter String

{
    "type":"object",
    "properties":{
        "q":{
            "type":"string",
            "description":"Filter String",
            "title":"Filter String"
        }
    },
    "title":"Criteria",
    "description":"Criteria to Filter Users"
}

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: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• taskId: integer
  Title: Task Id

  Task Id

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "description":"Task Id",
            "title":"Task Id"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Task details",
    "description":"Task details"
}

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

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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