POST v1/bunits/{bunitId}/export

Get various exports from Cloutility

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId ID of the business unit the report should be fetched for integer

Required

Body Parameters

ExportDataFilter
NameDescriptionTypeAdditional information
ExportDataType Name of the export to get. Options are: invoicereceivers, datagrowth, nodelist, serverlist, bco (backup configuration overview)
string

None.

Format The expected return format. Options are: json, csv, xlsx
string

None.

ServerId Some exports are related to backup servers, and a backup server ID can be provided to filter the result
integer

None.

StartDate Some exports are related to a time period. Provide optional start date
date

None.

EndDate Some exports are related to a time period. Provide optional end date
date

None.

DataViewConfigs Contains information about what data should be included in data export
Collection of DataViewConfig

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<ExportDataFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ExportDataType>sample string 1</ExportDataType>
  <Format>sample string 2</Format>
  <ServerId>3</ServerId>
  <StartDate>2024-05-20T17:08:20.0183782+02:00</StartDate>
  <EndDate>2024-05-20T17:08:20.0183782+02:00</EndDate>
  <DataViewConfigs>
    <DataViewConfig>
      <Id>2</Id>
      <CreatedDate>2024-05-20T17:08:20.0183782+02:00</CreatedDate>
      <ArchivedDate>2024-05-20T17:08:20.0183782+02:00</ArchivedDate>
      <Properties>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Properties>
      <SortOrder>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </SortOrder>
      <DataView>
        <Id>2</Id>
        <CreatedDate>2024-05-20T17:08:20.0183782+02:00</CreatedDate>
        <ArchivedDate>2024-05-20T17:08:20.0183782+02:00</ArchivedDate>
        <Name>sample string 1</Name>
        <Type>
          <Id>2</Id>
          <CreatedDate>2024-05-20T17:08:20.0183782+02:00</CreatedDate>
          <ArchivedDate>2024-05-20T17:08:20.0183782+02:00</ArchivedDate>
          <Name>sample string 1</Name>
        </Type>
      </DataView>
      <Inherited>true</Inherited>
    </DataViewConfig>
    <DataViewConfig>
      <Id>2</Id>
      <CreatedDate>2024-05-20T17:08:20.0183782+02:00</CreatedDate>
      <ArchivedDate>2024-05-20T17:08:20.0183782+02:00</ArchivedDate>
      <Properties>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Properties>
      <SortOrder>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </SortOrder>
      <DataView>
        <Id>2</Id>
        <CreatedDate>2024-05-20T17:08:20.0183782+02:00</CreatedDate>
        <ArchivedDate>2024-05-20T17:08:20.0183782+02:00</ArchivedDate>
        <Name>sample string 1</Name>
        <Type>
          <Id>2</Id>
          <CreatedDate>2024-05-20T17:08:20.0183782+02:00</CreatedDate>
          <ArchivedDate>2024-05-20T17:08:20.0183782+02:00</ArchivedDate>
          <Name>sample string 1</Name>
        </Type>
      </DataView>
      <Inherited>true</Inherited>
    </DataViewConfig>
  </DataViewConfigs>
</ExportDataFilter>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version Version

None.

Content HttpContent

None.

StatusCode HttpStatusCode

None.

ReasonPhrase string

None.

Headers Collection of Object

None.

RequestMessage HttpRequestMessage

None.

IsSuccessStatusCode boolean

None.