Production item

Endpoints

Create new production item

/companies/{companycode}/establishments/{establishmentcode}/production-items

Description

Returns created production item.

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

Body

body
required

ProductionItem

Responses

HTTP Code Description Schema

201

Successfully created

ProductionItem

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/production-items

Description

Returns entities.

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

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< ProductionItem > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/production-items/import

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

Body

body
required

ImportProductionItemList

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

Get one production item

/companies/{companycode}/establishments/{establishmentcode}/production-items/{code}

operation.deprecated

Description

Returns retrieved production item.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

20 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

ProductionItem

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete production item

/companies/{companycode}/establishments/{establishmentcode}/production-items/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

20 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

ProductionItem

Production item data structure.

Name Description Value Business Rules

code
required

Item production code

string

20 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

companyCode
required

Current company code

string

2 characters max

depositCode
optional

DepositCode

string

10 characters max

establishmentCode
required

Current establishment code

string

2 characters max

inputItems
optional

Input items

list

label
optional

Item production label (DEPRECATED)

string

50 characters max

launch
required

Launch

string

IN(NONE, PUSH, PULL, PUSH_PULL)

moUnitCode
optional

Manufacturing order unit code

string

5 characters max

normativeShrinkage
optional

Normative shrinkage

double

outputItems
optional

Output items

list

publicUuid
optional
read-only

Production item public uuid

string

validityEndDate
optional

Validity end date (DEPRECATED)

datetime

YYYY-MM-DDTHH:MM:SSZ
Set a passed date to make the entity inactive.

ImportProductionItemList

Name Value

callback
optional

string

data
optional

ProductionItem list