Quality status

Endpoints

Create new quality status

/companies/{companycode}/quality-statuses

Description

Returns created quality status.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

QualityStatus

Responses

HTTP Code Description Schema

201

Successfully created

QualityStatus

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/quality-statuses

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

< QualityStatus > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/quality-statuses/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportQualityStatusList

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

Delete quality status

/companies/{companycode}/quality-statuses/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

5 characters max

Path

companyCode
required

Current context company 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

QualityStatus

QualityStatus data structure.

Name Description Value Business Rules

code
required

QualityStatus code

string

5 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

label
required

QualityStatus label

string

50 characters max

publicUuid
optional
readOnly

QualityStatus public uuid

string

status
required

QualityStatus status

string

with values : “BLOCKED”, “AVAILABLE”, “OUTSIDE_LIMIT”

defaultStatus
optional

QualityStatus default status

boolean

validityEndDate
optional

validityEndDate

datetime

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

ImportQualityStatusList

Name Value

callback
optional

string

data
optional

QualityStatus list