Criterion

Endpoints

Get entity list

/companies/{companycode}/criteria

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

< Criterion > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Criterion

Criterion data structure.

Name Description Value Business Rules

allowedValues
optional

AllowedValue list

code
required

Criterion code

String

10 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

establishments
optional

format
deprecated

Deprecated

hierarchies
optional

Hierarchy list

imageCode
optional

Image code

String

label
required

Criterion label

String

50 characters max

publicUuid
optional
read-only

String

tags
optional

Tag list

type
required

Criterion type

String

in(INTEGER, DECIMAL, STRING, BOOLEAN, DATE)

unitCode
optional

String

validityEndDate
optional

datetime

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

AllowedValue

Name Description Value Business Rules

code
mandatory

String

10 characters max

label
mandatory

String

50 characters max

imageCode
optional

String

defaultValue
optional

boolean

false by default

Hierarchy

Name Description Value Business Rules

code
mandatory

String

10 characters max

value
mandatory

String

establishmentCode
optional

String

2 characters

Tag

Name Description Value Business Rules

code
mandatory

String

10 characters max

label
mandatory

String

50 characters max

establishmentCode
optional

String

2 characters