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": "2026-06-19T19:21:03.6610143+00:00",
  "endDate": "2026-06-19T19:21:03.6610143+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>2026-06-19T19:21:03.6610143+00:00</EndDate>
  <IncludeDownloaded>true</IncludeDownloaded>
  <IncludeNew>true</IncludeNew>
  <IncludeUpdated>true</IncludeUpdated>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <StartDate>2026-06-19T19:21:03.6610143+00:00</StartDate>
</ApiGetJobsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiJobListReturn

Name	Description	Type	Additional information
ApiResponse		ApiResponse	None.
JobList		Collection of ApiJobList	None.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "ff4d16c1-377d-4325-952e-d043271dde91",
    "responseNote": "sample string 2"
  },
  "jobList": [
    {
      "projectKey": "187538c6-9d6b-4bb1-a1e9-cb71a8b91d79",
      "projectName": "sample string 1",
      "jobKey": "72d6836e-ec09-4fab-9ebe-0ad1d697eb95",
      "jobName": "sample string 3",
      "createdDate": "2026-06-19T19:21:03.6710122+00:00",
      "updatedDate": "2026-06-19T19:21:03.6710122+00:00",
      "productionDate": "2026-06-19T19:21:03.6710122+00:00",
      "installationDate": "2026-06-19T19:21:03.6710122+00:00",
      "activeScenario": true
    },
    {
      "projectKey": "187538c6-9d6b-4bb1-a1e9-cb71a8b91d79",
      "projectName": "sample string 1",
      "jobKey": "72d6836e-ec09-4fab-9ebe-0ad1d697eb95",
      "jobName": "sample string 3",
      "createdDate": "2026-06-19T19:21:03.6710122+00:00",
      "updatedDate": "2026-06-19T19:21:03.6710122+00:00",
      "productionDate": "2026-06-19T19:21:03.6710122+00:00",
      "installationDate": "2026-06-19T19:21:03.6710122+00:00",
      "activeScenario": true
    }
  ]
}

application/xml, text/xml

Sample:

<ApiJobListReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>ff4d16c1-377d-4325-952e-d043271dde91</ReturnKey>
  </ApiResponse>
  <JobList>
    <ApiJobList>
      <ActiveScenario>true</ActiveScenario>
      <CreatedDate>2026-06-19T19:21:03.6710122+00:00</CreatedDate>
      <InstallationDate>2026-06-19T19:21:03.6710122+00:00</InstallationDate>
      <JobKey>72d6836e-ec09-4fab-9ebe-0ad1d697eb95</JobKey>
      <JobName>sample string 3</JobName>
      <ProductionDate>2026-06-19T19:21:03.6710122+00:00</ProductionDate>
      <ProjectKey>187538c6-9d6b-4bb1-a1e9-cb71a8b91d79</ProjectKey>
      <ProjectName>sample string 1</ProjectName>
      <UpdatedDate>2026-06-19T19:21:03.6710122+00:00</UpdatedDate>
    </ApiJobList>
    <ApiJobList>
      <ActiveScenario>true</ActiveScenario>
      <CreatedDate>2026-06-19T19:21:03.6710122+00:00</CreatedDate>
      <InstallationDate>2026-06-19T19:21:03.6710122+00:00</InstallationDate>
      <JobKey>72d6836e-ec09-4fab-9ebe-0ad1d697eb95</JobKey>
      <JobName>sample string 3</JobName>
      <ProductionDate>2026-06-19T19:21:03.6710122+00:00</ProductionDate>
      <ProjectKey>187538c6-9d6b-4bb1-a1e9-cb71a8b91d79</ProjectKey>
      <ProjectName>sample string 1</ProjectName>
      <UpdatedDate>2026-06-19T19:21:03.6710122+00:00</UpdatedDate>
    </ApiJobList>
  </JobList>
</ApiJobListReturn>