Job API (v2.0)

Last Updated: 12/01/2020

Getting Started

First make sure your environment is ready to send and receive data within the R+ API framework.

Get Job Status

GET https://yoursite.demanddriventech.com/api/v2/job/status/{jobId}

Get the job status for a given job ID

Path Parameters

Name	Type	Description
jobId	string	Job ID (Example value "123")

200 The job status was retrieved successfully. Possible job status values are:{ "Enqueued", "Awaiting", "Scheduled", "Processing", "Succeeded", "Failed", "Deleted" }

"Processing"

404 Job ID not found

Invoke Simulation Job

POST https://yoursite.demanddriventech.com/api/v2/job/{dataSetId}/apm

Invoke a Simulation job with the provided request parameters and return the job ID. Require the role SimulatorAdmin.

Path Parameters

Name	Type	Description
dataSetId	integer	Data Set ID (Example value 0, the current production data set ID)

Request Body

Name	Type	Description
simulationJobRequest	object	Simulation Job Parameters

200 A simulation job successfully invoked. The job ID was 123.

123

400 Parameter value(s) is invalid or out of range.

401 User has no permission or APM is not enabled.

404 None of the location(s) in the request were found in the system.

Body Parameter simulationJobRequest

Properties

Property	Type	Required	Values
Locations	array	No	An array of location strings. If provided, must contain at least one valid location. If not provided, defaults to null(global, all locations).
StartingDate	date	Yes
WeeksToSimulate	integer	No	13 to 78 (defaults to 52)
ForecastHorizonWeeks	integer	No	1 to 78 (defaults to 12)
DemandPattern	text	No	0 or Sunday 1 or Monday 2 or Tuesday 3 or Wednesday 4 or Thursday 5 or Friday 6 or Saturday null (spread evenly) Defaults to null
AllowDemandOnNonWorkingDays	boolean	No	0 or 1, True or False (defaults to False)
ProjectedInventoryReportCriticalPercentOfRedZone	integer	No	0 to 1000 (defaults to 0)
ProjectedInventoryReportHighPercentOfRedZone	integer	No	0 to 1000 (defaults to 50)
ProjectedInventoryReportMediumPercentOfRedZone	integer	No	0 to 1000 (defaults to 100)
ProjectedInventoryReportHorizonWeeks	integer	No	1 to 78 (defaults to 12)
PromotionReportCriticalPercentOfWeeklyDemand	integer	No	0 to 10000 (defaults to 2000)
PromotionReportHighPercentOfWeeklyDemand	integer	No	0 to 10000 (defaults to 1000)
PromotionReportMediumPercentOfWeeklyDemand	integer	No	0 to 10000 (defaults to 500)
PromotionReportHorizonWeeks	integer	No	1 to 78 (defaults to 12)
DailyUsageReportChangeCriticalPercentOfDailyUsage	integer	No	0 to 1000 (defaults to 500)
DailyUsageReportChangeHighPercentOfDailyUsage	integer	No	0 to 1000 (defaults to 200)
DailyUsageReportChangeMediumPercentOfDailyUsage	integer	No	0 to 1000 (defaults to 150)

Example Values

{
  "Locations": [
    "LOC1","LOC2","LOC3"
  ],
  "StartingDate": "2020-12-01",
  "WeeksToSimulate": 52,
  "ForecastHorizonWeeks": 12,
  "DemandPattern": "Sunday",
  "AllowDemandOnNonWorkingDays": false,
  "ProjectedInventoryReportCriticalPercentOfRedZone": 0,
  "ProjectedInventoryReportHighPercentOfRedZone": 50,
  "ProjectedInventoryReportMediumPercentOfRedZone": 100,
  "ProjectedInventoryReportHorizonWeeks": 12,
  "PromotionReportCriticalPercentOfWeeklyDemand": 2000,
  "PromotionReportHighPercentOfWeeklyDemand": 1000,
  "PromotionReportMediumPercentOfWeeklyDemand": 500,
  "PromotionReportHorizonWeeks": 1,
  "DailyUsageReportChangeCriticalPercentOfDailyUsage": 500,
  "DailyUsageReportChangeHighPercentOfDailyUsage": 200,
  "DailyUsageReportChangeMediumPercentOfDailyUsage": 150
}