Brein API

BulkProcess

GET

/api/v1/bulk-process

query Parameters

pagenumber
Current page
pageSizenumber
Page size

Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/bulk-process

curl --request GET \
  --url /api/v1/bulk-process

shell

Show example in

Example Responses

No example

json

application/json

POST

/api/v1/bulk-process

Request Body

slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

Responses

BulkProcess created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

POST /api/v1/bulk-process

curl --request POST \
  --url /api/v1/bulk-process \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}
'

shell

Show example in

Request Body Example

{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}

json

Example Responses

No example

json

application/json

GET

/api/v1/bulk-process/{id}

path Parameters

idnumber · min: 1 · required
Id

Responses

BulkProcess detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

GET /api/v1/bulk-process/{id}

curl --request GET \
  --url /api/v1/bulk-process/:id

shell

Show example in

Example Responses

No example

json

application/json

PUT

/api/v1/bulk-process/{id}

path Parameters

idnumber · min: 1 · required
Id

Request Body

slugstring
Slug process
keystring
Key process
entitystring
Entity name
statusstring
Status process
tenantIdstring
Tenant Id

Responses

BulkProcess updated

No data returned

PUT /api/v1/bulk-process/{id}

curl --request PUT \
  --url /api/v1/bulk-process/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}
'

shell

Show example in

Request Body Example

{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}

json

Example Responses

No example

plain

DELETE

/api/v1/bulk-process/{id}

path Parameters

idnumber · min: 1 · required
Id

Responses

BulkProcess deleted

No data returned

DELETE /api/v1/bulk-process/{id}

curl --request DELETE \
  --url /api/v1/bulk-process/:id

shell

Show example in

Example Responses

No example

plain

Administrative Role

Brein API

BulkProcess

GET

/api/v1/bulk-process

query Parameters

pagenumber
Current page
pageSizenumber
Page size

Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/bulk-process

curl --request GET \
  --url /api/v1/bulk-process

shell

Show example in

Example Responses

No example

json

application/json

POST

/api/v1/bulk-process

Request Body

slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

Responses

BulkProcess created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

POST /api/v1/bulk-process

curl --request POST \
  --url /api/v1/bulk-process \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}
'

shell

Show example in

Request Body Example

{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}

json

Example Responses

No example

json

application/json

GET

/api/v1/bulk-process/{id}

path Parameters

idnumber · min: 1 · required
Id

Responses

BulkProcess detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
slugstring · required
Slug process
keystring · required
Key process
entitystring · required
Entity name
statusstring · required
Status process
tenantIdstring · required
Tenant Id

GET /api/v1/bulk-process/{id}

curl --request GET \
  --url /api/v1/bulk-process/:id

shell

Show example in

Example Responses

No example

json

application/json

PUT

/api/v1/bulk-process/{id}

path Parameters

idnumber · min: 1 · required
Id

Request Body

slugstring
Slug process
keystring
Key process
entitystring
Entity name
statusstring
Status process
tenantIdstring
Tenant Id

Responses

BulkProcess updated

No data returned

PUT /api/v1/bulk-process/{id}

curl --request PUT \
  --url /api/v1/bulk-process/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}
'

shell

Show example in

Request Body Example

{
  "slug": "slug",
  "key": "key",
  "entity": "entity",
  "status": "status",
  "tenantId": "tenantId"
}

json

Example Responses

No example

plain

DELETE

/api/v1/bulk-process/{id}

path Parameters

idnumber · min: 1 · required
Id

Responses

BulkProcess deleted

No data returned

DELETE /api/v1/bulk-process/{id}

curl --request DELETE \
  --url /api/v1/bulk-process/:id

shell

Show example in

Example Responses

No example

plain

Administrative Role