Target

Endpoints

Create new target

/companies/{companycode}/targets

Description

Returns created target.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

Target

Responses

HTTP Code Description Schema

201

Successfully created

Target

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Import entity list

/companies/{companycode}/targets/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportTargetList

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

Data structure

Target

Target data structure.

Name Description Value Business Rules

code
required

Target code

string

10 characters max

companyCode
required

Current company code

string

2 characters max

duration
required

Target duration : DAY, WEEK, MONTH or YEAR

string

(DAY, WEEK, MONTH, YEAR)

label
required

Target label

string

50 characters max

quantityRef
optional

Target relative quantityRef

double

targets
required

Target list (scopes and values)

Target list

type
required

Target type : MO, MOD, MOI, MOG or TRS

string

(MO, MOD, MOI, MOG, TRS)

unit
optional

Target unit

string

5 characters max

validityEndDate
optional

Target validity end date

datetime

AAAA-MM-JJTHH:MM:SSZ
Set a passed date to make the entity inactive.

ImportTargetList

Name Value

callback
optional

string

data
optional

Target list