Activity suite

Endpoints

Create new activity suite

/companies/{companycode}/establishments/{establishmentcode}/activity-suites

Description

Returns created activity suite.

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

ActivitySuite

Responses

HTTP Code Description Schema

201

Successfully created

ActivitySuite

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/activity-suites

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

< ActivitySuite > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/activity-suites/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

ImportActivitySuiteList

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 activity suite

/companies/{companycode}/establishments/{establishmentcode}/activity-suites/{code}

operation.deprecated

Description

Returns retrieved activity suite.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

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

200

Successful

ActivitySuite

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete activity suite

/companies/{companycode}/establishments/{establishmentcode}/activity-suites/{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

ActivitySuite

Activity suite data structure.

Name Description Value Business Rules

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

< string, list > map

code
required

Activity suite code

string

20 characters max

companyCode
required

Current company code

string

2 characters max

contexts
optional

Contexts

ContextOfUse list

establishmentCode
required

Current establishment code

string

2 characters max

familyCode
required

Family code

string

10 characters max

flowType
required

Flow type

string

IN(PUSH,PULL)

label
required

Activity label

string

50 characters max

publicUuid
optional
read-only

Activity suite public uuid

string

referenceItemCode
required

Reference item code

string

20 characters max

validityEndDate
optional

Validity end date

datetime

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

ImportActivitySuiteList

Name Value

callback
optional

string

data
optional

ActivitySuite list