POST v1/bunits/{bunitId}/jobs?jobViewId={jobViewId}

Get a list of all jobs related to a business unit (and descendants).
Filter list by using additional parameters

Request Information

URI Parameters

Name	Description	Type	Additional information
`bunitId`		integer	Required
`jobViewId`	Optional parameter for preset filter in job view	integer	Default value is 0

Body Parameters

JobFilter

Name	Description	Type	Additional information
`StartTime`	Earliest completed time If none given current date minus 24 hours is used	date	None.
`IncludeActive`		boolean	None.
`IncludeUnaccessed`		boolean	None.
`IncludeDecommissioned`		boolean	None.
`IncludeNotFound`		boolean	None.
`IncludeScheduled`		boolean	None.
`IncludeUnscheduled`		boolean	None.
`IncludeSupportActive`		boolean	None.
`IncludeSupportResolved`		boolean	None.
`IncludeSupportIgnored`		boolean	None.
`EndTime`	Latest completed time Nullable	date	None.
`IncludeCompleted`	Include jobs with a completed time	boolean	None.
`IncludeUncompleted`	Include jobs with no completed time These should have status Started, In Progress or Expired	boolean	None.
`IncludeDescendants`	If false, only jobs for current business unit will be returned. If true, jobs for all descendants will included	boolean	None.
`JobTypes`	Types of jobs	Collection of JobType	None.
`Statuses`	Statuses of jobs	Collection of JobStatus	None.
`Severities`	Severities of jobs	Collection of JobSeverity	None.
`DataSourceTypes`	Data-source type of jobs	Collection of DataSourceType	None.
`ServerTypes`	Servertypes of jobs	Collection of ServerType	None.
`JobNames`	Names of jobs	Collection of JobName	None.
`Tags`	A list of tags the data-sources must or must not have	Collection of Tag	None.
`ExcludeTags`	True if data-sources with tags should be excluded	boolean	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<JobFilter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>15</Id>
  <CreatedDate>2024-05-20T19:27:21.9975095+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T19:27:21.9975095+02:00</ArchivedDate>
  <StartTime>2024-05-20T19:27:21.9975095+02:00</StartTime>
  <IncludeActive>true</IncludeActive>
  <IncludeUnaccessed>true</IncludeUnaccessed>
  <IncludeDecommissioned>true</IncludeDecommissioned>
  <IncludeNotFound>true</IncludeNotFound>
  <IncludeScheduled>true</IncludeScheduled>
  <IncludeUnscheduled>true</IncludeUnscheduled>
  <IncludeSupportActive>true</IncludeSupportActive>
  <IncludeSupportResolved>true</IncludeSupportResolved>
  <IncludeSupportIgnored>true</IncludeSupportIgnored>
  <EndTime>2024-05-20T19:27:21.9975095+02:00</EndTime>
  <IncludeCompleted>true</IncludeCompleted>
  <IncludeUncompleted>true</IncludeUncompleted>
  <IncludeDescendants>true</IncludeDescendants>
  <JobTypes>
    <JobType>
      <Id>1</Id>
    </JobType>
    <JobType>
      <Id>1</Id>
    </JobType>
  </JobTypes>
  <Statuses>
    <JobStatus>
      <Id>1</Id>
    </JobStatus>
    <JobStatus>
      <Id>1</Id>
    </JobStatus>
  </Statuses>
  <Severities>
    <JobSeverity>NotSet</JobSeverity>
    <JobSeverity>NotSet</JobSeverity>
  </Severities>
  <DataSourceTypes>
    <DataSourceType>
      <Id>1</Id>
    </DataSourceType>
    <DataSourceType>
      <Id>1</Id>
    </DataSourceType>
  </DataSourceTypes>
  <ServerTypes>
    <ServerType>
      <Id>1</Id>
    </ServerType>
    <ServerType>
      <Id>1</Id>
    </ServerType>
  </ServerTypes>
  <JobNames>
    <JobName>
      <Id>2</Id>
      <CreatedDate>2024-05-20T19:27:21.9975095+02:00</CreatedDate>
      <ArchivedDate>2024-05-20T19:27:21.9975095+02:00</ArchivedDate>
      <Name>sample string 1</Name>
    </JobName>
    <JobName>
      <Id>2</Id>
      <CreatedDate>2024-05-20T19:27:21.9975095+02:00</CreatedDate>
      <ArchivedDate>2024-05-20T19:27:21.9975095+02:00</ArchivedDate>
      <Name>sample string 1</Name>
    </JobName>
  </JobNames>
  <Tags>
    <Tag>
      <Id>1</Id>
      <BusinessUnitId>2</BusinessUnitId>
      <Text>sample string 3</Text>
      <Inheritable>true</Inheritable>
      <BusinessUnitCount>5</BusinessUnitCount>
      <ConsumerCount>6</ConsumerCount>
    </Tag>
    <Tag>
      <Id>1</Id>
      <BusinessUnitId>2</BusinessUnitId>
      <Text>sample string 3</Text>
      <Inheritable>true</Inheritable>
      <BusinessUnitCount>5</BusinessUnitCount>
      <ConsumerCount>6</ConsumerCount>
    </Tag>
  </Tags>
  <ExcludeTags>true</ExcludeTags>
</JobFilter>

Response Information

Resource Description

Collection of Job

Name	Description	Type	Additional information
`Type`	Type of job	JobType	None.
`Status`	The status of the job	JobStatus	None.
`Severity`	How severe is the status of the job compared to relevant job severity configuration	JobSeverity	None.
`SupportStatus`	Information on how the job has been handled by support	SupportStatus	None.
`DataSourceType`	The type of data-source	DataSourceType	None.
`DataSource`	Name of the data source the job is related to	DataSource	None.
`DataSourceState`	The state of the data-source when the job was run	DataSourceState	None.
`Scheduled`	Wether or not the job was scheduled	boolean	None.
`ScheduledStart`	The time the job was scheduled to start	date	None.
`ActualStart`	The time the job was actually started	date	None.
`Completed`	The time the job was completed	date	None.
`ExaminedFiles`	Number of examined files	integer	None.
`AffectedFiles`	Number of affected files	integer	None.
`FailedFiles`	Number of failed files	integer	None.
`Result`	Result of job	integer	None.
`TransferredMegaBytes`	Megabytes transferred during job	decimal number	None.
`TransferredGigaBytes`	Gigabytes transferred during job	decimal number	None.
`Consumer`	The Consumer the data source of the job is related to	Consumer	None.
`BusinessUnit`	The business unit the related data source is related to	BusinessUnit	None.
`ServerType`	Type of the backup server that handled the job	ServerType	None.
`JobName`	Name of the job	JobName	None.
`Name`	Name of job The name of the schedule, SLA domain or backup policy depending on server type Can also be Manual job if not scheduled	string	None.
`Duration`	Time span between start and end of job	time interval	None.
`TransferredMegaBytesPerSecond`	Number of megabytes transferred on average per second for the duration of the job	decimal number	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.