Operating process

Endpoints

Create new operating process

/companies/{companycode}/establishments/{establishmentcode}/operating-processes

Description

Returns created operating process.

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

OperatingProcess

Responses

HTTP Code Description Schema

201

Successfully created

OperatingProcess

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/operating-processes

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

< OperatingProcess > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/operating-processes/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

ImportOperatingProcessList

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 operating process

/companies/{companycode}/establishments/{establishmentcode}/operating-processes/{code}

operation.deprecated

Description

Returns retrieved operating process.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

20 characters max (15 characters max if ERP compatibility is checked)

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

OperatingProcess

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete operating process

/companies/{companycode}/establishments/{establishmentcode}/operating-processes/{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

OperatingProcess

Operating process data structure.

Name Description Value Business Rules

areaCode
required

Area code

string

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

code
required

Operating process code

string

20 characters max (15 characters max if ERP compatibility is checked)

companyCode
required

Current company code

string

2 characters max

establishmentCode
required

Current establishment code

string

2 characters max

label
required

Operating process label

string

50 characters max (30 characters max if ERP compatibility is checked)

operations
optional
The order send in JSON is the order used in operations list

< string, Operation list > map

publicUuid
optional
read-only

Operation Process public uuid

string

validityEndDate
optional

Validity end date

datetime

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

Operation

Name Description Value Business Rules

code
required

string

20 characters max

details
optional
The order send in JSON is the order used in operation details list

OperationDetail list

label
required

string

50 characters max (30 characters max if ERP compatibility is checked)

efficiency
required

double

3 decimals authorized

quantity
required

Raw quantity

double

schedulingEfficiency

double

Maximum value 200. 3 decimals authorized. Only if ORDO offer subscribed

unitCode
required

string

5 characters max

OperationDetail

Name Value Business Rules

duration
optional

Duration

fixed
required

boolean

fixedExceptLineSpeed
required

double

maxResources
optional

double

3 decimals max

minResources
optional

double

3 decimals max

resourceCategoryCode
required

string

10 characters max

resourceCode
required

string

10 characters max

Duration

Name Value

nano
optional

integer

negative
optional

boolean

seconds
optional

integer

units
optional

TemporalUnit list

zero
optional

boolean

TemporalUnit

Name Value

dateBased
optional

boolean

duration
optional

Duration

durationEstimated
optional

boolean

timeBased
optional

boolean

ImportOperatingProcessList

Name Value

callback
optional

string

data
optional

OperatingProcess list