Data Access Forecast version

Endpoints

Get list of forecast versions

/forecast/companies/{companycode}/establishments/{establishmentcode}/data-access/forecast-versions

Description

Returns forecast versions (conditional on the Data Access offer).

Parameters

Type Name Description Schema Business rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Query

planCode
optional

Plan code

string

10 characters max

Query

horizonCode
optional

Horizon code

string

10 characters max

Query

states
optional

Version states

list of string

within (ARC, PRG, PPB, PUB, CAN) :

ARC = Archived
PRG = In progress
PPB = Preparing publishing
PUB = Published
CAN = Canceled

Query

onlyLastVersion
optional

True if only last published version by plan

boolean

Query

onlyForDashboard
optional

True if only versions to use in dashboard

boolean

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< ForecastVersion > array

400

Functionnal error

No Content

403

Not allowed without Data Access offer

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

ForecastVersion

Forecast version data structure for Get.

Name Description Value Business rules

companyCode
optional

Current company code

string

2 characters max

establishmentCode
optional

Current establishment code

string

2 characters max

planCode
required

Plan code

string

10 characters max

horizonCode
optional

Horizon code

string

10 characters max

versionCode
required

Version code

string

10 characters max

versionLabel
optional

Version label

string

30 characters max

startDate
optional

Start date

datetime (ISO-8601)

endDate
optional

End date

datetime (ISO-8601)

state
optional

Version state

string

within (ARC, PRG, PPB, PUB, CAN) :

ARC = Archived
PRG = In progress
PPB = Preparing publishing
PUB = Published
CAN = Canceled

publicationDate
optional

Publication date

datetime (ISO-8601)