Resource category

Endpoints

Create new resource category

/companies/{companycode}/resource-categories

Description

Returns created resource category.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

Resource category

2 characters max

Responses

HTTP Code Description Schema

201

Successfully created

Resource category

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/resource-categories

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

< Resource category > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/resource-categories/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportResourceCategoryList

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 resource category

/companies/{companycode}/resource-categories/{code}

operation.deprecated

Description

Returns retrieved resource category.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

Resource category

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete resource category

/companies/{companycode}/resource-categories/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

10 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

Resource category

Resource category data structure.

Name Description Value Business Rules

code
required

Resource category code

string

10 characters max

companyCode
required

Current company code

string

2 characters max

label
required

Resource category label

string

50 characters max

nature
required

Nature

string

IN(MACHINE=Machine,LABOR=Labor,STORAGE=Storage)

publicUuid
optional
read-only

Resource category public uuid

string

validityEndDate
optional

Validity end date

datetime

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

ImportResourceCategoryList

Name Value

callback
optional

string

data
optional

Resource category list