Item planning manufacturing

Endpoints

Create new item planning manufacturing

/companies/{companycode}/item-planning-manufacturings

Description

Returns created item planning manufacturing.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ItemPlanningManufacturing

Responses

HTTP Code Description Schema

201

Successfully created

ItemPlanningManufacturing

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/item-planning-manufacturings

Description

Returns entities.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Item > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/item-planning-manufacturings/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportItemPlanningManufacturingList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

ItemPlanningManufacturing

Item planning manufacturing data structure.

Name Description Value Business Rules

activityCode
optional

Activity code

string

20 characters max
DO NOT SET BOTH activityCode AND activitySuiteCode

activitySuiteCode
optional

Activity suite code

string

20 characters max
DO NOT SET BOTH activityCode AND activitySuiteCode

companyCode
required

Current company code

string

2 characters max

establishmentCode
required

Current establishment code

string

2 characters max

itemCode
required

Item code

string

20 characters max

parameterCode
required

Parameter code

string

(MINIMUM_REPLENISHMENT, MAXIMUM_REPLENISHMENT, MULTIPLE_REPLENISHMENT, REPLENISHMENT_PERIOD, REPLENISHMENT_DELAY, REPLENISHMENT_DAYS)

parameterUnit
required if parameterCode is not REPLENISHMENT_DAYS

Parameter unit

string

Within (DAY, WEEK) if parameterCode = REPLENISHMENT_PERIOD Within (DAY, WEEK, WORKING_DAY) if parameterCode = REPLENISHMENT_DELAY
5 characters max otherwise

parameterValue
optional

Parameter value

string

Within (MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY) if parameterCode = REPLENISHMENT_DAY

replenishmentDays
optional

Replenishment days

< string (MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY) > list

ImportItemPlanningManufacturingList

Name Value

callback
optional

string

data
optional

ItemPlanningManufacturing list

parameters
optional

ItemPlanningManufacturingParameters

ItemPlanningManufacturingParameters

Item planning manufacturing parameters structure.

Even if parameters are optional and empty, its should be send in request
Name Description Value Business Rules

establishmentCode
optional

Establishment code

string

2 characters max

parameterTypes
optional

List of parameter types

list (MINIMUM_REPLENISHMENT, MAXIMUM_REPLENISHMENT, MULTIPLE_REPLENISHMENT, REPLENISHMENT_PERIOD, REPLENISHMENT_DELAY, REPLENISHMENT_DAYS)

Example of JSON that can be send:

{
    "data": [
        {
            "companyCode": "cCode",
            "establishmentCode": "01",
            "itemCode": "itemCode1",
            "parameterCode": "REPLENISHMENT_PERIOD",
            "parameterUnit": "WEEK",
            "parameterValue": "3"
        }
    ],
    "parameters": {
        "establishmentCode" : "01",
        "parameterTypes" : []
    }
}