POST api/ApiIntegration/SBApiListAllJobs

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
StartDate	date	None.
EndDate	date	None.
IncludeNew	boolean	None.
IncludeUpdated	boolean	None.
IncludeDownloaded	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "startDate": "2025-04-25T12:14:06.6791147+00:00",
  "endDate": "2025-04-25T12:14:06.6791147+00:00",
  "includeNew": true,
  "includeUpdated": true,
  "includeDownloaded": true
}

application/xml, text/xml

Sample:

<ApiGetJobsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <EndDate>2025-04-25T12:14:06.6791147+00:00</EndDate>
  <IncludeDownloaded>true</IncludeDownloaded>
  <IncludeNew>true</IncludeNew>
  <IncludeUpdated>true</IncludeUpdated>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <StartDate>2025-04-25T12:14:06.6791147+00:00</StartDate>
</ApiGetJobsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ApiJobList

Name	Type	Additional information
ProjectUid	globally unique identifier	None.
ProjectName	string	None.
JobUid	globally unique identifier	None.
JobName	string	None.
CreatedDate	date	None.
UpdatedDate	date	None.
ProductionDate	date	None.
InstallationDate	date	None.
ActiveScenario	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "projectUid": "336d7431-baec-45a2-b893-a571cc5fb0ee",
    "projectName": "sample string 1",
    "jobUid": "3e083d29-0044-423a-8f27-0d51e9a7eec3",
    "jobName": "sample string 3",
    "createdDate": "2025-04-25T12:14:06.6791147+00:00",
    "updatedDate": "2025-04-25T12:14:06.6791147+00:00",
    "productionDate": "2025-04-25T12:14:06.6791147+00:00",
    "installationDate": "2025-04-25T12:14:06.6791147+00:00",
    "activeScenario": true
  },
  {
    "projectUid": "336d7431-baec-45a2-b893-a571cc5fb0ee",
    "projectName": "sample string 1",
    "jobUid": "3e083d29-0044-423a-8f27-0d51e9a7eec3",
    "jobName": "sample string 3",
    "createdDate": "2025-04-25T12:14:06.6791147+00:00",
    "updatedDate": "2025-04-25T12:14:06.6791147+00:00",
    "productionDate": "2025-04-25T12:14:06.6791147+00:00",
    "installationDate": "2025-04-25T12:14:06.6791147+00:00",
    "activeScenario": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiJobList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiJobList>
    <ActiveScenario>true</ActiveScenario>
    <CreatedDate>2025-04-25T12:14:06.6791147+00:00</CreatedDate>
    <InstallationDate>2025-04-25T12:14:06.6791147+00:00</InstallationDate>
    <JobName>sample string 3</JobName>
    <JobUid>3e083d29-0044-423a-8f27-0d51e9a7eec3</JobUid>
    <ProductionDate>2025-04-25T12:14:06.6791147+00:00</ProductionDate>
    <ProjectName>sample string 1</ProjectName>
    <ProjectUid>336d7431-baec-45a2-b893-a571cc5fb0ee</ProjectUid>
    <UpdatedDate>2025-04-25T12:14:06.6791147+00:00</UpdatedDate>
  </ApiJobList>
  <ApiJobList>
    <ActiveScenario>true</ActiveScenario>
    <CreatedDate>2025-04-25T12:14:06.6791147+00:00</CreatedDate>
    <InstallationDate>2025-04-25T12:14:06.6791147+00:00</InstallationDate>
    <JobName>sample string 3</JobName>
    <JobUid>3e083d29-0044-423a-8f27-0d51e9a7eec3</JobUid>
    <ProductionDate>2025-04-25T12:14:06.6791147+00:00</ProductionDate>
    <ProjectName>sample string 1</ProjectName>
    <ProjectUid>336d7431-baec-45a2-b893-a571cc5fb0ee</ProjectUid>
    <UpdatedDate>2025-04-25T12:14:06.6791147+00:00</UpdatedDate>
  </ApiJobList>
</ArrayOfApiJobList>